Aibo3DControllerBehavior Class Reference
Listens to aibo3d control commands coming in from the command port. More...
#include <Aibo3DControllerBehavior.h>
Detailed Description
Listens to aibo3d control commands coming in from the command port.
Definition at line 18 of file Aibo3DControllerBehavior.h.
Public Member Functions | |
| Aibo3DControllerBehavior () | |
| constructor | |
| virtual | ~Aibo3DControllerBehavior () |
| destructor | |
| virtual void | doStart () |
| Delegate function for subclasses to be notified when the behavior starts up. | |
| virtual void | doStop () |
| Delegate function for subclasses to be notified when the behavior starts up. | |
| virtual std::string | getGUIType () const |
| returns string corresponding to the Java GUI which should be launched | |
| virtual unsigned int | getPort () const |
| returns port number the Java GUI should connect to | |
| 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). | |
Private Member Functions | |
| Aibo3DControllerBehavior (const Aibo3DControllerBehavior &) | |
| don't call | |
| Aibo3DControllerBehavior | operator= (const Aibo3DControllerBehavior &) |
Private Attributes | |
| bool | launchedSerializer |
| if true, indicates we launched the WorldState serializer, so we should stop it again if we stop | |
Constructor & Destructor Documentation
| Aibo3DControllerBehavior::Aibo3DControllerBehavior | ( | const Aibo3DControllerBehavior & | ) | [private] |
don't call
| Aibo3DControllerBehavior::Aibo3DControllerBehavior | ( | ) |
constructor
Definition at line 27 of file Aibo3DControllerBehavior.h.
| virtual Aibo3DControllerBehavior::~Aibo3DControllerBehavior | ( | ) | [virtual] |
destructor
Definition at line 29 of file Aibo3DControllerBehavior.h.
Member Function Documentation
| void Aibo3DControllerBehavior::doStart | ( | ) | [virtual] |
Delegate function for subclasses to be notified when the behavior starts up.
Should be overridden by subclasses to subscribe to events, install motion commands, etc.
doStart() is basically a hook to allow subclasses to jump in and do some customization of behavior parameters while the behavior is starting. If you are writing a behavior class and do not expect further derivation, just override doStart() yourself. However, if you do expect further derivation of your class, consider using preStart() or postStart() instead, and leave doStart() for the 'leaf' classes.
Reimplemented from BehaviorBase.
Definition at line 11 of file Aibo3DControllerBehavior.cc.
| void Aibo3DControllerBehavior::doStop | ( | ) | [virtual] |
Delegate function for subclasses to be notified when the behavior starts up.
May be overridden to cleanup when the behavior is shutting down. However events will automatically be unsubscribed, and by using addMotion(), motions will automatically be removed by stop(), so you may not need any cleanup.
Reimplemented from BehaviorBase.
Definition at line 32 of file Aibo3DControllerBehavior.cc.
| static std::string Aibo3DControllerBehavior::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 BehaviorBase.
Definition at line 39 of file Aibo3DControllerBehavior.h.
Referenced by getDescription().
| virtual std::string Aibo3DControllerBehavior::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 BehaviorBase.
Definition at line 45 of file Aibo3DControllerBehavior.h.
| virtual std::string Aibo3DControllerBehavior::getGUIType | ( | ) | const [virtual] |
returns string corresponding to the Java GUI which should be launched
Definition at line 35 of file Aibo3DControllerBehavior.h.
| virtual unsigned int Aibo3DControllerBehavior::getPort | ( | ) | const [virtual] |
returns port number the Java GUI should connect to
Definition at line 37 of file Aibo3DControllerBehavior.h.
Referenced by doStart().
| Aibo3DControllerBehavior Aibo3DControllerBehavior::operator= | ( | const Aibo3DControllerBehavior & | ) | [private] |
don't call
Member Data Documentation
bool Aibo3DControllerBehavior::launchedSerializer [private] |
if true, indicates we launched the WorldState serializer, so we should stop it again if we stop
Definition at line 23 of file Aibo3DControllerBehavior.h.
The documentation for this class was generated from the following files:
