#include <yarp/robotinterface/impl/CalibratorThread.h>

Inheritance diagram for yarp::robotinterface::impl::CalibratorThread:

Classes
class	Private

Public Types
enum	Action { ActionCalibrate , ActionPark }

Public Member Functions
	CalibratorThread (yarp::dev::ICalibrator calibrator, const std::string &calibratorName, yarp::dev::DeviceDriver target, const std::string &targetName, yarp::robotinterface::impl::CalibratorThread::Action action)

	~CalibratorThread () override

void	run () override
	Main body of the new thread.

void	onStop () override
	Call-back, called while halting the thread (before join).

Public Member Functions inherited from yarp::os::Thread
	Thread ()
	Constructor.

virtual	~Thread ()
	Destructor.

bool	start ()
	Start the new thread running.

bool	stop ()
	Stop the thread.

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

virtual bool	threadInit ()
	Initialization method.

virtual void	threadRelease ()
	Release method.

bool	isStopping ()
	Returns true if the thread is stopping (Thread::stop has been called).

bool	isRunning ()
	Returns true if the thread is running (Thread::start has been called successfully and the thread has not stopped).

long int	getKey ()
	Get a unique identifier for the thread.

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

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

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

bool	join (double seconds=-1)
	The function returns when the thread execution has completed.

void	setOptions (int stackSize=0)
	Set the stack size for the new thread.

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Thread
static int	getCount ()
	Check how many threads are running.

static long int	getKeyOfCaller ()
	Get a unique identifier for the calling thread.

static void	yield ()
	Reschedule the execution of current thread, allowing other threads to run.

static void	setDefaultStackSize (int stackSize)
	Set the default stack size for all threads created after this point.

Detailed Description

Definition at line 29 of file CalibratorThread.h.

Member Enumeration Documentation

◆ Action

enum yarp::robotinterface::impl::CalibratorThread::Action

Enumerator
ActionCalibrate
ActionPark

Definition at line 32 of file CalibratorThread.h.

Constructor & Destructor Documentation

◆ CalibratorThread()

yarp::robotinterface::impl::CalibratorThread::CalibratorThread	(	yarp::dev::ICalibrator *	calibrator,
		const std::string &	calibratorName,
		yarp::dev::DeviceDriver *	target,
		const std::string &	targetName,
		yarp::robotinterface::impl::CalibratorThread::Action	action
	)

Definition at line 65 of file CalibratorThread.cpp.

◆ ~CalibratorThread()

yarp::robotinterface::impl::CalibratorThread::~CalibratorThread ( )

override

Definition at line 83 of file CalibratorThread.cpp.

Member Function Documentation

◆ onStop()

void yarp::robotinterface::impl::CalibratorThread::onStop ( )

overridevirtual

Call-back, called while halting the thread (before join).

This callback is executed by the same thread that calls stop(). It should not be called directly. Override this method to do the right thing for your particular Thread::run.

Reimplemented from yarp::os::Thread.

Definition at line 93 of file CalibratorThread.cpp.

◆ run()

void yarp::robotinterface::impl::CalibratorThread::run ( )

overridevirtual

Main body of the new thread.

Override this method to do what you want. After Thread::start is called, this method will start running in a separate thread. It is important that this method either keeps checking Thread::isStopping to see if it should stop, or you override the Thread::onStop method to interact with it in some way to shut the new thread down. There is no really reliable, portable way to stop a thread cleanly unless that thread cooperates.

Implements yarp::os::Thread.

Definition at line 88 of file CalibratorThread.cpp.

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

src/libYARP_robotinterface/src/yarp/robotinterface/impl/CalibratorThread.h
src/libYARP_robotinterface/src/yarp/robotinterface/impl/CalibratorThread.cpp

Classes

Public Types

Public Member Functions

Additional Inherited Members