Homepage Demos Overview Downloads Tutorials Reference
Credits

OutputNode Class Reference

#include <OutputNode.h>

Inheritance diagram for OutputNode:

Inheritance graph
[legend]
List of all members.

Detailed Description

A very simple StateNode that outputs its name to a given ostream upon activation, handy for debugging.

Definition at line 10 of file OutputNode.h.

Public Member Functions

 OutputNode ()
 constructor, uses cout for output

 OutputNode (const char *nm, StateNode *par, ostream &output)
 constructor, sets name and ostream to use for output

 OutputNode (const char *nm, StateNode *par, 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, StateNode *par, 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

StateNodenext
 the state to transition to upon entering, can be NULL

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  )  [inline]
 

constructor, uses cout for output

Definition at line 13 of file OutputNode.h.

OutputNode::OutputNode const char *  nm,
StateNode par,
ostream &  output
[inline]
 

constructor, sets name and ostream to use for output

Definition at line 15 of file OutputNode.h.

OutputNode::OutputNode const char *  nm,
StateNode par,
ostream &  output,
StateNode nextstate
[inline]
 

constructor, sets name and another state which will immediately be transitioned to upon activation

Definition at line 17 of file OutputNode.h.

OutputNode::OutputNode const char *  nm,
const std::string &  mg,
StateNode par,
ostream &  output,
StateNode nextstate
[inline]
 

constructor, sets name, message, and another state which will immediately be transitioned to upon activation

Definition at line 19 of file OutputNode.h.

OutputNode::OutputNode const OutputNode node  )  [private]
 

don't call this


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 23 of file OutputNode.h.

OutputNode OutputNode::operator= const OutputNode node  )  [private]
 

don't call this


Member Data Documentation

std::string OutputNode::msg [protected]
 

message to show on activation

Definition at line 35 of file OutputNode.h.

Referenced by DoStart(), and OutputNode().

StateNode* OutputNode::next [protected]
 

the state to transition to upon entering, can be NULL

Definition at line 33 of file OutputNode.h.

Referenced by DoStart(), and OutputNode().

ostream& OutputNode::out [protected]
 

the stream to use for output - if not specified (default constructor) cout will be used

Definition at line 34 of file OutputNode.h.

Referenced by DoStart(), and OutputNode().


The documentation for this class was generated from the following file:
Tekkotsu v2.0
Generated Wed Jan 21 03:23:19 2004 by Doxygen 1.3.4