Homepage
Demos
Overview
Downloads
Dev. Resources
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 9 of file ExploreMachine.h.

Public Member Functions

 ExploreMachine ()
 constructor
 ExploreMachine (const std::string &nm)
 constructor
 ~ExploreMachine ()
 destructor, check if we need to call our teardown
virtual void setup ()
 This is called by DoStart() when you should setup the network of subnodes (if any).
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 &)
 called each time the turn node is activated, sets a new random turn direction and speed

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 12 of file ExploreMachine.h.

ExploreMachine::ExploreMachine const std::string &  nm  )  [inline]
 

constructor

Definition at line 17 of file ExploreMachine.h.

ExploreMachine::~ExploreMachine  )  [inline]
 

destructor, check if we need to call our teardown

Definition at line 22 of file ExploreMachine.h.

ExploreMachine::ExploreMachine const ExploreMachine  )  [private]
 

don't use


Member Function Documentation

void ExploreMachine::DoStart  )  [virtual]
 

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

Reimplemented from StateNode.

Definition at line 41 of file ExploreMachine.cc.

void ExploreMachine::DoStop  )  [virtual]
 

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

Reimplemented from StateNode.

Definition at line 48 of file ExploreMachine.cc.

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

don't use

void ExploreMachine::processEvent const EventBase  )  [virtual]
 

called each time the turn node is activated, sets a new random turn direction and speed

Reimplemented from BehaviorBase.

Definition at line 60 of file ExploreMachine.cc.

void ExploreMachine::setup  )  [virtual]
 

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

Reimplemented from StateNode.

Definition at line 11 of file ExploreMachine.cc.

void ExploreMachine::teardown  )  [virtual]
 

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

Default implementation will take care of the subnodes and their transitions, you only need to worry about any *other* memory which may have been allocated. If none, you may not need implement this function at all.

Reimplemented from StateNode.

Definition at line 53 of file ExploreMachine.cc.

Referenced by ~ExploreMachine().


Member Data Documentation

StateNode* ExploreMachine::start [protected]
 

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

Definition at line 36 of file ExploreMachine.h.

Referenced by DoStart(), and setup().

class WalkNode* ExploreMachine::turn [protected]
 

walk node to use when turning

Definition at line 37 of file ExploreMachine.h.

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

MotionManager::MC_ID ExploreMachine::walkid [protected]
 

we want to share a walk between turning and walking nodes

Definition at line 38 of file ExploreMachine.h.

Referenced by setup(), and teardown().


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

Tekkotsu v2.4.1
Generated Tue Aug 16 16:35:01 2005 by Doxygen 1.4.4