LedNode Class Reference
#include <LedNode.h>
Inheritance diagram for LedNode:
Detailed Description
A simple StateNode that executes a LedMC motion command and throws 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.
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 | |
| LedNode (const std::string &class_name, const std::string &node_name) | |
| constructor for subclasses (which would need to provide a different class name) | |
| 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() | |
Member Function Documentation
| static std::string LedNode::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 MCNode< LedMC >.
Definition at line 19 of file LedNode.h.
Referenced by getDescription().
| virtual std::string LedNode::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 MCNode< LedMC >.
The documentation for this class was generated from the following file:
