Homepage Demos Overview Downloads Tutorials Reference
Credits

ToggleHeadLightBehavior Class Reference

#include <ToggleHeadLightBehavior.h>

Inheritance diagram for ToggleHeadLightBehavior:

Inheritance graph
[legend]
List of all members.

Detailed Description

opens or closes the head light on an ERS-220

Definition at line 10 of file ToggleHeadLightBehavior.h.

Public Member Functions

 ToggleHeadLightBehavior ()
 constructor
virtual void DoStart ()
 opens the head light
virtual void DoStop ()
 resets the head light
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

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

MotionManager::MC_ID light_id
 id value of the PostureMC used to control the light


Constructor & Destructor Documentation

ToggleHeadLightBehavior::ToggleHeadLightBehavior  )  [inline]
 

constructor

Definition at line 13 of file ToggleHeadLightBehavior.h.


Member Function Documentation

virtual void ToggleHeadLightBehavior::DoStart  )  [inline, virtual]
 

opens the head light

Reimplemented from BehaviorBase.

Definition at line 16 of file ToggleHeadLightBehavior.h.

virtual void ToggleHeadLightBehavior::DoStop  )  [inline, virtual]
 

resets the head light

Reimplemented from BehaviorBase.

Definition at line 26 of file ToggleHeadLightBehavior.h.

std::string ToggleHeadLightBehavior::getClassDescription  )  [inline, 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 30 of file ToggleHeadLightBehavior.h.

Referenced by getDescription().

virtual std::string ToggleHeadLightBehavior::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 31 of file ToggleHeadLightBehavior.h.


Member Data Documentation

MotionManager::MC_ID ToggleHeadLightBehavior::light_id [protected]
 

id value of the PostureMC used to control the light

Definition at line 34 of file ToggleHeadLightBehavior.h.

Referenced by DoStart(), DoStop(), and ToggleHeadLightBehavior().


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

Tekkotsu v2.2.1
Generated Tue Nov 23 16:37:53 2004 by Doxygen 1.3.9.1