OrocosComponentLibrary  2.8.3
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TimerComponent Class Reference

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

#include <TimerComponent.hpp>

Inheritance diagram for TimerComponent:

Classes

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

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

std::vector< OutputPort< RTT::os::Timer::TimerId > * > port_timers
 
OutputPort< RTT::os::Timer::TimerId > mtimeoutEvent
 
TimeoutCatcher mtimer
 
RTT::Operation< bool(RTT::os::Timer::TimerId)> waitForCommand
 Command: wait until a timer expires.
 
RTT::Operation< bool(RTT::os::Timer::TimerId, double)> waitCommand
 Command: arm and wait until a timer expires.
 

Detailed Description

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

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

Definition at line 21 of file TimerComponent.hpp.


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