ASCIIVisionBehavior Class Reference#include <ASCIIVisionBehavior.h>
Inheritance diagram for ASCIIVisionBehavior:
[legend]List of all members.
Detailed Description
streams low-resolution ASCII-art of the camera image to sout
Definition at line 13 of file ASCIIVisionBehavior.h.
|
Public Member Functions |
| ASCIIVisionBehavior () |
| constructor
|
virtual void | DoStart () |
| By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.
|
virtual void | DoStop () |
| By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).
|
virtual void | processEvent (const EventBase &e) |
| By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.
|
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).
|
Static Public Attributes |
static const unsigned int | charMapSize = 62 |
| the number of available characters for levels of "gray"
|
static const char | charMap [charMapSize] |
| the included characters sorted in order of darkness - could be improved... (less is more sometimes)
|
Constructor & Destructor Documentation
ASCIIVisionBehavior::ASCIIVisionBehavior |
( |
|
) |
[inline] |
|
Member Function Documentation
virtual void ASCIIVisionBehavior::DoStart |
( |
|
) |
[inline, virtual] |
|
virtual void ASCIIVisionBehavior::DoStop |
( |
|
) |
[inline, virtual] |
|
|
By default, subtracts from the reference counter (RemoveReference()), and thus may deletex if zero; Don't forget to still call this when you override this; Warning: call this at the end of your DoStop(), not beginning (it might delete this ).
Reimplemented from BehaviorBase.
Definition at line 26 of file ASCIIVisionBehavior.h. |
static std::string ASCIIVisionBehavior::getClassDescription |
( |
|
) |
[inline, static] |
|
virtual std::string ASCIIVisionBehavior::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 34 of file ASCIIVisionBehavior.h. |
virtual void ASCIIVisionBehavior::processEvent |
( |
const EventBase & |
e |
) |
[virtual] |
|
Member Data Documentation
|
the included characters sorted in order of darkness - could be improved... (less is more sometimes)
Definition at line 19 of file ASCIIVisionBehavior.h. |
The documentation for this class was generated from the following file:
|