Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

WaypointEngineNode< W, mcName, mcDesc > Class Template Reference

A StateNode for doing a waypoint walk, use the template parameter to specify a custom walk MC, or use the WaypointWalkNode typedef to accept the "default" walk. More...

#include <WaypointWalkNode.h>

Inheritance diagram for WaypointEngineNode< W, mcName, mcDesc >:

Detailed Description

template<typename W, const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
class WaypointEngineNode< W, mcName, mcDesc >

A StateNode for doing a waypoint walk, use the template parameter to specify a custom walk MC, or use the WaypointWalkNode typedef to accept the "default" walk.

Definition at line 23 of file WaypointWalkNode.h.

List of all members.

Public Member Functions

 WaypointEngineNode ()
 constructor
 WaypointEngineNode (const std::string &name)
 constructor
 ~WaypointEngineNode ()
 destructor
virtual void postStart ()
 Adds a listener and then starts the motion command.
virtual void stop ()
 Removes the motion command from the motion manager if it was our own creation.

Protected Member Functions

 WaypointEngineNode (const std::string &className, const std::string &instanceName)
 constructor
void doEvent ()
 Assumes the event is a completion event from the motion, throws a corresponding state node completion event.

Constructor & Destructor Documentation

template<typename W , const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
WaypointEngineNode< W, mcName, mcDesc >::WaypointEngineNode (  ) 

constructor

Definition at line 27 of file WaypointWalkNode.h.

template<typename W , const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
WaypointEngineNode< W, mcName, mcDesc >::WaypointEngineNode ( const std::string &  name  ) 

constructor

Definition at line 30 of file WaypointWalkNode.h.

template<typename W , const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
WaypointEngineNode< W, mcName, mcDesc >::~WaypointEngineNode (  ) 

destructor

Definition at line 33 of file WaypointWalkNode.h.

template<typename W , const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
WaypointEngineNode< W, mcName, mcDesc >::WaypointEngineNode ( const std::string &  className,
const std::string &  instanceName 
) [protected]

constructor

Definition at line 63 of file WaypointWalkNode.h.


Member Function Documentation

template<typename W , const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
void WaypointEngineNode< W, mcName, mcDesc >::doEvent (  )  [protected, virtual]

Assumes the event is a completion event from the motion, throws a corresponding state node completion event.

Reimplemented from MCNodeBase.

Definition at line 66 of file WaypointWalkNode.h.

template<typename W , const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
virtual void WaypointEngineNode< W, mcName, mcDesc >::postStart (  )  [virtual]

Adds a listener and then starts the motion command.

Reimplemented from MCNode< W, mcName, mcDesc >.

Definition at line 35 of file WaypointWalkNode.h.

template<typename W , const char * mcName = defWaypointWalkNodeName, const char * mcDesc = defWaypointWalkNodeDesc>
virtual void WaypointEngineNode< W, mcName, mcDesc >::stop (  )  [virtual]

Removes the motion command from the motion manager if it was our own creation.

Reimplemented from MCNodeBase.

Definition at line 48 of file WaypointWalkNode.h.


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

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:18 2016 by Doxygen 1.6.3