Homepage Demos Overview Downloads Tutorials Reference
Credits

ExploreMachine Class Reference

#include <ExploreMachine.h>

Inheritance diagram for ExploreMachine:

Inheritance graph
[legend]
List of all members.

Detailed Description

A state machine for exploring an environment (or searching for an object).

Definition at line 15 of file ExploreMachine.h.

Public Member Functions

 ExploreMachine ()
 constructor
 ExploreMachine (const std::string &nm, StateNode *p=NULL)
 constructor
virtual void setup ()
 This is called by DoStart() when you should setup the network of subnodes.
virtual void DoStart ()
 Transitions should call this when you are entering the state, so it can enable its transitions.
virtual void DoStop ()
 Transitions should call this when you are leaving the state, so it can disable its transitions.
virtual void teardown ()
 This is called by DoStop() when you should destruct subnodes.
virtual void processEvent (const EventBase &)
 By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Protected Attributes

StateNodestart
 the node to begin within on DoStart() (turn)
WalkNodeturn
 walk node to use when turning
MotionManager::MC_ID walkid
 we want to share a walk between turning and walking nodes

Private Member Functions

 ExploreMachine (const ExploreMachine &)
 don't use
ExploreMachine operator= (const ExploreMachine &)
 don't use


Constructor & Destructor Documentation

ExploreMachine::ExploreMachine  )  [inline]
 

constructor

Definition at line 18 of file ExploreMachine.h.

ExploreMachine::ExploreMachine const std::string &  nm,
StateNode p = NULL
[inline]
 

constructor

Definition at line 25 of file ExploreMachine.h.

ExploreMachine::ExploreMachine const ExploreMachine  )  [private]
 

don't use


Member Function Documentation

virtual void ExploreMachine::DoStart  )  [inline, virtual]
 

Transitions should call this when you are entering the state, so it can enable its transitions.

Reimplemented from StateNode.

Definition at line 61 of file ExploreMachine.h.

virtual void ExploreMachine::DoStop  )  [inline, virtual]
 

Transitions should call this when you are leaving the state, so it can disable its transitions.

Reimplemented from StateNode.

Definition at line 68 of file ExploreMachine.h.

ExploreMachine ExploreMachine::operator= const ExploreMachine  )  [private]
 

don't use

virtual void ExploreMachine::processEvent const EventBase  )  [inline, virtual]
 

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.

Definition at line 80 of file ExploreMachine.h.

virtual void ExploreMachine::setup  )  [inline, virtual]
 

This is called by DoStart() when you should setup the network of subnodes.

Reimplemented from StateNode.

Definition at line 31 of file ExploreMachine.h.

virtual void ExploreMachine::teardown  )  [inline, virtual]
 

This is called by DoStop() when you should destruct subnodes.

Reimplemented from StateNode.

Definition at line 73 of file ExploreMachine.h.


Member Data Documentation

StateNode* ExploreMachine::start [protected]
 

the node to begin within on DoStart() (turn)

Definition at line 91 of file ExploreMachine.h.

Referenced by DoStart(), ExploreMachine(), and setup().

WalkNode* ExploreMachine::turn [protected]
 

walk node to use when turning

Definition at line 92 of file ExploreMachine.h.

Referenced by DoStart(), ExploreMachine(), processEvent(), and setup().

MotionManager::MC_ID ExploreMachine::walkid [protected]
 

we want to share a walk between turning and walking nodes

Definition at line 93 of file ExploreMachine.h.

Referenced by ExploreMachine(), setup(), and teardown().


The documentation for this class was generated from the following file:

Tekkotsu v2.2.1
Generated Tue Nov 23 16:37:45 2004 by Doxygen 1.3.9.1