Yet Another Robot Platform
No Matches
Ros2Test Class Reference

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-ros2/src/devices/ros2test/Ros2Test.h>

+ Inheritance diagram for Ros2Test:

Public Member Functions

 Ros2Test ()
 Ros2Test (const Ros2Test &)=delete
 Ros2Test (Ros2Test &&) noexcept=delete
Ros2Testoperator= (const Ros2Test &)=delete
Ros2Testoperator= (Ros2Test &&) noexcept=delete
 ~Ros2Test () override=default
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
bool close () override
 Close the DeviceDriver.
void run () override
 Loop function.
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 DeviceDriver (const DeviceDriver &other)=delete
 DeviceDriver (DeviceDriver &&other) noexcept=delete
DeviceDriveroperator= (const DeviceDriver &other)=delete
DeviceDriveroperator= (DeviceDriver &&other) noexcept=delete
virtual ~DeviceDriver ()
virtual std::string id () const
 Return the id assigned to the PolyDriver.
virtual void setId (const std::string &id)
 Set the id for this device.
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others.
- Public Member Functions inherited from yarp::os::PeriodicThread
 PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
 PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
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 bool threadInit ()
 Initialization method.
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 43 of file Ros2Test.h.

Constructor & Destructor Documentation

◆ Ros2Test() [1/3]

Ros2Test::Ros2Test ( )

Definition at line 34 of file Ros2Test.cpp.

◆ Ros2Test() [2/3]

Ros2Test::Ros2Test ( const Ros2Test )

◆ Ros2Test() [3/3]

Ros2Test::Ros2Test ( Ros2Test &&  )

◆ ~Ros2Test()

Ros2Test::~Ros2Test ( )

Member Function Documentation

◆ close()

bool Ros2Test::close ( )

Close the DeviceDriver.

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 51 of file Ros2Test.cpp.

◆ open()

bool Ros2Test::open ( yarp::os::Searchable config)

Open the DeviceDriver.

configis a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 39 of file Ros2Test.cpp.

◆ operator=() [1/2]

Ros2Test & Ros2Test::operator= ( const Ros2Test )

◆ operator=() [2/2]

Ros2Test & Ros2Test::operator= ( Ros2Test &&  )

◆ run()

void Ros2Test::run ( )

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 58 of file Ros2Test.cpp.

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