LedMC Class Reference
This is just a simple wrapper - you probably want to be looking at LedEngine. More...
#include <LedMC.h>
Public Member Functions | |
| LedMC () | |
| constructor | |
| virtual | ~LedMC () |
| destructor | |
| virtual void | DoStart () |
| Override this if you want to run some startup code after being added to the 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 | |
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 19 of file LedMC.h.
Constructor & Destructor Documentation
Member Function Documentation
| virtual void LedMC::DoStart | ( | ) | [virtual] |
Override this if you want to run some startup code after being added to the MotionManager.
Reimplemented from MotionCommand.
| virtual int LedMC::isAlive | ( | ) | [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.
| virtual int LedMC::isDirty | ( | ) | [virtual] |
returns true if there are changes since the last updateLEDs()
Reimplemented from LedEngine.
Definition at line 53 of file LedMC.h.
Referenced by isAlive().
| void LedMC::setWeights | ( | LEDBitMask_t | leds, | |
| float | weight | |||
| ) |
| virtual int LedMC::updateOutputs | ( | ) | [virtual] |
updates the cmds from LedEngine::updateLEDs()
Implements MotionCommand.
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 68 of file LedMC.h.
Referenced by updateOutputs().
bool LedMC::notified [protected] |
set to true when we've posted a status event for completion of a flash/cflash
Definition at line 69 of file LedMC.h.
Referenced by updateOutputs().
The documentation for this class was generated from the following file:
