This class represents the structure Odometry defined by the user in the IDL file. More...

#include <Odometry.h>

Collaboration diagram for nav_msgs::msg::Odometry:

Public Member Functions
eProsima_user_DllExport void	child_frame_id (const std::string &_child_frame_id)
	This function copies the value in member child_frame_id. More...

eProsima_user_DllExport void	child_frame_id (std::string &&_child_frame_id)
	This function moves the value in member child_frame_id. More...

eProsima_user_DllExport const std::string &	child_frame_id () const
	This function returns a constant reference to member child_frame_id. More...

eProsima_user_DllExport std::string &	child_frame_id ()
	This function returns a reference to member child_frame_id. More...

eProsima_user_DllExport void	deserialize (eprosima::fastcdr::Cdr &cdr)
	This function deserializes an object using CDR serialization. More...

eProsima_user_DllExport void	header (const std_msgs::msg::Header &_header)
	This function copies the value in member header. More...

eProsima_user_DllExport void	header (std_msgs::msg::Header &&_header)
	This function moves the value in member header. More...

eProsima_user_DllExport const std_msgs::msg::Header &	header () const
	This function returns a constant reference to member header. More...

eProsima_user_DllExport std_msgs::msg::Header &	header ()
	This function returns a reference to member header. More...

eProsima_user_DllExport	Odometry ()
	Default constructor. More...

eProsima_user_DllExport	Odometry (const Odometry &x)
	Copy constructor. More...

eProsima_user_DllExport	Odometry (Odometry &&x) noexcept
	Move constructor. More...

eProsima_user_DllExport bool	operator!= (const Odometry &x) const
	Comparison operator. More...

eProsima_user_DllExport Odometry &	operator= (const Odometry &x)
	Copy assignment. More...

eProsima_user_DllExport Odometry &	operator= (Odometry &&x) noexcept
	Move assignment. More...

eProsima_user_DllExport bool	operator== (const Odometry &x) const
	Comparison operator. More...

eProsima_user_DllExport void	pose (const geometry_msgs::msg::PoseWithCovariance &_pose)
	This function copies the value in member pose. More...

eProsima_user_DllExport void	pose (geometry_msgs::msg::PoseWithCovariance &&_pose)
	This function moves the value in member pose. More...

eProsima_user_DllExport const geometry_msgs::msg::PoseWithCovariance &	pose () const
	This function returns a constant reference to member pose. More...

eProsima_user_DllExport geometry_msgs::msg::PoseWithCovariance &	pose ()
	This function returns a reference to member pose. More...

eProsima_user_DllExport void	serialize (eprosima::fastcdr::Cdr &cdr) const
	This function serializes an object using CDR serialization. More...

eProsima_user_DllExport void	serializeKey (eprosima::fastcdr::Cdr &cdr) const
	This function serializes the key members of an object using CDR serialization. More...

eProsima_user_DllExport void	twist (const geometry_msgs::msg::TwistWithCovariance &_twist)
	This function copies the value in member twist. More...

eProsima_user_DllExport void	twist (geometry_msgs::msg::TwistWithCovariance &&_twist)
	This function moves the value in member twist. More...

eProsima_user_DllExport const geometry_msgs::msg::TwistWithCovariance &	twist () const
	This function returns a constant reference to member twist. More...

eProsima_user_DllExport geometry_msgs::msg::TwistWithCovariance &	twist ()
	This function returns a reference to member twist. More...

eProsima_user_DllExport	~Odometry ()
	Default destructor. More...

Static Public Member Functions
static eProsima_user_DllExport size_t	getCdrSerializedSize (const nav_msgs::msg::Odometry &data, size_t current_alignment=0)
	This function returns the serialized size of a data depending on the buffer alignment. More...

static eProsima_user_DllExport size_t	getKeyMaxCdrSerializedSize (size_t current_alignment=0)
	This function returns the maximum serialized size of the Key of an object depending on the buffer alignment. More...

static eProsima_user_DllExport size_t	getMaxCdrSerializedSize (size_t current_alignment=0)
	This function returns the maximum serialized size of an object depending on the buffer alignment. More...

static eProsima_user_DllExport bool	isKeyDefined ()
	This function tells you if the Key has been defined for this type. More...

Private Attributes
std::string	m_child_frame_id

std_msgs::msg::Header	m_header

geometry_msgs::msg::PoseWithCovariance	m_pose

geometry_msgs::msg::TwistWithCovariance	m_twist

Detailed Description

This class represents the structure Odometry defined by the user in the IDL file.

Definition at line 74 of file Odometry.h.

Constructor & Destructor Documentation

◆ Odometry() [1/3]

nav_msgs::msg::Odometry::Odometry ( )

Default constructor.

Definition at line 58 of file Odometry.cpp.

◆ ~Odometry()

nav_msgs::msg::Odometry::~Odometry ( )

Default destructor.

Definition at line 69 of file Odometry.cpp.

◆ Odometry() [2/3]

nav_msgs::msg::Odometry::Odometry ( const Odometry & x )

Copy constructor.

Parameters

x	Reference to the object nav_msgs::msg::Odometry that will be copied.

Definition at line 73 of file Odometry.cpp.

References m_child_frame_id, m_header, m_pose, and m_twist.

◆ Odometry() [3/3]

nav_msgs::msg::Odometry::Odometry ( Odometry && x )

noexcept

Move constructor.

Parameters

x	Reference to the object nav_msgs::msg::Odometry that will be copied.

Definition at line 82 of file Odometry.cpp.

Member Function Documentation

◆ child_frame_id() [1/4]

void nav_msgs::msg::Odometry::child_frame_id ( const std::string & _child_frame_id )

This function copies the value in member child_frame_id.

Parameters

_child_frame_id New value to be copied in member child_frame_id

Definition at line 204 of file Odometry.cpp.

Referenced by getCdrSerializedSize().

Here is the caller graph for this function:

◆ child_frame_id() [2/4]

void nav_msgs::msg::Odometry::child_frame_id ( std::string && _child_frame_id )

This function moves the value in member child_frame_id.

Parameters

_child_frame_id New value to be moved in member child_frame_id

Definition at line 214 of file Odometry.cpp.

◆ child_frame_id() [3/4]

const std::string & nav_msgs::msg::Odometry::child_frame_id ( ) const

This function returns a constant reference to member child_frame_id.

Returns: Constant reference to member child_frame_id

Definition at line 224 of file Odometry.cpp.

◆ child_frame_id() [4/4]

std::string & nav_msgs::msg::Odometry::child_frame_id ( )

This function returns a reference to member child_frame_id.

Returns: Reference to member child_frame_id

Definition at line 233 of file Odometry.cpp.

◆ deserialize()

void nav_msgs::msg::Odometry::deserialize ( eprosima::fastcdr::Cdr & cdr )

This function deserializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 154 of file Odometry.cpp.

Referenced by nav_msgs::msg::OdometryPubSubType::deserialize().

Here is the caller graph for this function:

◆ getCdrSerializedSize()

size_t nav_msgs::msg::Odometry::getCdrSerializedSize	(	const nav_msgs::msg::Odometry &	data,
		size_t	current_alignment = `0`
	)

static

This function returns the serialized size of a data depending on the buffer alignment.

Parameters

data	Data which is calculated its serialized size.
current_alignment	Buffer alignment.

Returns: Serialized size.

Definition at line 132 of file Odometry.cpp.

References child_frame_id(), std_msgs::msg::Header::getCdrSerializedSize(), geometry_msgs::msg::PoseWithCovariance::getCdrSerializedSize(), geometry_msgs::msg::TwistWithCovariance::getCdrSerializedSize(), header(), pose(), and twist().

Referenced by nav_msgs::msg::OdometryPubSubType::getSerializedSizeProvider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKeyMaxCdrSerializedSize()

size_t nav_msgs::msg::Odometry::getKeyMaxCdrSerializedSize ( size_t current_alignment = 0 )

static

This function returns the maximum serialized size of the Key of an object depending on the buffer alignment.

Parameters

current_alignment Buffer alignment.

Returns: Maximum serialized size.

Definition at line 314 of file Odometry.cpp.

References nav_msgs_msg_Odometry_max_key_cdr_typesize.

Referenced by nav_msgs::msg::OdometryPubSubType::getKey(), and nav_msgs::msg::OdometryPubSubType::OdometryPubSubType().

Here is the caller graph for this function:

◆ getMaxCdrSerializedSize()

size_t nav_msgs::msg::Odometry::getMaxCdrSerializedSize ( size_t current_alignment = 0 )

static

This function returns the maximum serialized size of an object depending on the buffer alignment.

Parameters

current_alignment Buffer alignment.

Returns: Maximum serialized size.

Definition at line 125 of file Odometry.cpp.

References nav_msgs_msg_Odometry_max_cdr_typesize.

Referenced by nav_msgs::msg::OdometryPubSubType::OdometryPubSubType().

Here is the caller graph for this function:

◆ header() [1/4]

void nav_msgs::msg::Odometry::header ( const std_msgs::msg::Header & _header )

This function copies the value in member header.

Parameters

_header New value to be copied in member header

Definition at line 167 of file Odometry.cpp.

Referenced by getCdrSerializedSize().

Here is the caller graph for this function:

◆ header() [2/4]

void nav_msgs::msg::Odometry::header ( std_msgs::msg::Header && _header )

This function moves the value in member header.

Parameters

_header New value to be moved in member header

Definition at line 177 of file Odometry.cpp.

◆ header() [3/4]

const std_msgs::msg::Header & nav_msgs::msg::Odometry::header ( ) const

This function returns a constant reference to member header.

Returns: Constant reference to member header

Definition at line 187 of file Odometry.cpp.

◆ header() [4/4]

std_msgs::msg::Header & nav_msgs::msg::Odometry::header ( )

This function returns a reference to member header.

Returns: Reference to member header

Definition at line 196 of file Odometry.cpp.

◆ isKeyDefined()

bool nav_msgs::msg::Odometry::isKeyDefined ( )

static

This function tells you if the Key has been defined for this type.

Definition at line 321 of file Odometry.cpp.

Referenced by nav_msgs::msg::OdometryPubSubType::OdometryPubSubType().

Here is the caller graph for this function:

◆ operator!=()

bool nav_msgs::msg::Odometry::operator!= ( const Odometry & x ) const

Comparison operator.

Parameters

x	nav_msgs::msg::Odometry object to compare.

Definition at line 119 of file Odometry.cpp.

◆ operator=() [1/2]

nav_msgs::msg::Odometry & nav_msgs::msg::Odometry::operator= ( const Odometry & x )

Copy assignment.

Parameters

x	Reference to the object nav_msgs::msg::Odometry that will be copied.

Definition at line 91 of file Odometry.cpp.

References m_child_frame_id, m_header, m_pose, and m_twist.

◆ operator=() [2/2]

nav_msgs::msg::Odometry & nav_msgs::msg::Odometry::operator= ( Odometry && x )

noexcept

Move assignment.

Parameters

x	Reference to the object nav_msgs::msg::Odometry that will be copied.

Definition at line 102 of file Odometry.cpp.

◆ operator==()

bool nav_msgs::msg::Odometry::operator== ( const Odometry & x ) const

Comparison operator.

Parameters

x	nav_msgs::msg::Odometry object to compare.

Definition at line 113 of file Odometry.cpp.

References m_child_frame_id, m_header, m_pose, and m_twist.

◆ pose() [1/4]

void nav_msgs::msg::Odometry::pose ( const geometry_msgs::msg::PoseWithCovariance & _pose )

This function copies the value in member pose.

Parameters

_pose New value to be copied in member pose

Definition at line 242 of file Odometry.cpp.

Referenced by getCdrSerializedSize().

Here is the caller graph for this function:

◆ pose() [2/4]

void nav_msgs::msg::Odometry::pose ( geometry_msgs::msg::PoseWithCovariance && _pose )

This function moves the value in member pose.

Parameters

_pose New value to be moved in member pose

Definition at line 252 of file Odometry.cpp.

◆ pose() [3/4]

const geometry_msgs::msg::PoseWithCovariance & nav_msgs::msg::Odometry::pose ( ) const

This function returns a constant reference to member pose.

Returns: Constant reference to member pose

Definition at line 262 of file Odometry.cpp.

◆ pose() [4/4]

geometry_msgs::msg::PoseWithCovariance & nav_msgs::msg::Odometry::pose ( )

This function returns a reference to member pose.

Returns: Reference to member pose

Definition at line 271 of file Odometry.cpp.

◆ serialize()

void nav_msgs::msg::Odometry::serialize ( eprosima::fastcdr::Cdr & cdr ) const

This function serializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 145 of file Odometry.cpp.

Referenced by nav_msgs::msg::OdometryPubSubType::serialize().

Here is the caller graph for this function:

◆ serializeKey()

void nav_msgs::msg::Odometry::serializeKey ( eprosima::fastcdr::Cdr & cdr ) const

This function serializes the key members of an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 326 of file Odometry.cpp.

Referenced by nav_msgs::msg::OdometryPubSubType::getKey().

Here is the caller graph for this function:

◆ twist() [1/4]

void nav_msgs::msg::Odometry::twist ( const geometry_msgs::msg::TwistWithCovariance & _twist )

This function copies the value in member twist.

Parameters

_twist New value to be copied in member twist

Definition at line 280 of file Odometry.cpp.

Referenced by getCdrSerializedSize().

Here is the caller graph for this function:

◆ twist() [2/4]

void nav_msgs::msg::Odometry::twist ( geometry_msgs::msg::TwistWithCovariance && _twist )

This function moves the value in member twist.

Parameters

_twist New value to be moved in member twist

Definition at line 290 of file Odometry.cpp.

◆ twist() [3/4]

const geometry_msgs::msg::TwistWithCovariance & nav_msgs::msg::Odometry::twist ( ) const

This function returns a constant reference to member twist.

Returns: Constant reference to member twist

Definition at line 300 of file Odometry.cpp.

◆ twist() [4/4]

geometry_msgs::msg::TwistWithCovariance & nav_msgs::msg::Odometry::twist ( )

This function returns a reference to member twist.

Returns: Reference to member twist

Definition at line 309 of file Odometry.cpp.

Member Data Documentation

◆ m_child_frame_id

std::string nav_msgs::msg::Odometry::m_child_frame_id

private

Definition at line 287 of file Odometry.h.

Referenced by Odometry(), operator=(), and operator==().

◆ m_header

std_msgs::msg::Header nav_msgs::msg::Odometry::m_header

private

Definition at line 286 of file Odometry.h.

Referenced by Odometry(), operator=(), and operator==().

◆ m_pose

geometry_msgs::msg::PoseWithCovariance nav_msgs::msg::Odometry::m_pose

private

Definition at line 288 of file Odometry.h.

Referenced by Odometry(), operator=(), and operator==().

◆ m_twist

geometry_msgs::msg::TwistWithCovariance nav_msgs::msg::Odometry::m_twist

private

Definition at line 289 of file Odometry.h.

Referenced by Odometry(), operator=(), and operator==().

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Odometry() [1/3]

◆ ~Odometry()

◆ Odometry() [2/3]

◆ Odometry() [3/3]

Member Function Documentation

◆ child_frame_id() [1/4]

◆ child_frame_id() [2/4]

◆ child_frame_id() [3/4]

◆ child_frame_id() [4/4]

◆ deserialize()

◆ getCdrSerializedSize()

◆ getKeyMaxCdrSerializedSize()

◆ getMaxCdrSerializedSize()

◆ header() [1/4]

◆ header() [2/4]

◆ header() [3/4]

◆ header() [4/4]

◆ isKeyDefined()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ pose() [1/4]

◆ pose() [2/4]

◆ pose() [3/4]

◆ pose() [4/4]

◆ serialize()

◆ serializeKey()

◆ twist() [1/4]

◆ twist() [2/4]

◆ twist() [3/4]

◆ twist() [4/4]

Member Data Documentation

◆ m_child_frame_id

◆ m_header

◆ m_pose

◆ m_twist