EEROS  0.4.1.0
API for the EEROS Real-Time Robotics Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
eeros::PeriodicThread Class Reference

#include <PeriodicThread.hpp>

Inheritance diagram for eeros::PeriodicThread:
Inheritance graph
[legend]
Collaboration diagram for eeros::PeriodicThread:
Collaboration graph
[legend]

Public Types

enum  status { running = 0, stopping = 1, stopped = 2, paused = 3 }
 

Public Member Functions

 PeriodicThread (double period, double delay=0, bool realtime=false, status start=running, int priority=0)
 
virtual ~PeriodicThread ()
 
virtual status getStatus () const
 
virtual double getPeriod () const
 
virtual void start ()
 
virtual void pause ()
 
virtual void stop ()
 
- Public Member Functions inherited from eeros::Thread
 Thread ()
 
virtual ~Thread ()
 
virtual std::string getId () const
 
virtual void join ()
 

Static Public Member Functions

static constexpr bool isRealtimeSupported ()
 

Public Attributes

PeriodicCounter counter
 

Additional Inherited Members

- Protected Member Functions inherited from eeros::Thread
 Thread (std::function< void()> t)
 
virtual void run ()
 
- Protected Attributes inherited from eeros::Thread
std::thread t
 
eeros::logger::Logger
< eeros::logger::LogWriter > 		log
 

Member Enumeration Documentation

enum eeros::PeriodicThread::status
Enumerator
running 
stopping 
stopped 
paused 

Constructor & Destructor Documentation

PeriodicThread::PeriodicThread ( double  period,
double  delay = 0,
bool  realtime = false,
status  start = running,
int  priority = 0 
)

Here is the call graph for this function:

virtual eeros::PeriodicThread::~PeriodicThread ( )
virtual

Member Function Documentation

virtual double eeros::PeriodicThread::getPeriod ( ) const
virtual
virtual status eeros::PeriodicThread::getStatus ( ) const
virtual

Here is the caller graph for this function:

static constexpr bool eeros::PeriodicThread::isRealtimeSupported ( )
inlinestatic
virtual void eeros::PeriodicThread::pause ( )
virtual
virtual void eeros::PeriodicThread::start ( )
virtual

Here is the caller graph for this function:

virtual void eeros::PeriodicThread::stop ( )
virtual

Here is the caller graph for this function:

Member Data Documentation

PeriodicCounter eeros::PeriodicThread::counter
The documentation for this class was generated from the following files: