YARP
Yet Another Robot Platform
Classes | Public Member Functions | Public Attributes | Protected Attributes | List of all members
FrameTransformContainer Class Reference
yarp::dev YARP Devices » Device Implementations » Other Device Implementations

FrameTransformContainer: A class that contains a vector of frame transformations and exposes yarp::dev::IFrameTransformStorageSet and yarp::dev::IFrameTransformStorageGet interfaces in order to allow external access to it. More...

#include <frameTransformUtils/FrameTransformContainer.h>

+ Inheritance diagram for FrameTransformContainer:

Classes

struct  Iterator
 

Public Member Functions

Iterator begin ()
 
Iterator end ()
 
 FrameTransformContainer ()
 
 ~FrameTransformContainer ()
 
bool setTransforms (const std::vector< yarp::math::FrameTransform > &transforms) override
 Save some frame transforms in a storage. More...
 
bool setTransform (const yarp::math::FrameTransform &transform) override
 Save a frame transform in a storage. More...
 
bool getTransforms (std::vector< yarp::math::FrameTransform > &transforms) const override
 Obtains all frame transforms saved in a storage. More...
 
bool deleteTransform (std::string t1, std::string t2) override
 Delete a single transform in the storage. More...
 
bool clearAll () override
 Delete all transforms in a storage. More...
 
bool size (size_t &size) const
 
bool checkAndRemoveExpired ()
 
bool checkAndRemoveExpired () const
 
- Public Member Functions inherited from yarp::dev::IFrameTransformStorageSet
virtual ~IFrameTransformStorageSet ()
 
- Public Member Functions inherited from yarp::dev::IFrameTransformStorageGet
virtual ~IFrameTransformStorageGet ()
 

Public Attributes

std::recursive_mutex m_trf_mutex
 
double m_timeout = 0.2
 

Protected Attributes

ContainerType m_transforms
 

Detailed Description

FrameTransformContainer: A class that contains a vector of frame transformations and exposes yarp::dev::IFrameTransformStorageSet and yarp::dev::IFrameTransformStorageGet interfaces in order to allow external access to it.

Definition at line 28 of file FrameTransformContainer.h.

Constructor & Destructor Documentation

◆ FrameTransformContainer()

FrameTransformContainer::FrameTransformContainer ( )
inline

Definition at line 98 of file FrameTransformContainer.h.

◆ ~FrameTransformContainer()

FrameTransformContainer::~FrameTransformContainer ( )
inline

Definition at line 99 of file FrameTransformContainer.h.

Member Function Documentation

◆ begin()

Iterator FrameTransformContainer::begin ( )
inline

Definition at line 77 of file FrameTransformContainer.h.

◆ checkAndRemoveExpired() [1/2]

bool FrameTransformContainer::checkAndRemoveExpired ( )

Definition at line 154 of file FrameTransformContainer.cpp.

◆ checkAndRemoveExpired() [2/2]

bool FrameTransformContainer::checkAndRemoveExpired ( ) const

Definition at line 171 of file FrameTransformContainer.cpp.

◆ clearAll()

bool FrameTransformContainer::clearAll ( )
overridevirtual

Delete all transforms in a storage.

Returns
true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 144 of file FrameTransformContainer.cpp.

◆ deleteTransform()

bool FrameTransformContainer::deleteTransform ( std::string  src,
std::string  dst 
)
overridevirtual

Delete a single transform in the storage.

Parameters
srcthe source of frame transform to delete
dstthe destination of frame transform to delete
Returns
true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 86 of file FrameTransformContainer.cpp.

◆ end()

Iterator FrameTransformContainer::end ( )
inline

Definition at line 82 of file FrameTransformContainer.h.

◆ getTransforms()

bool FrameTransformContainer::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 32 of file FrameTransformContainer.cpp.

◆ setTransform()

bool FrameTransformContainer::setTransform ( const yarp::math::FrameTransform &  transform)
overridevirtual

Save a frame transform in a storage.

Parameters
transformsthe transform to be stored
Returns
true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 48 of file FrameTransformContainer.cpp.

◆ setTransforms()

bool FrameTransformContainer::setTransforms ( const std::vector< yarp::math::FrameTransform > &  transforms)
overridevirtual

Save some frame transforms in a storage.

Parameters
transformsthe list of transforms to be stored
Returns
true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 39 of file FrameTransformContainer.cpp.

◆ size()

bool FrameTransformContainer::size ( size_t &  size) const

Definition at line 176 of file FrameTransformContainer.cpp.

Member Data Documentation

◆ m_timeout

double FrameTransformContainer::m_timeout = 0.2

Definition at line 95 of file FrameTransformContainer.h.

◆ m_transforms

ContainerType FrameTransformContainer::m_transforms
protected

Definition at line 88 of file FrameTransformContainer.h.

◆ m_trf_mutex

std::recursive_mutex FrameTransformContainer::m_trf_mutex
mutable

Definition at line 91 of file FrameTransformContainer.h.

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