Orocos Real-Time Toolkit
2.8.3
|
This Periodic Thread is meant for executing a PeriodicActivity object periodically. More...
#include <rtt/extras/TimerThread.hpp>
Public Member Functions | |
TimerThread (int priority, const std::string &name, double periodicity, unsigned cpu_affinity=~0) | |
Create a periodic Timer thread. More... | |
TimerThread (int scheduler, int priority, const std::string &name, double periodicity, unsigned cpu_affinity=~0) | |
Create a periodic Timer thread with a given scheduler type. More... | |
virtual | ~TimerThread () |
Destructor. More... | |
bool | addActivity (PeriodicActivity *t) |
Add an Timer that will be ticked every execution period Once added, a timer can not be removed. More... | |
bool | removeActivity (PeriodicActivity *t) |
virtual bool | start () |
Start the Thread. More... | |
virtual bool | stop () |
Stop the Thread. More... | |
void | setStopTimeout (Seconds s) |
Sets the timeout for stop(), in seconds. More... | |
Seconds | getStopTimeout () const |
Returns the desired timeout for stop(), in seconds. More... | |
bool | setPeriod (Seconds s) |
Set the periodicity in Seconds. More... | |
bool | setPeriod (secs s, nsecs ns) |
Set the periodicity of this thread (seconds, nanoseconds) More... | |
bool | setPeriod (TIME_SPEC p) |
Set the periodicity of this thread. More... | |
void | getPeriod (secs &s, nsecs &ns) const |
Get the periodicity of this thread (seconds, nanoseconds) More... | |
virtual Seconds | getPeriod () const |
Get the periodicity in Seconds. More... | |
virtual nsecs | getPeriodNS () const |
Get the periodicity in nanoseconds. More... | |
virtual bool | isPeriodic () const |
virtual bool | isRunning () const |
Returns whether the thread is running. More... | |
virtual bool | isActive () const |
Returns whether the thread is active. More... | |
virtual const char * | getName () const |
Read the name of this task. More... | |
virtual RTOS_TASK * | getTask () |
Get the RTOS_TASK pointer. More... | |
virtual const RTOS_TASK * | getTask () const |
const version of the above. More... | |
virtual bool | setScheduler (int sched_type) |
Change the scheduler policy in which this thread runs. More... | |
virtual int | getScheduler () const |
Get the scheduler policy in which this thread runs. More... | |
virtual bool | setPriority (int priority) |
Set the priority of this Thread. More... | |
virtual int | getPriority () const |
The priority of this Thread. More... | |
virtual unsigned int | getPid () const |
Returns the Process or Thread ID of this thread, as assigned by the Operating System. More... | |
virtual bool | setCpuAffinity (unsigned cpu_affinity) |
Set cpu affinity for this thread. More... | |
virtual unsigned | getCpuAffinity () const |
virtual void | yield () |
Yields (put to the back of the scheduler queue) the calling thread. More... | |
virtual void | setMaxOverrun (int m) |
virtual int | getMaxOverrun () const |
virtual void | setWaitPeriodPolicy (int p) |
Set the wait policy of a periodic thread. More... | |
unsigned int | threadNumber () const |
The unique thread number (within the same process). More... | |
bool | isSelf () const |
Static Public Member Functions | |
static TimerThreadPtr | Instance (int priority, double periodicity) |
Create a TimerThread with a given priority and periodicity, using the default scheduler, ORO_SCHED_RT. More... | |
static TimerThreadPtr | Instance (int scheduler, int priority, double periodicity) |
Create a TimerThread with a given scheduler, priority and periodicity. More... | |
static TimerThreadPtr | Instance (int scheduler, int priority, double periodicity, unsigned cpu_affinity) |
Create a TimerThread with a given scheduler, priority and periodicity. More... | |
static void | setStackSize (unsigned int ssize) |
Sets the stack size of the threads to be created. More... | |
static void | setLockTimeoutNoPeriod (double timeout_in_s) |
Sets the lock timeout for a thread which does not have a period The default is 1 second. More... | |
static void | setLockTimeoutPeriodFactor (double factor) |
Set the lock timeout for a thread which has a period by a factor of the period The default is factor 10. More... | |
Static Public Attributes | |
static const unsigned int | MAX_ACTIVITIES = 64 |
Protected Types | |
typedef std::vector< boost::weak_ptr< TimerThread > > | TimerThreadList |
A Boost weak pointer is used to store non-owning pointers to shared objects. More... | |
Protected Member Functions | |
virtual bool | initialize () |
virtual void | step () |
virtual void | finalize () |
void | reorderList () |
void | terminate () |
Exit and destroy the thread. More... | |
void | emergencyStop () |
virtual void | loop () |
virtual bool | breakLoop () |
Protected Attributes | |
os::MutexRecursive | mutex |
A Activity can not create a activity of same priority from step(). More... | |
int | threadnb |
Threads are given an unique number, which follows thread creation order. More... | |
Static Protected Attributes | |
static TimerThreadList | TimerThreads |
All timer threads. More... | |
This Periodic Thread is meant for executing a PeriodicActivity object periodically.
Definition at line 69 of file TimerThread.hpp.
|
protected |
A Boost weak pointer is used to store non-owning pointers to shared objects.
Definition at line 140 of file TimerThread.hpp.
RTT::TimerThread::TimerThread | ( | int | priority, |
const std::string & | name, | ||
double | periodicity, | ||
unsigned | cpu_affinity = ~0 |
||
) |
Create a periodic Timer thread.
priority | The priority of this thread |
periodicity | The periodicity of this thread in seconds (e.g. 0.001 = 1000Hz ) |
Definition at line 95 of file TimerThread.cpp.
References MAX_ACTIVITIES.
RTT::TimerThread::TimerThread | ( | int | scheduler, |
int | priority, | ||
const std::string & | name, | ||
double | periodicity, | ||
unsigned | cpu_affinity = ~0 |
||
) |
Create a periodic Timer thread with a given scheduler type.
scheduler | The scheduler in which this thread runs |
priority | The priority of this thread within scheduler |
periodicity | The periodicity of this thread in seconds (e.g. 0.001 = 1000Hz ) |
Definition at line 101 of file TimerThread.cpp.
References MAX_ACTIVITIES.
|
virtual |
bool RTT::TimerThread::addActivity | ( | PeriodicActivity * | t | ) |
Add an Timer that will be ticked every execution period Once added, a timer can not be removed.
Definition at line 113 of file TimerThread.cpp.
References MAX_ACTIVITIES, and mutex.
|
protectedvirtualinherited |
Reimplemented in RTT::corba::OrbRunner, RTT::extras::FileDescriptorActivity, RTT::mqueue::Dispatcher, RTT::Activity, and RTT::corba::CorbaDispatcher.
Definition at line 521 of file Thread.cpp.
Referenced by RTT::os::Thread::stop().
|
protectedinherited |
Definition at line 226 of file Thread.cpp.
References RTT::os::Thread::finalize().
Referenced by RTT::os::thread_function().
|
protectedvirtual |
Reimplemented from RTT::os::Thread.
Reimplemented in RTT::extras::SimulationThread.
Definition at line 140 of file TimerThread.cpp.
References mutex, and reorderList().
|
virtualinherited |
Implements RTT::os::ThreadInterface.
Reimplemented in RTT::Activity.
Definition at line 606 of file Thread.cpp.
References RTT::os::rtos_task_get_cpu_affinity().
Referenced by RTT::Activity::getCpuAffinity(), and RTT::os::Thread::Thread().
|
virtualinherited |
Implements RTT::os::ThreadInterface.
Definition at line 642 of file Thread.cpp.
|
virtualinherited |
Read the name of this task.
Implements RTT::os::ThreadInterface.
Definition at line 632 of file Thread.cpp.
References RTT::os::rtos_task_get_name().
Referenced by RTT::corba::CorbaDispatcher::initialize(), RTT::extras::SimulationThread::SimulationThread(), RTT::os::Thread::stop(), RTT::os::Thread::Thread(), RTT::os::thread_function(), and RTT::os::Thread::~Thread().
Get the periodicity of this thread (seconds, nanoseconds)
Definition at line 570 of file Thread.cpp.
|
virtualinherited |
Get the periodicity in Seconds.
Return zero if non periodic.
Implements RTT::os::ThreadInterface.
Reimplemented in RTT::extras::FileDescriptorActivity, and RTT::Activity.
Definition at line 591 of file Thread.cpp.
References RTT::nsecs_to_Seconds().
Referenced by RTT::Activity::getPeriod(), RTT::os::Thread::getStopTimeout(), RTT::extras::SimulationThread::run(), RTT::extras::SimulationThread::SimulationThread(), RTT::extras::SimulationThread::step(), and RTT::os::Thread::Thread().
|
virtualinherited |
Get the periodicity in nanoseconds.
Return zero if non periodic.
Implements RTT::os::ThreadInterface.
Definition at line 596 of file Thread.cpp.
|
virtualinherited |
Returns the Process or Thread ID of this thread, as assigned by the Operating System.
This function tries to return the Thread ID, if the OS supports it, otherwise it returns the process ID. If that is not available either, zero is returned. On Linux systems for example, the Thread ID of the main thread is equal to the Process ID. The Thread ID of every newly created thread is different from the Process ID (and unique).
Implements RTT::os::ThreadInterface.
Definition at line 611 of file Thread.cpp.
References RTT::os::rtos_task_get_pid().
Referenced by RTT::os::Thread::Thread().
|
virtualinherited |
The priority of this Thread.
Implements RTT::os::ThreadInterface.
Definition at line 586 of file Thread.cpp.
References RTT::os::rtos_task_get_priority().
Referenced by RTT::extras::SimulationThread::SimulationThread(), and RTT::os::Thread::Thread().
|
virtualinherited |
Get the scheduler policy in which this thread runs.
Implements RTT::os::ThreadInterface.
Definition at line 488 of file Thread.cpp.
References RTT::os::rtos_task_get_scheduler(), RTT::os::rtos_task_set_period(), and RTT::os::rtos_task_set_scheduler().
Referenced by RTT::os::Thread::setScheduler(), and RTT::os::Thread::Thread().
|
inherited |
Returns the desired timeout for stop(), in seconds.
If not set with setStopTimeout, the timeout is deduced from the global values lock_timeout_period_factor and lock_timeout_no_period_in_s
Definition at line 408 of file Thread.cpp.
References RTT::os::Thread::getPeriod().
Referenced by RTT::os::Thread::stop().
|
inlinevirtualinherited |
Get the RTOS_TASK pointer.
Implements RTT::os::ThreadInterface.
Definition at line 205 of file Thread.hpp.
Referenced by RTT::os::thread_function().
|
inlinevirtualinherited |
const version of the above.
Implements RTT::os::ThreadInterface.
Definition at line 210 of file Thread.hpp.
|
protectedvirtual |
Reimplemented from RTT::os::Thread.
Reimplemented in RTT::extras::SimulationThread.
Definition at line 136 of file TimerThread.cpp.
|
static |
Create a TimerThread with a given priority and periodicity, using the default scheduler, ORO_SCHED_RT.
Definition at line 57 of file TimerThread.cpp.
References ORO_SCHED_RT.
|
static |
Create a TimerThread with a given scheduler, priority and periodicity.
Definition at line 62 of file TimerThread.cpp.
|
static |
Create a TimerThread with a given scheduler, priority and periodicity.
Definition at line 67 of file TimerThread.cpp.
References RTT::os::CheckPriority(), RTT::os::ThreadInterface::getCpuAffinity(), RTT::os::MainThread::Instance(), and RTT::Seconds_to_nsecs().
|
virtualinherited |
Returns whether the thread is active.
A thread is active between the invocation of start() and the invocation of stop().
Implements RTT::os::ThreadInterface.
Reimplemented in RTT::Activity.
Definition at line 464 of file Thread.cpp.
Referenced by RTT::Activity::isActive(), RTT::os::Thread::start(), and RTT::Activity::trigger().
|
virtualinherited |
Reimplemented in RTT::Activity.
Definition at line 581 of file Thread.cpp.
Referenced by RTT::Activity::isPeriodic().
|
virtualinherited |
Returns whether the thread is running.
A thread is running if it is executing its loop() function or in the process of periodically calling step(). Hence for periodic threads, isRunning() == isActive() while for non-periodic threads, isRunning() is only true if isActive() and it is executing loop().
Implements RTT::os::ThreadInterface.
Reimplemented in RTT::extras::FileDescriptorActivity, RTT::Activity, and RTT::extras::SimulationThread.
Definition at line 459 of file Thread.cpp.
Referenced by RTT::extras::SimulationThread::isRunning(), RTT::Activity::isRunning(), and RTT::os::Thread::~Thread().
|
inherited |
Definition at line 58 of file ThreadInterface.cpp.
References RTT::os::ThreadInterface::getTask(), and RTT::os::rtos_task_is_self().
|
protectedvirtualinherited |
Reimplemented in RTT::corba::OrbRunner, RTT::extras::FileDescriptorActivity, RTT::Activity, RTT::corba::CorbaDispatcher, and RTT::mqueue::Dispatcher.
Definition at line 516 of file Thread.cpp.
References RTT::os::Thread::step().
Referenced by RTT::os::thread_function().
bool RTT::TimerThread::removeActivity | ( | PeriodicActivity * | t | ) |
Definition at line 124 of file TimerThread.cpp.
References mutex.
|
protected |
Definition at line 163 of file TimerThread.cpp.
Referenced by finalize(), and step().
|
virtualinherited |
Set cpu affinity for this thread.
cpu_affinity | The cpu affinity of the thread ( |
Reimplemented in RTT::Activity.
Definition at line 601 of file Thread.cpp.
References RTT::os::rtos_task_set_cpu_affinity().
Referenced by RTT::Activity::setCpuAffinity().
|
staticinherited |
Sets the lock timeout for a thread which does not have a period The default is 1 second.
timeout_in_s | the timeout is seconds |
Definition at line 71 of file Thread.cpp.
|
staticinherited |
Set the lock timeout for a thread which has a period by a factor of the period The default is factor 10.
factor | Factor of the period |
Definition at line 73 of file Thread.cpp.
|
virtualinherited |
Implements RTT::os::ThreadInterface.
Definition at line 637 of file Thread.cpp.
|
virtualinherited |
Set the periodicity in Seconds.
new_period | A positive number expressing the period |
Implements RTT::os::ThreadInterface.
Definition at line 536 of file Thread.cpp.
References RTT::Seconds_to_nsecs().
Referenced by RTT::Activity::setPeriod(), and RTT::os::Thread::setPeriod().
Set the periodicity of this thread (seconds, nanoseconds)
Definition at line 542 of file Thread.cpp.
References rtos_sem_signal(), and RTT::os::rtos_task_make_periodic().
|
inherited |
Set the periodicity of this thread.
Definition at line 565 of file Thread.cpp.
References RTT::os::Thread::setPeriod().
|
virtualinherited |
Set the priority of this Thread.
priority | The priority given upon construction of this thread. It has to be interpreted in the current OS scheduler. |
Implements RTT::os::ThreadInterface.
Definition at line 576 of file Thread.cpp.
References RTT::os::rtos_task_set_priority().
|
virtualinherited |
Change the scheduler policy in which this thread runs.
sched_type | An OS-specific value which selects a scheduler. Orocos requires that these two values are available:
|
Your OS can in addition provide other sched_type's which map more naturally to the schedulers present. If your OS does not make a distinction between real-time and other, both values may map to the same scheduler type.
Implements RTT::os::ThreadInterface.
Definition at line 469 of file Thread.cpp.
References RTT::os::CheckScheduler(), RTT::os::Thread::getScheduler(), RTT::Info, rtos_sem_signal(), RTT::os::rtos_task_get_name(), and RTT::os::rtos_task_set_scheduler().
Referenced by RTT::extras::SimulationThread::SimulationThread().
|
staticinherited |
Sets the stack size of the threads to be created.
This value is suggestive and may be altered or ignored by your operating system. Use zero to use the system's default.
ssize | the size of the stack in bytes |
Definition at line 69 of file Thread.cpp.
|
inherited |
Sets the timeout for stop(), in seconds.
Definition at line 403 of file Thread.cpp.
|
virtualinherited |
Set the wait policy of a periodic thread.
The | wait policy between ORO_WAIT_ABS (absolute wait) and ORO_WAIT_REL (relative wait) |
Implements RTT::os::ThreadInterface.
Definition at line 647 of file Thread.cpp.
References RTT::os::rtos_task_set_wait_period_policy().
|
virtualinherited |
Start the Thread.
Implements RTT::os::ThreadInterface.
Reimplemented in RTT::extras::FileDescriptorActivity, RTT::Activity, RTT::extras::IRQActivity, and RTT::extras::SimulationThread.
Definition at line 338 of file Thread.cpp.
References RTT::Critical, RTT::os::Thread::initialize(), RTT::os::Thread::isActive(), rtos_sem_signal(), rtos_sem_value(), and RTT::os::rtos_task_make_periodic().
Referenced by RTT::extras::SimulationThread::start(), RTT::Activity::start(), and RTT::Activity::trigger().
|
protectedvirtual |
Reimplemented from RTT::os::Thread.
Reimplemented in RTT::extras::SimulationThread.
Definition at line 150 of file TimerThread.cpp.
References mutex, and reorderList().
Referenced by RTT::extras::SimulationThread::run(), and RTT::extras::SimulationThread::step().
|
virtualinherited |
Stop the Thread.
Implements RTT::os::ThreadInterface.
Reimplemented in RTT::extras::FileDescriptorActivity, and RTT::Activity.
Definition at line 417 of file Thread.cpp.
References RTT::os::Thread::breakLoop(), RTT::Error, RTT::os::Thread::finalize(), RTT::os::Thread::getName(), RTT::os::Thread::getStopTimeout(), RTT::os::MutexTimedLock::isSuccessful(), RTT::os::rtos_task_make_periodic(), and RTT::Warning.
Referenced by RTT::extras::SimulationThread::step(), RTT::Activity::stop(), RTT::extras::SimulationThread::~SimulationThread(), RTT::os::Thread::~Thread(), and ~TimerThread().
|
protectedinherited |
Exit and destroy the thread.
Definition at line 621 of file Thread.cpp.
References rtos_sem_signal(), and RTT::os::rtos_task_delete().
Referenced by RTT::os::Thread::~Thread().
|
inlineinherited |
The unique thread number (within the same process).
Definition at line 216 of file ThreadInterface.hpp.
Referenced by RTT::os::Thread::Thread(), and RTT::os::thread_function().
|
virtualinherited |
Yields (put to the back of the scheduler queue) the calling thread.
Implements RTT::os::ThreadInterface.
Definition at line 616 of file Thread.cpp.
References RTT::os::rtos_task_yield().
|
static |
Definition at line 76 of file TimerThread.hpp.
Referenced by addActivity(), and TimerThread().
|
mutableprotected |
A Activity can not create a activity of same priority from step().
If so a deadlock will occur.
Definition at line 134 of file TimerThread.hpp.
Referenced by addActivity(), finalize(), removeActivity(), and step().
|
protectedinherited |
Threads are given an unique number, which follows thread creation order.
Definition at line 228 of file ThreadInterface.hpp.
Referenced by RTT::os::ThreadInterface::ThreadInterface().
|
staticprotected |
All timer threads.
Definition at line 145 of file TimerThread.hpp.