OutputNode Class Reference#include <OutputNode.h>
Inheritance diagram for OutputNode:
[legend]List of all members.
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 11 of file OutputNode.h.
|
Public Member Functions |
| OutputNode (const char *nm, std::ostream &output) |
| constructor, sets name and ostream to use for output
|
| OutputNode (const char *nm, std::ostream &output, StateNode *nextstate) |
| constructor, sets name and another state which will immediately be transitioned to upon activation
|
| OutputNode (const char *nm, const std::string &mg, std::ostream &output, StateNode *nextstate) |
| constructor, sets name, message, and another state which will immediately be transitioned to upon activation
|
virtual void | DoStart () |
| 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 char * |
nm, |
|
|
std::ostream & |
output |
|
) |
[inline] |
|
|
constructor, sets name and ostream to use for output
Definition at line 14 of file OutputNode.h. |
OutputNode::OutputNode |
( |
const char * |
nm, |
|
|
std::ostream & |
output, |
|
|
StateNode * |
nextstate |
|
) |
[inline] |
|
|
constructor, sets name and another state which will immediately be transitioned to upon activation
Definition at line 16 of file OutputNode.h. |
OutputNode::OutputNode |
( |
const char * |
nm, |
|
|
const std::string & |
mg, |
|
|
std::ostream & |
output, |
|
|
StateNode * |
nextstate |
|
) |
[inline] |
|
|
constructor, sets name, message, and another state which will immediately be transitioned to upon activation
Definition at line 18 of file OutputNode.h. |
OutputNode::OutputNode |
( |
const OutputNode & |
node |
) |
[private] |
|
Member Function Documentation
virtual void OutputNode::DoStart |
( |
|
) |
[inline, 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 StateNode.
Definition at line 22 of file OutputNode.h. |
Member Data Documentation
|
the state to transition to upon entering, can be NULL
Definition at line 32 of file OutputNode.h.
Referenced by DoStart(). |
|
the stream to use for output - if not specified (default constructor) cout will be used
Definition at line 33 of file OutputNode.h.
Referenced by DoStart(). |
The documentation for this class was generated from the following file:
|