Homepage Demos Overview Downloads Tutorials Reference
Credits
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

MCRepeater Class Reference

#include <MCRepeater.h>

Inheritance diagram for MCRepeater:

Inheritance graph
[legend]
List of all members.

Detailed Description

Sends a given MotionCommand to MotionManager, waits until it autoprunes, and then sends it again.

Definition at line 11 of file MCRepeater.h.

Public Member Functions

 MCRepeater (const SharedObjectBase *sharedmc)
 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, and deletes if zero; Note you should 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 &)
 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 getName () const
 Identifies the behavior in menus and such.


Static Public Member Functions

std::string getClassDescription ()
 Gives a short description of what this class of behaviors does... you should override this (but don't have to).


Protected Attributes

const SharedObjectBase * mc
 the motion command being repeated


Private Member Functions

 MCRepeater (const MCRepeater &)
 don't call

MCRepeater operator= (const MCRepeater &)
 don't call

Constructor & Destructor Documentation

MCRepeater::MCRepeater (  const SharedObjectBase *  sharedmc  )  [inline]
 

constructor

Definition at line 14 of file MCRepeater.h.

MCRepeater::MCRepeater (  const MCRepeater &   )  [private]
 

don't call

Member Function Documentation

virtual void MCRepeater::DoStart (   )  [inline, virtual]
 

By default, merely adds to the reference counter (through AddReference()); Note you should still call this from your overriding methods.

Reimplemented from BehaviorBase.

Definition at line 16 of file MCRepeater.h.

virtual void MCRepeater::DoStop (   )  [inline, virtual]
 

By default, subtracts from the reference counter, and deletes if zero; Note you should 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 22 of file MCRepeater.h.

std::string MCRepeater::getClassDescription (   )  [inline, static]
 

Gives a short description of what this class of behaviors does... you should override this (but don't have to).

Reimplemented from BehaviorBase.

Definition at line 35 of file MCRepeater.h.

virtual std::string MCRepeater::getName (   )  const [inline, virtual]
 

Identifies the behavior in menus and such.

Implements BehaviorBase.

Definition at line 33 of file MCRepeater.h.

MCRepeater MCRepeater::operator= (  const MCRepeater &   )  [private]
 

don't call

virtual void MCRepeater::processEvent (  const EventBase &   )  [inline, virtual]
 

By defining here, allows you to get away with not supplying a processEvent() function for the EventListener interface. By default, does nothing.

Reimplemented from BehaviorBase.

Definition at line 27 of file MCRepeater.h.

Member Data Documentation

const SharedObjectBase* MCRepeater::mc [protected]
 

the motion command being repeated

Definition at line 38 of file MCRepeater.h.

Referenced by DoStart(), MCRepeater(), and processEvent().

The documentation for this class was generated from the following file:
Tekkotsu v2.0
 		Generated Wed Jan 21 03:23:17 2004 by Doxygen 1.3.4