awviz_common::TfFrame Class Reference

A class to represent a TF frame information. More...

#include <tf_tree.hpp>

Public Member Functions
	TfFrame (const std::string &id, const std::string &parent)
	Construct a new object.
	TfFrame (const std::string &id)
	Construct a new object with empty string for parent.
const std::string &	id () const
	Return own frame ID.
const std::string &	parent () const
	Return the parent frame ID.
bool	is_root () const
	Indicate whether the frame is root by checking if parent_ is empty.
bool	is_static () const
	Return whether the tf frame is static or not.
bool	operator== (const TfFrame &other) const
	Compare with an another object.

Detailed Description

A class to represent a TF frame information.

Constructor & Destructor Documentation

TfFrame() [1/2]

awviz_common::TfFrame::TfFrame ( const std::string &  id, const std::string &  parent  )

inline

Construct a new object.

Parameters

id	Frame ID.
parent	Parent frame ID.

TfFrame() [2/2]

awviz_common::TfFrame::TfFrame ( const std::string &  id )

inlineexplicit

Construct a new object with empty string for parent.

Parameters

id

Frame ID.

Member Function Documentation

id()

const std::string & awviz_common::TfFrame::id ( ) const

inline

Return own frame ID.

Returns

Own frame ID.

is_root()

bool awviz_common::TfFrame::is_root ( ) const

inline

Indicate whether the frame is root by checking if parent_ is empty.

Returns

Return true, if the parent_ is empty.

is_static()

bool awviz_common::TfFrame::is_static ( ) const

inline

Return whether the tf frame is static or not.

Note

Currently, this returns true if the parent id is not TF_ROOT or is empty.

Returns

Return true if the parent id is not TF_ROOT or is empty.

operator==()

bool awviz_common::TfFrame::operator== ( const TfFrame &  other ) const

inline

Compare with an another object.

Parameters

other

Another object.

Returns

Return true if both id and parent are the same.

parent()

const std::string & awviz_common::TfFrame::parent ( ) const

inline

Return the parent frame ID.

Returns

Parent frame ID.

---

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

• awviz_common/include/awviz_common/transformation/tf_tree.hpp