yarp::dev::FrameTransformContainer Class Reference

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 <yarp/dev/FrameTransformContainer.h>

Inheritance diagram for yarp::dev::FrameTransformContainer:

Classes
struct	Iterator

Public Member Functions
Iterator	begin ()
Iterator	end ()
	FrameTransformContainer ()
	~FrameTransformContainer ()
yarp::dev::ReturnValue	setTransforms (const std::vector< yarp::math::FrameTransform > &transforms) override
	Save some frame transforms in a storage.
yarp::dev::ReturnValue	setTransform (const yarp::math::FrameTransform &transform) override
	Save a frame transform in a storage.
yarp::dev::ReturnValue	getTransforms (std::vector< yarp::math::FrameTransform > &transforms) const override
	Obtains all frame transforms saved in a storage.
yarp::dev::ReturnValue	deleteTransform (std::string t1, std::string t2) override
	Delete a single transform in the storage.
yarp::dev::ReturnValue	clearAll () override
	Delete all transforms in a storage.
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
bool	m_verbose_debug = false
std::string	m_name

Protected Member Functions
void	invalidateTransform (yarp::math::FrameTransform &trf)

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 32 of file FrameTransformContainer.h.

Constructor & Destructor Documentation

FrameTransformContainer()

yarp::dev::FrameTransformContainer::FrameTransformContainer ( )

inline

Definition at line 105 of file FrameTransformContainer.h.

~FrameTransformContainer()

yarp::dev::FrameTransformContainer::~FrameTransformContainer ( )

inline

Definition at line 106 of file FrameTransformContainer.h.

Member Function Documentation

begin()

Iterator yarp::dev::FrameTransformContainer::begin ( )

inline

Definition at line 81 of file FrameTransformContainer.h.

checkAndRemoveExpired() [1/2]

bool FrameTransformContainer::checkAndRemoveExpired

(

)

Definition at line 160 of file FrameTransformContainer.cpp.

checkAndRemoveExpired() [2/2]

bool FrameTransformContainer::checkAndRemoveExpired

(

)

const

Definition at line 186 of file FrameTransformContainer.cpp.

clearAll()

ReturnValue FrameTransformContainer::clearAll ( )

overridevirtual

Delete all transforms in a storage.

Returns

a ReturnValue, convertible to true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 150 of file FrameTransformContainer.cpp.

deleteTransform()

ReturnValue FrameTransformContainer::deleteTransform ( std::string  src, std::string  dst  )

overridevirtual

Delete a single transform in the storage.

Parameters

src	the source of frame transform to delete
dst	the destination of frame transform to delete

Returns

a ReturnValue, convertible to true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 92 of file FrameTransformContainer.cpp.

end()

Iterator yarp::dev::FrameTransformContainer::end ( )

inline

Definition at line 86 of file FrameTransformContainer.h.

getTransforms()

ReturnValue FrameTransformContainer::getTransforms ( std::vector< yarp::math::FrameTransform > &  transforms ) const

overridevirtual

Obtains all frame transforms saved in a storage.

Parameters

transforms

the returned list of frame transforms

Returns

a ReturnValue, convertible to true/false

Implements yarp::dev::IFrameTransformStorageGet.

Definition at line 38 of file FrameTransformContainer.cpp.

invalidateTransform()

void FrameTransformContainer::invalidateTransform ( yarp::math::FrameTransform &  trf )

protected

Definition at line 25 of file FrameTransformContainer.cpp.

setTransform()

ReturnValue FrameTransformContainer::setTransform ( const yarp::math::FrameTransform &  transform )

overridevirtual

Save a frame transform in a storage.

Parameters

transforms

the transform to be stored

Returns

a ReturnValue, convertible to true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 54 of file FrameTransformContainer.cpp.

setTransforms()

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

overridevirtual

Save some frame transforms in a storage.

Parameters

transforms

the list of transforms to be stored

Returns

a ReturnValue, convertible to true/false

Implements yarp::dev::IFrameTransformStorageSet.

Definition at line 45 of file FrameTransformContainer.cpp.

size()

bool FrameTransformContainer::size

(

size_t &

size

)

const

Definition at line 191 of file FrameTransformContainer.cpp.

Member Data Documentation

m_name

std::string yarp::dev::FrameTransformContainer::m_name

Definition at line 102 of file FrameTransformContainer.h.

m_timeout

double yarp::dev::FrameTransformContainer::m_timeout = 0.2

Definition at line 100 of file FrameTransformContainer.h.

m_transforms

ContainerType yarp::dev::FrameTransformContainer::m_transforms

protected

Definition at line 92 of file FrameTransformContainer.h.

m_trf_mutex

std::recursive_mutex yarp::dev::FrameTransformContainer::m_trf_mutex

mutable

Definition at line 96 of file FrameTransformContainer.h.

m_verbose_debug

bool yarp::dev::FrameTransformContainer::m_verbose_debug = false

Definition at line 101 of file FrameTransformContainer.h.

---

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

• src/libYARP_dev/src/yarp/dev/FrameTransformContainer.h
• src/libYARP_dev/src/yarp/dev/FrameTransformContainer.cpp