TimerComponent Class Reference

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

#include <TimerComponent.hpp>

List of all members.

Public Member Functions

 TimerComponent (std::string name="Timer")
 Set up a component for timing events.
virtual void timeout (RTT::Timer::TimerId id)
virtual bool stop ()
double getTime () const
 Returns the current system time in seconds.
double secondsSince (double stamp) const
 Returns the time elapsed since a given system time.

Protected Member Functions

bool configureHook ()
 This hook will check if a NonPeriodicActivity has been properly setup.
bool startHook ()
void updateHook ()
void stopHook ()
void cleanupHook ()
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

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 Tue Aug 25 14:09:54 2009 for OrocosComponentLibrary by  doxygen 1.5.8