Public Member Functions | Private Attributes | List of all members
PeriodicTestThread Class Reference
Inheritance diagram for PeriodicTestThread:
Inheritance graph
[legend]

Public Member Functions

TimeSpan accumulatedDeviation () const
 
bool hasRun () const
 
TimeSpan maxDeviation () const
 
TimeSpan meanDeviation () const
 
 PeriodicTestThread (const TimeSpan &period, size_t runs)
 
virtual void run ()
 
virtual ~PeriodicTestThread ()
 
- Public Member Functions inherited from icl_core::thread::PeriodicThread
icl_core::TimeSpan period () const
 
 PeriodicThread (const icl_core::String &description, const icl_core::TimeSpan &period, ThreadPriority priority=0)
 
bool setPeriod (const icl_core::TimeSpan &period)
 
virtual ~PeriodicThread ()
 
- Public Member Functions inherited from icl_core::thread::Thread
void cancel ()
 
bool checkHardRealtime ()
 
bool execute () const
 
bool executesHardRealtime () const
 
icl_core::String getDescription () const
 
bool isHardRealtime () const
 
void join ()
 
virtual void onStop ()
 
icl_core::ThreadPriority priority () const
 
bool running () const
 
void setDescription (const icl_core::String &description)
 
bool setHardRealtime (bool hard_realtime=true)
 
bool setPriority (icl_core::ThreadPriority priority)
 
bool start ()
 
void stop ()
 
 Thread (const icl_core::String &description, icl_core::ThreadPriority priority=0)
 
icl_core::ThreadId threadId () const
 
const char * threadInfo () const
 
bool threadSelf () const
 
bool wait ()
 
bool wait (const icl_core::TimeStamp &timeout)
 
bool wait (const icl_core::TimeSpan &timeout)
 
virtual ~Thread ()
 

Private Attributes

TimeSpan m_accumulated_deviation
 
bool m_has_run
 
TimeSpan m_max_deviation
 
size_t m_runs
 

Additional Inherited Members

- Static Public Member Functions inherited from icl_core::thread::Thread
static icl_core::ThreadId selfId ()
 
- Protected Member Functions inherited from icl_core::thread::PeriodicThread
void waitPeriod ()
 
- Protected Member Functions inherited from icl_core::Noncopyable
 Noncopyable ()
 
virtual ~Noncopyable ()
 

Detailed Description

Thread for testing how exact the periods are executed.

Definition at line 62 of file ts_PeriodicThread.cpp.

Constructor & Destructor Documentation

PeriodicTestThread::PeriodicTestThread ( const TimeSpan period,
size_t  runs 
)
inline

Definition at line 65 of file ts_PeriodicThread.cpp.

virtual PeriodicTestThread::~PeriodicTestThread ( )
inlinevirtual

Definition at line 70 of file ts_PeriodicThread.cpp.

Member Function Documentation

TimeSpan PeriodicTestThread::accumulatedDeviation ( ) const
inline

Definition at line 98 of file ts_PeriodicThread.cpp.

bool PeriodicTestThread::hasRun ( ) const
inline

Definition at line 96 of file ts_PeriodicThread.cpp.

TimeSpan PeriodicTestThread::maxDeviation ( ) const
inline

Definition at line 97 of file ts_PeriodicThread.cpp.

TimeSpan PeriodicTestThread::meanDeviation ( ) const
inline

Definition at line 99 of file ts_PeriodicThread.cpp.

virtual void PeriodicTestThread::run ( )
inlinevirtual

This is the function running in the thread. This has to be reimplemented from derived classes. If you start the thread by calling Start() this function is executed in the thread. If you call don't want that function to be executed in the thread you could call it directly in your derived class.

Implements icl_core::thread::Thread.

Definition at line 72 of file ts_PeriodicThread.cpp.

Member Data Documentation

TimeSpan PeriodicTestThread::m_accumulated_deviation
private

Definition at line 105 of file ts_PeriodicThread.cpp.

bool PeriodicTestThread::m_has_run
private

Definition at line 102 of file ts_PeriodicThread.cpp.

TimeSpan PeriodicTestThread::m_max_deviation
private

Definition at line 104 of file ts_PeriodicThread.cpp.

size_t PeriodicTestThread::m_runs
private

Definition at line 103 of file ts_PeriodicThread.cpp.


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


fzi_icl_core
Author(s):
autogenerated on Mon Jun 10 2019 13:17:59