Tekkotsu Homepage | Demos | Overview | Downloads | Dev. Resources | Reference | Credits |
MCNodeBase Class Reference#include <MCNode.h>
Inheritance diagram for MCNodeBase:
![]() Detailed DescriptionCommon parent class for all the templated MCNode, which is what you want to instantiate.Definition at line 10 of file MCNode.h.
Constructor & Destructor Documentation
don't call (copy constructor)
Member Function Documentation
Adds the motion command to the motion manager, add a listener for the motion's completion event.
Reimplemented from StateNode. Reimplemented in PostureNode, WalkEngineNode< W, mcName, mcDesc >, and WaypointEngineNode< W, mcName, mcDesc >. Definition at line 33 of file MCNode.cc. Referenced by WaypointEngineNode< W, mcName, mcDesc >::DoStart(), WalkEngineNode< W, mcName, mcDesc >::DoStart(), and PostureNode::DoStart().
Assumes the event is a completion event from the motion, throws a corresponding state node completion event.
Reimplemented from BehaviorBase. Reimplemented in WaypointEngineNode< W, mcName, mcDesc >.
Allows you to assign a previously created motion, which might be shared among several MCNodes. If this node already has an mc, then it will be freed, removing from MotionManager if necessary
reveal the MC_ID; if the motion isn't currently active, returns MotionManager::invalid_MC_ID
Gives a short description of what this class of behaviors does... you should override this (but don't have to). If you do override this, also consider overriding getDescription() to return it Reimplemented from BehaviorBase. Reimplemented in LedNode, MCNode< T, mcName, mcDesc, completes >, MCNode< LedMC >, MCNode< PostureMC, defPostureNodeName, defPostureNodeDesc, true >, MCNode< TailWagMC, defTailWagNodeName, defTailWagNodeDesc, false >, MCNode< W, mcName, mcDesc >, and MCNode< HeadPointerMC, defHeadPointerNodeName, defHeadPointerNodeDesc, true >. Definition at line 34 of file MCNode.h. Referenced by getDescription().
Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis). By default simply returns getName(), because any calls from a BehaviorBase function to getClassDescription() are going to call BehaviorBase::getClassDescription(), not ~YourSubClass~getClassDescription(), because static functions can't be virtual in C++ (doh!) This means that getDescription called on a pointer to a BehaviorBase of unknown subtype would always return an empty string, which is pretty useless. So instead we return the name in this situation. If you want getDescription to return getClassDescription, you'll have to override it in your subclass to do so. Reimplemented from BehaviorBase. Reimplemented in LedNode, MCNode< T, mcName, mcDesc, completes >, MCNode< LedMC >, MCNode< PostureMC, defPostureNodeName, defPostureNodeDesc, true >, MCNode< TailWagMC, defTailWagNodeName, defTailWagNodeDesc, false >, MCNode< W, mcName, mcDesc >, and MCNode< HeadPointerMC, defHeadPointerNodeName, defHeadPointerNodeDesc, true >.
returns reference to mc or a new SharedObject<T> if mc is currently NULL (so it will always return a valid value) if a particular motion command needs some initial setup besides the default constructor, overriding this function is a good opportunity to do so Implemented in LedNode, MCNode< T, mcName, mcDesc, completes >, MCNode< LedMC >, MCNode< PostureMC, defPostureNodeName, defPostureNodeDesc, true >, MCNode< TailWagMC, defTailWagNodeName, defTailWagNodeDesc, false >, MCNode< W, mcName, mcDesc >, and MCNode< HeadPointerMC, defHeadPointerNodeName, defHeadPointerNodeDesc, true >. Referenced by DoStart().
returns true if the motion command being used was created internally via getPrivateMC()
don't call (assignment operator)
Member Data Documentation
the default name for MCNodes -- can be overridden via MCNode's template arguments
Definition at line 12 of file MCNode.h. Referenced by getClassDescription().
MotionCommand used by this node (may be NULL if sharing the MC with other nodes).
Definition at line 51 of file MCNode.h. Referenced by MCNode< T, mcName, mcDesc, completes >::getPrivateMC(), LedNode::getPrivateMC(), hasPrivateMC(), setMC(), and ~MCNodeBase().
id number for the MotionCommand
Definition at line 52 of file MCNode.h. Referenced by DoStart(), DoStop(), MCNode< T, mcName, mcDesc, completes >::getMC(), getMC_ID(), and setMC().
if true, will post a completion when the underlying MotionCommand posts a status
Definition at line 53 of file MCNode.h. Referenced by processEvent().
The documentation for this class was generated from the following files: |
Tekkotsu v4.0 |
Generated Thu Nov 22 00:58:31 2007 by Doxygen 1.5.4 |