YARP
Yet Another Robot Platform

frameTransformSet_nws_yarp: A network wrapper client which publishes the transforms received on the yarp::dev::IFrameTransformStorageSet interface to thrift interface FrameTransformStorageSetRPC interface. More...

#include <frameTransformSet/FrameTransformSet_nws_yarp.h>

+ Inheritance diagram for FrameTransformSet_nws_yarp:

Public Member Functions

 FrameTransformSet_nws_yarp ()=default
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
bool attach (yarp::dev::PolyDriver *device2attach) override
 Attach to another object. More...
 
bool detach () override
 Detach the object (you must have first called attach). More...
 
bool setTransformsRPC (const std::vector< yarp::math::FrameTransform > &transforms) override
 
bool setTransformRPC (const yarp::math::FrameTransform &transform) override
 
bool deleteTransformRPC (const std::string &src, const std::string &dst) override
 
bool clearAllRPC () override
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 ~DeviceDriver () override=default
 Destructor. 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 configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from FrameTransformStorageSetRPC
 FrameTransformStorageSetRPC ()
 
virtual std::vector< std::string > help (const std::string &functionName="--all")
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection. More...
 
- Public Member Functions inherited from yarp::os::Wire
yarp::os::WireLinkyarp ()
 Get YARP state associated with this object. More...
 
const yarp::os::WireLinkyarp () const
 Get YARP state associated with this object (const version). More...
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::dev::WrapperSingle
 ~WrapperSingle () override
 Destructor. More...
 
bool attachAll (const yarp::dev::PolyDriverList &drivers) final
 Attach to a list of objects. More...
 
bool detachAll () final
 Detach the object (you must have first called attach). More...
 
- Public Member Functions inherited from yarp::dev::IWrapper
virtual ~IWrapper ()
 Destructor. More...
 
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor. More...
 

Detailed Description

frameTransformSet_nws_yarp: A network wrapper client which publishes the transforms received on the yarp::dev::IFrameTransformStorageSet interface to thrift interface FrameTransformStorageSetRPC interface.

Parameters

This device is paired with its server called FrameTransformSet_nwc_yarp.

Parameters required by this device are:

Parameter name SubParameter Type Units Default Value Required Description
rpc_port_server - string - /frameTransformGet/serverRPC No port on which rpc calls should be made

Example of configuration file using .ini format.

device frameTransformSet_nws_yarp
rpc_port_server /frameTransformGet/serverRPC

Definition at line 40 of file FrameTransformSet_nws_yarp.h.

Constructor & Destructor Documentation

◆ FrameTransformSet_nws_yarp()

FrameTransformSet_nws_yarp::FrameTransformSet_nws_yarp ( )
default

Member Function Documentation

◆ attach()

bool FrameTransformSet_nws_yarp::attach ( yarp::dev::PolyDriver driver)
overridevirtual

Attach to another object.

Parameters
driverthe polydriver that you want to attach to.
Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 111 of file FrameTransformSet_nws_yarp.cpp.

◆ clearAllRPC()

bool FrameTransformSet_nws_yarp::clearAllRPC ( )
overridevirtual

Reimplemented from FrameTransformStorageSetRPC.

Definition at line 98 of file FrameTransformSet_nws_yarp.cpp.

◆ close()

bool FrameTransformSet_nws_yarp::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 45 of file FrameTransformSet_nws_yarp.cpp.

◆ deleteTransformRPC()

bool FrameTransformSet_nws_yarp::deleteTransformRPC ( const std::string &  src,
const std::string &  dst 
)
overridevirtual

Reimplemented from FrameTransformStorageSetRPC.

Definition at line 86 of file FrameTransformSet_nws_yarp.cpp.

◆ detach()

bool FrameTransformSet_nws_yarp::detach ( )
overridevirtual

Detach the object (you must have first called attach).

Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 54 of file FrameTransformSet_nws_yarp.cpp.

◆ open()

bool FrameTransformSet_nws_yarp::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 24 of file FrameTransformSet_nws_yarp.cpp.

◆ setTransformRPC()

bool FrameTransformSet_nws_yarp::setTransformRPC ( const yarp::math::FrameTransform transform)
overridevirtual

Reimplemented from FrameTransformStorageSetRPC.

Definition at line 61 of file FrameTransformSet_nws_yarp.cpp.

◆ setTransformsRPC()

bool FrameTransformSet_nws_yarp::setTransformsRPC ( const std::vector< yarp::math::FrameTransform > &  transforms)
overridevirtual

Reimplemented from FrameTransformStorageSetRPC.

Definition at line 74 of file FrameTransformSet_nws_yarp.cpp.


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