Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

LedNode Class Reference

StateNode that executes a LedMC motion command and posts a status event upon completion. More...

#include <LedNode.h>

Inheritance diagram for LedNode:

Detailed Description

StateNode that executes a LedMC motion command and posts a status event upon completion.

Extends MCNode slightly so that each time the LedMC is accessed, any flash commands are reset. This allows a flash to be triggered each time the node starts

Definition at line 11 of file LedNode.h.

List of all members.

Public Member Functions

 LedNode ()
 default constructor, use type name as instance name
 LedNode (const std::string &nm)
 constructor, take an instance name
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 Member Functions

virtual SharedObject< LedMC > & getPrivateMC ()
 extends MCNode implementation so that each time the LedMC is accessed, any flash commands are reset.

Protected Attributes

unsigned int lastAccess
 stores time of last call to getPrivateMC() for resetting flash commands

Constructor & Destructor Documentation

LedNode::LedNode (  ) 

default constructor, use type name as instance name

Definition at line 14 of file LedNode.h.

LedNode::LedNode ( const std::string &  nm  ) 

constructor, take an instance name

Definition at line 17 of file LedNode.h.


Member Function Documentation

static std::string LedNode::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 MCNode< LedMC >.

Definition at line 19 of file LedNode.h.

Referenced by getDescription().

virtual std::string LedNode::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 MCNode< LedMC >.

Definition at line 20 of file LedNode.h.

virtual SharedObject<LedMC>& LedNode::getPrivateMC (  )  [protected, virtual]

extends MCNode implementation so that each time the LedMC is accessed, any flash commands are reset.

Reimplemented from MCNode< LedMC >.

Definition at line 24 of file LedNode.h.

Referenced by LedActivate::LedActivate().


Member Data Documentation

unsigned int LedNode::lastAccess [protected]

stores time of last call to getPrivateMC() for resetting flash commands

Definition at line 34 of file LedNode.h.

Referenced by getPrivateMC().


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

Tekkotsu v5.1CVS
Generated Tue Apr 22 03:51:27 2014 by Doxygen 1.6.3