TimerComponent Class Reference

A Component interface to the Real-Time Toolkit's timer. More...

#include <TimerComponent.hpp>

List of all members.

Classes

struct  TimeoutCatcher
 Helper class for catching the virtual timeout function of Timer. More...

Public Member Functions

 TimerComponent (std::string name="Timer")
 Set up a component for timing events.

Protected Member Functions

bool startHook ()
 This hook will check if a NonPeriodicActivity has been properly setup.
void updateHook ()
void stopHook ()
bool waitFor (RTT::Timer::TimerId id)
 Command Implementation: wait until a timer expires.
bool wait (RTT::Timer::TimerId id, double seconds)
 Command Implementation: arm and wait until a timer expires.
bool isTimerExpired (RTT::Timer::TimerId id) const
 Command Condition: return true if id expired.

Protected Attributes

TimeoutCatcher mtimer
RTT::Event< void(RTT::Timer::TimerId)> mtimeoutEvent
RTT::Command< bool(RTT::Timer::TimerId)> waitForCommand
 Command: wait until a timer expires.
RTT::Command< bool(RTT::Timer::TimerId,
double)> 
waitCommand
 Command: arm and wait until a timer expires.

Detailed Description

A Component interface to the Real-Time Toolkit's timer.

It must be configured with a NonPeriodicActivity which will emit the timeout event of this component.

Definition at line 22 of file TimerComponent.hpp.


The documentation for this class was generated from the following files:
Generated on Thu Dec 23 15:05:28 2010 for OrocosComponentLibrary by  doxygen 1.6.3