YARP  2.3.68+220-20170323.2+git4955ef0
Yet Another Robot Platform
yarp::os::PriorityDebugThread Class Reference

#include <priority_carrier/PriorityCarrier.h>

+ Inheritance diagram for yarp::os::PriorityDebugThread:

Public Member Functions

 PriorityDebugThread (PriorityCarrier *carrier)
 Class PriorityDebugThread. More...
 
virtual ~PriorityDebugThread ()
 
void run ()
 Loop function. More...
 
bool threadInit ()
 Initialization method. More...
 
void threadRelease ()
 Release method. More...
 
- Public Member Functions inherited from yarp::os::RateThread
 RateThread (int period)
 Constructor. More...
 
virtual ~RateThread ()
 
bool start ()
 Call this to start the thread. More...
 
bool step ()
 Call this to "step" the thread rather than starting it. More...
 
void stop ()
 Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called). More...
 
void askToStop ()
 Stop the thread. More...
 
bool isRunning ()
 Returns true when the thread is started, false otherwise. More...
 
bool isSuspended ()
 Returns true when the thread is suspended, false otherwise. More...
 
bool setRate (int period)
 Set the (new) rate of the thread. More...
 
double getRate ()
 Return the current rate of the thread. More...
 
void suspend ()
 Suspend the thread, the thread keeps running by doLoop is never executed. More...
 
void resume ()
 Resume the thread if previously suspended. More...
 
void resetStat ()
 Reset thread statistics. More...
 
double getEstPeriod ()
 Return estimated period since last reset. More...
 
void getEstPeriod (double &av, double &std)
 Return estimated period since last reset. More...
 
unsigned int getIterations ()
 Return the number of iterations performed since last reset. More...
 
double getEstUsed ()
 Return the estimated duration of the run() function since last reset. More...
 
void getEstUsed (double &av, double &std)
 Return estimated duration of the run() function since last reset. More...
 
virtual void beforeStart ()
 Called just before a new thread starts. More...
 
virtual void afterStart (bool success)
 Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start(). More...
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that. More...
 
int getPriority ()
 Query the current priority of the thread, if the OS supports that. More...
 
int getPolicy ()
 Query the current scheduling policy of the thread, if the OS supports that. More...
 

Public Attributes

int count
 
PriorityCarrierpcarrier
 
ConstString debugPortName
 
BufferedPort< yarp::sig::VectordebugPort
 

Detailed Description

Definition at line 62 of file PriorityCarrier.h.

Constructor & Destructor Documentation

◆ PriorityDebugThread()

PriorityDebugThread::PriorityDebugThread ( PriorityCarrier carrier)

Class PriorityDebugThread.

Definition at line 371 of file PriorityCarrier.cpp.

◆ ~PriorityDebugThread()

PriorityDebugThread::~PriorityDebugThread ( )
virtual

Definition at line 377 of file PriorityCarrier.cpp.

Member Function Documentation

◆ run()

void PriorityDebugThread::run ( )
virtual

Loop function.

This is the thread itself.

Implements yarp::os::RateThread.

Definition at line 382 of file PriorityCarrier.cpp.

◆ threadInit()

bool PriorityDebugThread::threadInit ( )
virtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented from yarp::os::RateThread.

Definition at line 398 of file PriorityCarrier.cpp.

◆ threadRelease()

void PriorityDebugThread::threadRelease ( )
virtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::RateThread.

Definition at line 404 of file PriorityCarrier.cpp.

Member Data Documentation

◆ count

int yarp::os::PriorityDebugThread::count

Definition at line 71 of file PriorityCarrier.h.

◆ debugPort

BufferedPort<yarp::sig::Vector> yarp::os::PriorityDebugThread::debugPort

Definition at line 74 of file PriorityCarrier.h.

◆ debugPortName

ConstString yarp::os::PriorityDebugThread::debugPortName

Definition at line 73 of file PriorityCarrier.h.

◆ pcarrier

PriorityCarrier* yarp::os::PriorityDebugThread::pcarrier

Definition at line 72 of file PriorityCarrier.h.


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