FlashIPAddrBehavior Class Reference#include <FlashIPAddrBehavior.h>
Inheritance diagram for FlashIPAddrBehavior:
[legend]List of all members.
Detailed Description
Displays IP address by speaking the digits and flashing a series of numbers on the LED face panel.
Will only run the display on DoStart() if the flash_on_start config variable is set. Otherwise you will need to hold down the buttons specified by button1 and button2 to trigger the display. Note that if the e-stop is active it will intercept the button events, so turn off e-stop first.
Definition at line 15 of file FlashIPAddrBehavior.h.
|
Public Member Functions |
| FlashIPAddrBehavior () |
| constructor
|
virtual void | DoStart () |
| if the Config::behavior_config::flash_on_start flag is set, will setup and run
|
virtual void | DoStop () |
| halts any display which may be in progress
|
virtual void | processEvent (const EventBase &e) |
| Receives button events, timers, and motman manager pruning notifications.
|
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 Types |
typedef XLargeMotionSequenceMC | MSMC_t |
| used to flash the LEDs to report the IP address
|
Protected Member Functions |
void | loadSounds () |
| loads the numeric sounds into memory
|
void | releaseSounds () |
| releases the numeric sounds
|
void | setupSequence () |
| construct the motion sequence for flashing leds, request timers to play corresponding sound file
|
Protected Attributes |
std::vector< std::string > | sounds |
| sound to play, corresponding to timers to coincide with corresponding digit on the LEDs (could be done with chained sounds, but this is cooler)
|
SharedObject< MSMC_t > | ms |
| motion sequence used to control the LEDs
|
MotionManager::MC_ID | ms_id |
| id number of ms
|
Static Protected Attributes |
static const unsigned int | button1 = ChinButOffset |
| one of two buttons which must be pressed together to trigger the report without using the Controller
|
static const unsigned int | button2 = HeadFrButOffset |
| one of two buttons which must be pressed together to trigger the report without using the Controller
|
static const unsigned int | ACTIVATE_TIMER = -1U |
| timer id to specify both trigger buttons have been down long enough
|
static const unsigned int | delay = 64 |
| time (in milliseconds) to expect ms to be delayed before it actually starts
|
Member Typedef Documentation
Constructor & Destructor Documentation
FlashIPAddrBehavior::FlashIPAddrBehavior |
( |
|
) |
[inline] |
|
Member Function Documentation
void FlashIPAddrBehavior::DoStart |
( |
|
) |
[virtual] |
|
void FlashIPAddrBehavior::DoStop |
( |
|
) |
[virtual] |
|
static std::string FlashIPAddrBehavior::getClassDescription |
( |
|
) |
[inline, static] |
|
virtual std::string FlashIPAddrBehavior::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 36 of file FlashIPAddrBehavior.h. |
void FlashIPAddrBehavior::loadSounds |
( |
|
) |
[protected] |
|
void FlashIPAddrBehavior::processEvent |
( |
const EventBase & |
e |
) |
[virtual] |
|
void FlashIPAddrBehavior::releaseSounds |
( |
|
) |
[protected] |
|
void FlashIPAddrBehavior::setupSequence |
( |
|
) |
[protected] |
|
Member Data Documentation
The documentation for this class was generated from the following files:
|