YARP
Yet Another Robot Platform
FrameTransformGet_nwc_ros Class Reference

frameTransformGet_nwc_ros: A ros network wrapper client that receives frame transforms from a ros topic and makes them available through an IFrameTransformStorageGet interface. More...

#include <frameTransformGet/FrameTransformGet_nwc_ros.h>

+ Inheritance diagram for FrameTransformGet_nwc_ros:

Public Member Functions

 FrameTransformGet_nwc_ros (double tperiod=0.010)
 
 ~FrameTransformGet_nwc_ros ()=default
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
void run () override
 Loop function. More...
 
bool getTransforms (std::vector< yarp::math::FrameTransform > &transforms) const override
 Obtains all frame transforms saved in a storage. More...
 
void receiveFrameTransforms ()
 
void rosTransformToYARPTransform (const yarp::rosmsg::geometry_msgs::TransformStamped &input, yarp::math::FrameTransform &output, bool isStatic)
 
double yarpStampFromROS (const yarp::rosmsg::TickTime &rosTime)
 
- 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
 
 ~DeviceDriver () override
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
virtual std::string id () const
 Return the id assigned to the PolyDriver. More...
 
virtual void setId (const std::string &id)
 Set the id for this device. More...
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver. More...
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others. More...
 
- Public Member Functions inherited from yarp::os::IConfig
virtual ~IConfig ()
 Destructor. More...
 
virtual bool open (Searchable &config)
 Initialize the object. More...
 
virtual bool close ()
 Shut the object down. More...
 
virtual bool configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from yarp::os::PeriodicThread
 PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
 Constructor. More...
 
 PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
 Constructor. More...
 
virtual ~PeriodicThread ()
 
bool start ()
 Call this to start the thread. More...
 
void 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 () const
 Returns true when the thread is started, false otherwise. More...
 
bool isSuspended () const
 Returns true when the thread is suspended, false otherwise. More...
 
bool setPeriod (double period)
 Set the (new) period of the thread. More...
 
double getPeriod () const
 Return the current period 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 getEstimatedPeriod () const
 Return estimated period since last reset. More...
 
void getEstimatedPeriod (double &av, double &std) const
 Return estimated period since last reset. More...
 
unsigned int getIterations () const
 Return the number of iterations performed since last reset. More...
 
double getEstimatedUsed () const
 Return the estimated duration of the run() function since last reset. More...
 
void getEstimatedUsed (double &av, double &std) const
 Return estimated duration of the run() function since last reset. 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 () const
 Query the current priority of the thread, if the OS supports that. More...
 
int getPolicy () const
 Query the current scheduling policy of the thread, if the OS supports that. More...
 
- Public Member Functions inherited from yarp::dev::IFrameTransformStorageGet
virtual ~IFrameTransformStorageGet ()
 
virtual bool getTransforms (std::vector< yarp::math::FrameTransform > &transforms) const =0
 Obtains all frame transforms saved in a storage. More...
 

Additional Inherited Members

- Protected Member Functions inherited from yarp::os::PeriodicThread
virtual bool threadInit ()
 Initialization method. More...
 
virtual void threadRelease ()
 Release method. More...
 
virtual void run ()=0
 Loop function. 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...
 

Detailed Description

frameTransformGet_nwc_ros: A ros network wrapper client that receives frame transforms from a ros topic and makes them available through an IFrameTransformStorageGet interface.

See FrameTransform: start all the required devices needed for transforming frames for additional info.

Parameters

Parameters required by this device are:

Parameter name SubParameter Type Units Default Value Required Description ----—
GENERAL - group - - No
- period double seconds 0.01 No The PeriodicThread period in seconds
- refresh_interval double seconds 0.1 No The time interval outside which timed ft will be deleted
ROS - group - - No
- ft_topic string - /tf No The name of the ROS topic from which fts will be received
- ft_topic_static string - /tf_static No The name of the ROS topic from which static fts will be received
- ft_node string - /tfNodeGet No The of the ROS node

N.B. pay attention to the difference between tf and ft

Example of configuration file using .ini format.

device frameTransformGet_nwc_yarp
[GENERAL]
period 0.05
refresh_interval 0.2
[ROS]
ft_topic /tf
ft_topic_static /tf_static
ft_node /tfNodeGet

Definition at line 68 of file FrameTransformGet_nwc_ros.h.

Constructor & Destructor Documentation

◆ FrameTransformGet_nwc_ros()

FrameTransformGet_nwc_ros::FrameTransformGet_nwc_ros ( double  tperiod = 0.010)

Definition at line 22 of file FrameTransformGet_nwc_ros.cpp.

◆ ~FrameTransformGet_nwc_ros()

FrameTransformGet_nwc_ros::~FrameTransformGet_nwc_ros ( )
default

Member Function Documentation

◆ close()

bool FrameTransformGet_nwc_ros::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 93 of file FrameTransformGet_nwc_ros.cpp.

◆ getTransforms()

bool FrameTransformGet_nwc_ros::getTransforms ( std::vector< yarp::math::FrameTransform > &  transforms) const
overridevirtual

Obtains all frame transforms saved in a storage.

Parameters
transformsthe returned list of frame transforms
Returns
true/false

Implements yarp::dev::IFrameTransformStorageGet.

Definition at line 117 of file FrameTransformGet_nwc_ros.cpp.

◆ open()

bool FrameTransformGet_nwc_ros::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
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).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 28 of file FrameTransformGet_nwc_ros.cpp.

◆ receiveFrameTransforms()

void FrameTransformGet_nwc_ros::receiveFrameTransforms ( )

Definition at line 160 of file FrameTransformGet_nwc_ros.cpp.

◆ rosTransformToYARPTransform()

void FrameTransformGet_nwc_ros::rosTransformToYARPTransform ( const yarp::rosmsg::geometry_msgs::TransformStamped input,
yarp::math::FrameTransform output,
bool  isStatic 
)

Definition at line 145 of file FrameTransformGet_nwc_ros.cpp.

◆ run()

void FrameTransformGet_nwc_ros::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 106 of file FrameTransformGet_nwc_ros.cpp.

◆ yarpStampFromROS()

double FrameTransformGet_nwc_ros::yarpStampFromROS ( const yarp::rosmsg::TickTime rosTime)

Definition at line 133 of file FrameTransformGet_nwc_ros.cpp.


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