OutputNode Class Reference
A very simple StateNode that outputs its name to a given ostream upon activation, handy for debugging. More...
#include <OutputNode.h>
Detailed Description
A very simple StateNode that outputs its name to a given ostream upon activation, handy for debugging.
The Event Logger controller item (Status Reports menu) is a much better tool for debugging
Definition at line 12 of file OutputNode.h.
Public Member Functions | |
| OutputNode (const std::string &nm, std::ostream &output) | |
| constructor, sets name and ostream to use for output | |
| OutputNode (const std::string &nm, std::ostream &output, StateNode *nextstate) | |
| constructor, sets name and another state which will immediately be transitioned to upon activation | |
| OutputNode (const std::string &nm, const std::string &mg, std::ostream &output, StateNode *nextstate=NULL) | |
| constructor, sets name, message, and another state which will immediately be transitioned to upon activation | |
| virtual void | postStart () |
| outputs this state's name, will transition to next if non-NULL | |
Protected Attributes | |
| StateNode * | next |
| the state to transition to upon entering, can be NULL | |
| std::ostream & | out |
| the stream to use for output - if not specified (default constructor) cout will be used | |
| std::string | msg |
| message to show on activation | |
Private Member Functions | |
| OutputNode (const OutputNode &node) | |
| don't call this | |
| OutputNode | operator= (const OutputNode &node) |
| don't call this | |
Constructor & Destructor Documentation
| OutputNode::OutputNode | ( | const std::string & | nm, | |
| std::ostream & | output | |||
| ) |
constructor, sets name and ostream to use for output
Definition at line 15 of file OutputNode.h.
| OutputNode::OutputNode | ( | const std::string & | nm, | |
| std::ostream & | output, | |||
| StateNode * | nextstate | |||
| ) |
constructor, sets name and another state which will immediately be transitioned to upon activation
Definition at line 18 of file OutputNode.h.
| OutputNode::OutputNode | ( | const std::string & | nm, | |
| const std::string & | mg, | |||
| std::ostream & | output, | |||
| StateNode * | nextstate = NULL | |||
| ) |
constructor, sets name, message, and another state which will immediately be transitioned to upon activation
Definition at line 20 of file OutputNode.h.
| OutputNode::OutputNode | ( | const OutputNode & | node | ) | [private] |
don't call this
Member Function Documentation
| OutputNode OutputNode::operator= | ( | const OutputNode & | node | ) | [private] |
don't call this
| virtual void OutputNode::postStart | ( | ) | [virtual] |
outputs this state's name, will transition to next if non-NULL
if next is NULL, the state will simply stay active until some other transition causes it to leave
Reimplemented from BehaviorBase.
Definition at line 24 of file OutputNode.h.
Member Data Documentation
std::string OutputNode::msg [protected] |
message to show on activation
Definition at line 36 of file OutputNode.h.
Referenced by postStart().
StateNode* OutputNode::next [protected] |
the state to transition to upon entering, can be NULL
Definition at line 34 of file OutputNode.h.
Referenced by postStart().
std::ostream& OutputNode::out [protected] |
the stream to use for output - if not specified (default constructor) cout will be used
Definition at line 35 of file OutputNode.h.
Referenced by postStart().
The documentation for this class was generated from the following file:
