#include <Timer.hpp>
Classes | |
| struct | TimerInfo |
Public Types | |
| typedef int | TimerId |
Public Member Functions | |
| bool | arm (TimerId timer_id, Seconds wait_time) |
| bool | isArmed (TimerId timer_id) const |
| bool | killTimer (TimerId timer_id) |
| void | setMaxTimers (TimerId max) |
| bool | startTimer (TimerId timer_id, Seconds period) |
| virtual void | timeout (TimerId timer_id) |
| Timer (TimerId max_timers, int scheduler=-1, int priority=0) | |
| TimeService::Seconds | timeRemaining (TimerId timer_id) const |
| bool | waitFor (RTT::os::Timer::TimerId id) |
| bool | waitForUntil (RTT::os::Timer::TimerId id, nsecs abs_time) |
| ~Timer () | |
Protected Types | |
| typedef TimeService::nsecs | Time |
| typedef std::vector< TimerInfo > | TimerIds |
Protected Member Functions | |
| bool | breakLoop () |
| void | finalize () |
| bool | initialize () |
| void | loop () |
| void | step () |
Protected Attributes | |
| Mutex | m |
| bool | mdo_quit |
| Semaphore | msem |
| base::ActivityInterface * | mThread |
| TimerIds | mtimers |
Detailed Description
This class allows to define a timer object which can be armed in single shot and periodic mode. In Order to use this class, derive your class from Timer and implement the timeout() method. The resolution of this class depends completely on the timer resolution of the underlying operating system.
If you do not attach an activity, the Timer will create a thread of its own and start it. That thread will be stopped and cleaned up when the Timer is destroyed.
Member Typedef Documentation
typedef TimeService::nsecs RTT::os::Timer::Time [protected] |
| typedef int RTT::os::Timer::TimerId |
typedef std::vector<TimerInfo> RTT::os::Timer::TimerIds [protected] |
Constructor & Destructor Documentation
| RTT::Timer::Timer | ( | TimerId | max_timers, |
| int | scheduler = -1, |
||
| int | priority = 0 |
||
| ) |
Create a timer object which can hold max_timers timers. A Timer must be executed in a non periodic thread (or the main thread) or it will refuse to start. If scheduler is set to -1 (default) no thread is created and you need to attach a thread yourself to this Timer.
- Parameters:
-
max_timers The initial amount of timers this Timer can monitor. Keep as low as possible. See also setMaxTimers(). scheduler The Orocos scheduler type for this timer. ORO_SCHED_OTHER or ORO_SCHED_RT or -1 to attach your own thread. priority The priority within the scheduler of this timer.
Member Function Documentation
| bool RTT::Timer::arm | ( | TimerId | timer_id, |
| Seconds | wait_time | ||
| ) |
Arm a timer to fire once over wait_time seconds.
- Parameters:
-
timer_id The number of the timer, starting from zero. wait_time The time in seconds from now, when the timer should expire. This is a floating point number.
- See also:
- killTimer to disable it before it fires.
| bool RTT::Timer::breakLoop | ( | ) | [protected, virtual] |
This method is called by the framework to break out of the loop() method. Reimplement this method to signal loop() to return and return true on success. When this method is not reimplemented by you, it will always return false, denoting that the loop can not be broken. If breakLoop() returns true, the caller will wait until loop() returns.
- Returns:
- true if the loop could be notified to return.
Reimplemented from RTT::base::RunnableInterface.
| void RTT::Timer::finalize | ( | ) | [protected, virtual] |
The method that will be called after the last periodical execution of step() ( or non periodical execution of loop() ), when the RunnableInterface is stopped.
Implements RTT::base::RunnableInterface.
| bool RTT::Timer::initialize | ( | ) | [protected, virtual] |
The method that will be called before the first periodical execution of step() ( or non periodical execution of loop() ), when the thread is started.
Implements RTT::base::RunnableInterface.
| bool RTT::Timer::isArmed | ( | TimerId | timer_id | ) | const |
| bool RTT::Timer::killTimer | ( | TimerId | timer_id | ) |
| void RTT::Timer::loop | ( | ) | [protected, virtual] |
The method that will be executed once when this class is run in a non periodic thread. The default implementation calls step() once.
Reimplemented from RTT::base::RunnableInterface.
| void RTT::Timer::setMaxTimers | ( | TimerId | max | ) |
| bool RTT::Timer::startTimer | ( | TimerId | timer_id, |
| Seconds | period | ||
| ) |
Start a periodic timer which starts first over period seconds and then every period seconds.
- Parameters:
-
timer_id The number of the timer, starting from zero. period The period when the timer should expire. This is a floating point number.
- See also:
- killTimer to disable it again.
| void RTT::Timer::step | ( | ) | [protected, virtual] |
The method that will be periodically executed when this class is run in a periodic thread.
Implements RTT::base::RunnableInterface.
| void RTT::Timer::timeout | ( | TimerId | timer_id | ) | [virtual] |
| double RTT::Timer::timeRemaining | ( | TimerId | timer_id | ) | const |
| bool RTT::Timer::waitFor | ( | RTT::os::Timer::TimerId | id | ) |
| bool RTT::Timer::waitForUntil | ( | RTT::os::Timer::TimerId | id, |
| nsecs | abs_time | ||
| ) |
Wait for a timer to expire with timeout.
- Parameters:
-
timer_id The number of the timer, starting from zero. abs_time The absolute time to wait until before the condition happens. Use rtos_get_time_ns() to get the current time and Seconds_to_nsecs to add a certain amount to the result.
- Returns:
- true if timer has expired or if it was killed before abs_time and false if the timer is not armed
Member Data Documentation
Mutex RTT::os::Timer::m [mutable, protected] |
bool RTT::os::Timer::mdo_quit [protected] |
Semaphore RTT::os::Timer::msem [protected] |
base::ActivityInterface* RTT::os::Timer::mThread [protected] |
TimerIds RTT::os::Timer::mtimers [protected] |
The documentation for this class was generated from the following files: