Trigger Class Reference

Inheritance diagram for Trigger:

Callback List of all members.

Detailed Description

Triggers provide general purpose execution rate control.

The primary use of a general Trigger is to get the CommsManager to wake up the main loop of a program after a certain period of time, or once its RobotObjects receive new data.

Definition at line 51 of file Trigger.H.

Public Member Functions

 Trigger ()
 Trigger (Capability *someObject)
 ~Trigger ()
bool add (Capability *someObject)
bool activateObject (Capability *someObject)
bool active ()
void reset ()
void clear ()
void setType (const TriggerType type)
const TriggerType getType ()

Private Attributes

TriggerType m_type
Time m_length
Time m_lastActivation
vector< Capability * > m_targets
vector< Capability * > m_activated


Constructor & Destructor Documentation

Trigger (  )  [inline]

Definition at line 53 of file Trigger.H.

Trigger ( Capability someObject  )  [inline]

Definition at line 54 of file Trigger.H.

References Trigger::m_targets.

~Trigger (  )  [inline]

Definition at line 55 of file Trigger.H.

References Trigger::m_targets.


Member Function Documentation

bool add ( Capability someObject  ) 

Definition at line 30 of file Trigger.cpp.

References Trigger::m_targets.

bool activateObject ( Capability someObject  ) 

Definition at line 45 of file Trigger.cpp.

References Trigger::m_activated, and Trigger::m_targets.

bool active (  )  [inline]

Definition at line 59 of file Trigger.H.

References Trigger::m_activated, and Trigger::m_targets.

void reset (  )  [inline]

Definition at line 60 of file Trigger.H.

References Trigger::m_activated, Trigger::m_lastActivation, and Time::now().

Referenced by Trigger::clear().

void clear (  )  [inline]

Definition at line 61 of file Trigger.H.

References Trigger::m_targets, and Trigger::reset().

void setType ( const TriggerType  type  )  [inline]

Definition at line 63 of file Trigger.H.

References Trigger::m_type.

const TriggerType getType (  )  [inline]

Definition at line 64 of file Trigger.H.

References Trigger::m_type.


Member Data Documentation

TriggerType m_type [private]

Definition at line 68 of file Trigger.H.

Referenced by Trigger::getType(), and Trigger::setType().

Time m_length [private]

Definition at line 70 of file Trigger.H.

Time m_lastActivation [private]

Definition at line 71 of file Trigger.H.

Referenced by Trigger::reset().

vector<Capability *> m_targets [private]

Definition at line 73 of file Trigger.H.

Referenced by Trigger::activateObject(), Trigger::active(), Trigger::add(), Trigger::clear(), Trigger::Trigger(), and Trigger::~Trigger().

vector<Capability *> m_activated [private]

Definition at line 74 of file Trigger.H.

Referenced by Trigger::activateObject(), Trigger::active(), and Trigger::reset().


The documentation for this class was generated from the following files:
Generated on Thu Feb 1 15:31:56 2007 for WURDE by  doxygen 1.5.1