#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/commands/yarpActionsPlayer/broadcastingThread.h>

Inheritance diagram for BroadcastingThread:

Public Member Functions
	BroadcastingThread (std::string module_name, robotDriver p, action_class a, double period=0.001)

	~BroadcastingThread ()

void	attachRobotDriver (robotDriver *p)

void	attachActions (action_class *a)

bool	threadInit () override
	Initialization method.

void	run () override
	Loop function.

Public Member Functions inherited from yarp::os::PeriodicThread
	PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
	Constructor.

	PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
	Constructor.

virtual	~PeriodicThread ()

bool	start ()
	Call this to start the thread.

void	step ()
	Call this to "step" the thread rather than starting it.

void	stop ()
	Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called).

void	askToStop ()
	Stop the thread.

bool	isRunning () const
	Returns true when the thread is started, false otherwise.

bool	isSuspended () const
	Returns true when the thread is suspended, false otherwise.

bool	setPeriod (double period)
	Set the (new) period of the thread.

double	getPeriod () const
	Return the current period of the thread.

void	suspend ()
	Suspend the thread, the thread keeps running by doLoop is never executed.

void	resume ()
	Resume the thread if previously suspended.

void	resetStat ()
	Reset thread statistics.

double	getEstimatedPeriod () const
	Return estimated period since last reset.

void	getEstimatedPeriod (double &av, double &std) const
	Return estimated period since last reset.

unsigned int	getIterations () const
	Return the number of iterations performed since last reset.

double	getEstimatedUsed () const
	Return the estimated duration of the run() function since last reset.

void	getEstimatedUsed (double &av, double &std) const
	Return estimated duration of the run() function since last reset.

int	setPriority (int priority, int policy=-1)
	Set the priority and scheduling policy of the thread, if the OS supports that.

int	getPriority () const
	Query the current priority of the thread, if the OS supports that.

int	getPolicy () const
	Query the current scheduling policy of the thread, if the OS supports that.

Additional Inherited Members
Protected Member Functions inherited from yarp::os::PeriodicThread
virtual void	threadRelease ()
	Release method.

virtual void	beforeStart ()
	Called just before a new thread starts.

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().

Detailed Description

Definition at line 26 of file broadcastingThread.h.

Constructor & Destructor Documentation

◆ BroadcastingThread()

BroadcastingThread::BroadcastingThread	(	std::string	module_name,
		robotDriver *	p,
		action_class *	a,
		double	period = `0.001`
	)

Definition at line 17 of file broadcastingThread.cpp.

◆ ~BroadcastingThread()

BroadcastingThread::~BroadcastingThread ( )

Definition at line 27 of file broadcastingThread.cpp.

Member Function Documentation

◆ attachActions()

void BroadcastingThread::attachActions ( action_class * a )

◆ attachRobotDriver()

void BroadcastingThread::attachRobotDriver ( robotDriver * p )

◆ run()

void BroadcastingThread::run ( )

overridevirtual

Loop function.

This is the thread itself. The thread calls the run() function every <period> ms. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the run() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Implements yarp::os::PeriodicThread.

Definition at line 59 of file broadcastingThread.cpp.

◆ threadInit()

bool BroadcastingThread::threadInit ( )

overridevirtual

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::PeriodicThread.

Definition at line 33 of file broadcastingThread.cpp.

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

src/commands/yarpActionsPlayer/broadcastingThread.h
src/commands/yarpActionsPlayer/broadcastingThread.cpp

Public Member Functions

Additional Inherited Members