WalkToTargetNode Class Reference#include <WalkToTargetNode.h>
Inheritance diagram for WalkToTargetNode:
[legend]List of all members.
Detailed Description
a state node for walking towards a visual target
Definition at line 9 of file WalkToTargetNode.h.
|
Public Member Functions |
| WalkToTargetNode (unsigned int obj) |
| constructor, pass VisionObjectSourceID_t
|
| WalkToTargetNode (const std::string &nodename, unsigned int obj) |
| constructor, pass instance name and VisionObjectSourceID_t
|
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 std::string | getDescription () const |
| Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).
|
virtual void | processEvent (const EventBase &event) |
| By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.
|
virtual Transition * | newDefaultLostTrans (StateNode *dest) |
| returns a suggested transition for detecting "lost" condition, but you don't have to use it
|
virtual Transition * | newDefaultCloseTrans (StateNode *dest) |
| returns a suggested transition for detecting "close to target" condition, but you don't have to use it
|
Static Public Member Functions |
static std::string | getClassDescription () |
| Gives a short description of what this class of behaviors does... you should override this (but don't have to).
|
Protected Member Functions |
| WalkToTargetNode (const std::string &classname, const std::string &nodename, unsigned int obj) |
| constructor, pass class name, instance name, and VisionObjectSourceID_t
|
Protected Attributes |
unsigned int | tracking |
| the object being tracked
|
MotionManager::MC_ID | walker_id |
| so we can walk
|
MotionManager::MC_ID | headpointer_id |
| so we can point the head at the object
|
Private Member Functions |
| WalkToTargetNode (const WalkToTargetNode &) |
| don't call this
|
WalkToTargetNode | operator= (const WalkToTargetNode &) |
| don't call this
|
Constructor & Destructor Documentation
WalkToTargetNode::WalkToTargetNode |
( |
unsigned int |
obj |
) |
[inline] |
|
WalkToTargetNode::WalkToTargetNode |
( |
const std::string & |
nodename, |
|
|
unsigned int |
obj |
|
) |
[inline] |
|
|
constructor, pass instance name and VisionObjectSourceID_t
Definition at line 18 of file WalkToTargetNode.h. |
WalkToTargetNode::WalkToTargetNode |
( |
const std::string & |
classname, |
|
|
const std::string & |
nodename, |
|
|
unsigned int |
obj |
|
) |
[inline, protected] |
|
|
constructor, pass class name, instance name, and VisionObjectSourceID_t
Definition at line 38 of file WalkToTargetNode.h. |
Member Function Documentation
void WalkToTargetNode::DoStart |
( |
|
) |
[virtual] |
|
|
Transitions should call this when you are entering the state, so it can enable its transitions.
Reimplemented from StateNode.
Definition at line 10 of file WalkToTargetNode.cc. |
void WalkToTargetNode::DoStop |
( |
|
) |
[virtual] |
|
|
Transitions should call this when you are leaving the state, so it can disable its transitions.
Reimplemented from StateNode.
Definition at line 19 of file WalkToTargetNode.cc. |
static std::string WalkToTargetNode::getClassDescription |
( |
|
) |
[inline, static] |
|
virtual std::string WalkToTargetNode::getDescription |
( |
|
) |
const [inline, virtual] |
|
|
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.
Definition at line 27 of file WalkToTargetNode.h. |
|
returns a suggested transition for detecting "close to target" condition, but you don't have to use it
Definition at line 67 of file WalkToTargetNode.cc. |
|
returns a suggested transition for detecting "lost" condition, but you don't have to use it
Definition at line 63 of file WalkToTargetNode.cc. |
void WalkToTargetNode::processEvent |
( |
const EventBase & |
event |
) |
[virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following files:
|