Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

RecordMotionNode Class Reference

DESCRIPTION. More...

#include <RecordMotionNode.h>

Inheritance diagram for RecordMotionNode:

Detailed Description

DESCRIPTION.

Definition at line 14 of file RecordMotionNode.h.

List of all members.

Public Member Functions

 RecordMotionNode (const std::string &nm="", float angularRes=0.1f, unsigned int temporalRes=0)
 constructor, take an instance name, filename to save to, joint position resolution (max error in radians), temporal resolution (0 for every sensor update)
virtual void preStart ()
 Called by start() before the doStart(), allows superclasses to do some initialization startup preceeding subclass customization.
virtual void doEvent ()
 Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event.
virtual void stop ()
 Transitions should call this when 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).

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 Attributes

float angRes
unsigned int timeRes
unsigned int recStartTime
unsigned int startTime [NumPIDJoints]
float startPos [NumPIDJoints]
float lastPos [NumPIDJoints]
unsigned int lastTime [NumPIDJoints]
float error [NumPIDJoints]
float motion [NumPIDJoints]
float time [NumPIDJoints]
MotionManager::MC_ID relaxID
SharedObject
< DynamicMotionSequence
rec

Private Member Functions

 RecordMotionNode (const RecordMotionNode &)
 don't call (copy constructor)
RecordMotionNodeoperator= (const RecordMotionNode &)
 don't call (assignment operator)

Constructor & Destructor Documentation

RecordMotionNode::RecordMotionNode ( const std::string &  nm = "",
float  angularRes = 0.1f,
unsigned int  temporalRes = 0 
)

constructor, take an instance name, filename to save to, joint position resolution (max error in radians), temporal resolution (0 for every sensor update)

Definition at line 21 of file RecordMotionNode.h.

RecordMotionNode::RecordMotionNode ( const RecordMotionNode  )  [private]

don't call (copy constructor)


Member Function Documentation

virtual void RecordMotionNode::doEvent (  )  [virtual]

Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event.

Default implementation watches for 'private' text message events (those forwarded by a BehaviorSwitchControl from ControllerGUI input) and will publically rebroadcast them. The idea is that your own processEvent gets first dibs, but if the behavior doesn't handle the text message, it will be handed off for others.

Reimplemented from BehaviorBase.

Definition at line 46 of file RecordMotionNode.h.

static std::string RecordMotionNode::getClassDescription (  )  [static]

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.

Definition at line 80 of file RecordMotionNode.h.

Referenced by getDescription().

virtual std::string RecordMotionNode::getDescription (  )  const [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 81 of file RecordMotionNode.h.

RecordMotionNode& RecordMotionNode::operator= ( const RecordMotionNode  )  [private]

don't call (assignment operator)

virtual void RecordMotionNode::preStart (  )  [virtual]

Called by start() before the doStart(), allows superclasses to do some initialization startup preceeding subclass customization.

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

Reimplemented from BehaviorBase.

Definition at line 30 of file RecordMotionNode.h.

virtual void RecordMotionNode::stop (  )  [virtual]

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

Reimplemented from StateNode.

Definition at line 74 of file RecordMotionNode.h.


Member Data Documentation

Definition at line 88 of file RecordMotionNode.h.

Referenced by doEvent().

float RecordMotionNode::error[NumPIDJoints] [protected]

Definition at line 96 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

float RecordMotionNode::lastPos[NumPIDJoints] [protected]

Definition at line 94 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

unsigned int RecordMotionNode::lastTime[NumPIDJoints] [protected]

Definition at line 95 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

float RecordMotionNode::motion[NumPIDJoints] [protected]

Definition at line 98 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

Definition at line 102 of file RecordMotionNode.h.

Referenced by doEvent(), and stop().

unsigned int RecordMotionNode::recStartTime [protected]

Definition at line 90 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

Definition at line 101 of file RecordMotionNode.h.

Referenced by preStart(), and stop().

float RecordMotionNode::startPos[NumPIDJoints] [protected]

Definition at line 93 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

unsigned int RecordMotionNode::startTime[NumPIDJoints] [protected]

Definition at line 92 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

float RecordMotionNode::time[NumPIDJoints] [protected]

Definition at line 99 of file RecordMotionNode.h.

Referenced by doEvent(), and preStart().

unsigned int RecordMotionNode::timeRes [protected]

Definition at line 89 of file RecordMotionNode.h.

Referenced by preStart().


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

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