Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

LedMC Class Reference

#include <LedMC.h>

Inheritance diagram for LedMC:

List of all members.


Detailed Description

This is just a simple wrapper - you probably want to be looking at LedEngine.

This is handy if all you want to do is control the LED's, but since other MotionCommands will probably also want to make use of the LEDs, they can just use the engine component to do all the work.

Definition at line 16 of file LedMC.h.


Public Member Functions

 LedMC ()
 constructor
virtual ~LedMC ()
 destructor
virtual void DoStart ()
 called after this is added to MotionManager
virtual int updateOutputs ()
 updates the cmds from LedEngine::updateLEDs()
virtual int isDirty ()
 returns true if there are changes since the last updateLEDs()
virtual int isAlive ()
 used to prune "dead" motions from the MotionManager
void setWeights (LEDBitMask_t leds, float weight)
 Sets the JointCmd::weight of the LEDs specified by leds to weight.

Protected Attributes

OutputCmd cmds [NumLEDs][NumFrames]
 needed to store weight values of LEDs (useful to mark LEDs as unused)
bool notified
 set to true when we've posted a status event for completion of a flash/cflash

Constructor & Destructor Documentation

LedMC::LedMC (  )  [inline]

constructor

Definition at line 19 of file LedMC.h.

virtual LedMC::~LedMC (  )  [inline, virtual]

destructor

Definition at line 21 of file LedMC.h.


Member Function Documentation

virtual void LedMC::DoStart (  )  [inline, virtual]

called after this is added to MotionManager

Reimplemented from MotionCommand.

Definition at line 23 of file LedMC.h.

virtual int LedMC::updateOutputs (  )  [inline, virtual]

updates the cmds from LedEngine::updateLEDs()

Implements MotionCommand.

Definition at line 29 of file LedMC.h.

virtual int LedMC::isDirty (  )  [inline, virtual]

returns true if there are changes since the last updateLEDs()

Reimplemented from LedEngine.

Definition at line 45 of file LedMC.h.

virtual int LedMC::isAlive (  )  [inline, virtual]

used to prune "dead" motions from the MotionManager

note that a motion could be "paused" or inactive and therefore not dirty, but still alive, biding its time to "strike" ;)

Returns:
zero if the motion is still processing, non-zero otherwise

Implements MotionCommand.

Definition at line 47 of file LedMC.h.

void LedMC::setWeights ( LEDBitMask_t  leds,
float  weight 
) [inline]

Sets the JointCmd::weight of the LEDs specified by leds to weight.

Definition at line 50 of file LedMC.h.

Referenced by LedMC().


Member Data Documentation

OutputCmd LedMC::cmds[NumLEDs][NumFrames] [protected]

needed to store weight values of LEDs (useful to mark LEDs as unused)

Definition at line 61 of file LedMC.h.

Referenced by setWeights(), and updateOutputs().

bool LedMC::notified [protected]

set to true when we've posted a status event for completion of a flash/cflash

Definition at line 62 of file LedMC.h.

Referenced by updateOutputs().


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

Tekkotsu v4.0
Generated Thu Nov 22 00:58:28 2007 by Doxygen 1.5.4