YARP
Yet Another Robot Platform
FrameTransformGetMultiplexer Class Reference

A multiplexer which collapses the output of many IFrameTransformStorageGet interfaces into one. More...

#include <frameTransformGet/FrameTransformGetMultiplexer.h>

+ Inheritance diagram for FrameTransformGetMultiplexer:

Public Member Functions

 FrameTransformGetMultiplexer ()=default
 
 FrameTransformGetMultiplexer (const FrameTransformGetMultiplexer &)=delete
 
 FrameTransformGetMultiplexer (FrameTransformGetMultiplexer &&)=delete
 
FrameTransformGetMultiplexeroperator= (const FrameTransformGetMultiplexer &)=delete
 
FrameTransformGetMultiplexeroperator= (FrameTransformGetMultiplexer &&)=delete
 
bool open (yarp::os::Searchable &config) override
 Device driver interface. More...
 
bool close () override
 Close the DeviceDriver. More...
 
bool attachAll (const yarp::dev::PolyDriverList &devices2attach) override
 Attach to a list of objects. More...
 
bool detachAll () override
 Detach the object (you must have first called attach). More...
 
bool getTransforms (std::vector< yarp::math::FrameTransform > &transforms) const override
 Obtains all frame transforms saved in a storage. More...
 
- 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
 
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 configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from yarp::dev::IFrameTransformStorageGet
virtual ~IFrameTransformStorageGet ()
 
- Public Member Functions inherited from yarp::dev::WrapperMultiple
 ~WrapperMultiple () override
 Destructor. More...
 
bool attach (PolyDriver *driver) final
 Attach to another object. More...
 
bool detach () 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

A multiplexer which collapses the output of many IFrameTransformStorageGet interfaces into one.

This device is a multiplexer of devices that implements the IFrameTransformStorageGet interface. It can be attached to multiple devices. When the function getTransforms is called, it returns a vector containing all the transforms taken from the attached devices. For further information see FrameTransform: start all the required devices needed for transforming frames.

Definition at line 23 of file FrameTransformGetMultiplexer.h.

Constructor & Destructor Documentation

◆ FrameTransformGetMultiplexer() [1/3]

FrameTransformGetMultiplexer::FrameTransformGetMultiplexer ( )
default

◆ FrameTransformGetMultiplexer() [2/3]

FrameTransformGetMultiplexer::FrameTransformGetMultiplexer ( const FrameTransformGetMultiplexer )
delete

◆ FrameTransformGetMultiplexer() [3/3]

FrameTransformGetMultiplexer::FrameTransformGetMultiplexer ( FrameTransformGetMultiplexer &&  )
delete

Member Function Documentation

◆ attachAll()

bool FrameTransformGetMultiplexer::attachAll ( const yarp::dev::PolyDriverList drivers)
overridevirtual

Attach to a list of objects.

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

Implements yarp::dev::IMultipleWrapper.

Definition at line 50 of file FrameTransformGetMultiplexer.cpp.

◆ close()

bool FrameTransformGetMultiplexer::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 42 of file FrameTransformGetMultiplexer.cpp.

◆ detachAll()

bool FrameTransformGetMultiplexer::detachAll ( )
overridevirtual

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

Returns
true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 35 of file FrameTransformGetMultiplexer.cpp.

◆ getTransforms()

bool FrameTransformGetMultiplexer::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 78 of file FrameTransformGetMultiplexer.cpp.

◆ open()

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

Device driver interface.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 24 of file FrameTransformGetMultiplexer.cpp.

◆ operator=() [1/2]

FrameTransformGetMultiplexer& FrameTransformGetMultiplexer::operator= ( const FrameTransformGetMultiplexer )
delete

◆ operator=() [2/2]

FrameTransformGetMultiplexer& FrameTransformGetMultiplexer::operator= ( FrameTransformGetMultiplexer &&  )
delete

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