Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

KoduInterpreter::ReceiveActionRunner::ReceiveActionStart Class Reference

#include <KoduInterpreter.h>

Inheritance diagram for KoduInterpreter::ReceiveActionRunner::ReceiveActionStart:

Detailed Description

Definition at line 3003 of file KoduInterpreter.h.

List of all members.

Public Member Functions

 ReceiveActionStart (const std::string &nodename="ReceiveActionStart")
void doStart ()
 Delegate function for subclasses to be notified when the behavior starts up.
void doEvent ()
 Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event.

Constructor & Destructor Documentation

KoduInterpreter::ReceiveActionRunner::ReceiveActionStart::ReceiveActionStart ( const std::string &  nodename = "ReceiveActionStart"  ) 

Definition at line 3005 of file KoduInterpreter.h.


Member Function Documentation

void KoduInterpreter::ReceiveActionRunner::ReceiveActionStart::doEvent (  )  [virtual]

Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event.

Default implementation watches for 'private' text message events (those forwarded by a BehaviorSwitchControl from ControllerGUI input) and will publically rebroadcast them. The idea is that your own processEvent gets first dibs, but if the behavior doesn't handle the text message, it will be handed off for others.

Reimplemented from BehaviorBase.

Definition at line 3015 of file KoduInterpreter.h.

void KoduInterpreter::ReceiveActionRunner::ReceiveActionStart::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 3006 of file KoduInterpreter.h.


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

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:11 2016 by Doxygen 1.6.3