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 >:

[legend]

---

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 22 of file WaypointWalkNode.h.

List of all members.

Public Member Functions
	WaypointEngineNode ()
	constructor
	WaypointEngineNode (const std::string &name)
	constructor
	~WaypointEngineNode ()
	destructor
virtual void	postStart ()
	Called by start() after the doStart(), allows superclasses to complete initialization.
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 26 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 29 of file WaypointWalkNode.h.

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

WaypointEngineNode< W, mcName, mcDesc >::~WaypointEngineNode

(

)

destructor

Definition at line 32 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 56 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 59 of file WaypointWalkNode.h.

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

virtual void WaypointEngineNode< W, mcName, mcDesc >::postStart

(

)

[virtual]

Called by start() after the doStart(), allows superclasses to complete initialization.

For robustness to future change, subclasses should be sure to call the superclass implementation.

Reimplemented from BehaviorBase.

Definition at line 34 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 44 of file WaypointWalkNode.h.

---

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

• WaypointWalkNode.h