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

#include <TF2Error.h>

Collaboration diagram for tf2_msgs::msg::TF2Error:

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

eProsima_user_DllExport void	error (uint8_t _error)
	This function sets a value in member error. More...

eProsima_user_DllExport uint8_t	error () const
	This function returns the value of member error. More...

eProsima_user_DllExport uint8_t &	error ()
	This function returns a reference to member error. More...

eProsima_user_DllExport void	error_string (const std::string &_error_string)
	This function copies the value in member error_string. More...

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

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

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

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

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

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

eProsima_user_DllExport bool	operator== (const TF2Error &x) const
	Comparison operator. 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	TF2Error ()
	Default constructor. More...

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

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

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

Static Public Member Functions
static eProsima_user_DllExport size_t	getCdrSerializedSize (const tf2_msgs::msg::TF2Error &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
uint8_t	m_error

std::string	m_error_string

Detailed Description

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

Definition at line 78 of file TF2Error.h.

Constructor & Destructor Documentation

◆ TF2Error() [1/3]

tf2_msgs::msg::TF2Error::TF2Error ( )

Default constructor.

Definition at line 40 of file TF2Error.cpp.

◆ ~TF2Error()

tf2_msgs::msg::TF2Error::~TF2Error ( )

Default destructor.

Definition at line 48 of file TF2Error.cpp.

◆ TF2Error() [2/3]

tf2_msgs::msg::TF2Error::TF2Error ( const TF2Error & x )

Copy constructor.

Parameters

x	Reference to the object tf2_msgs::msg::TF2Error that will be copied.

Definition at line 52 of file TF2Error.cpp.

References m_error, and m_error_string.

◆ TF2Error() [3/3]

tf2_msgs::msg::TF2Error::TF2Error ( TF2Error && x )

noexcept

Move constructor.

Parameters

x	Reference to the object tf2_msgs::msg::TF2Error that will be copied.

Definition at line 59 of file TF2Error.cpp.

Member Function Documentation

◆ deserialize()

void tf2_msgs::msg::TF2Error::deserialize ( eprosima::fastcdr::Cdr & cdr )

This function deserializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 121 of file TF2Error.cpp.

Referenced by tf2_msgs::msg::TF2ErrorPubSubType::deserialize().

Here is the caller graph for this function:

◆ error() [1/3]

void tf2_msgs::msg::TF2Error::error ( uint8_t _error )

This function sets a value in member error.

Parameters

_error New value for member error

Definition at line 132 of file TF2Error.cpp.

◆ error() [2/3]

uint8_t tf2_msgs::msg::TF2Error::error ( ) const

This function returns the value of member error.

Returns: Value of member error

Definition at line 142 of file TF2Error.cpp.

◆ error() [3/3]

uint8_t & tf2_msgs::msg::TF2Error::error ( )

This function returns a reference to member error.

Returns: Reference to member error

Definition at line 151 of file TF2Error.cpp.

◆ error_string() [1/4]

void tf2_msgs::msg::TF2Error::error_string ( const std::string & _error_string )

This function copies the value in member error_string.

Parameters

_error_string New value to be copied in member error_string

Definition at line 160 of file TF2Error.cpp.

Referenced by getCdrSerializedSize().

Here is the caller graph for this function:

◆ error_string() [2/4]

void tf2_msgs::msg::TF2Error::error_string ( std::string && _error_string )

This function moves the value in member error_string.

Parameters

_error_string New value to be moved in member error_string

Definition at line 170 of file TF2Error.cpp.

◆ error_string() [3/4]

const std::string & tf2_msgs::msg::TF2Error::error_string ( ) const

This function returns a constant reference to member error_string.

Returns: Constant reference to member error_string

Definition at line 180 of file TF2Error.cpp.

◆ error_string() [4/4]

std::string & tf2_msgs::msg::TF2Error::error_string ( )

This function returns a reference to member error_string.

Returns: Reference to member error_string

Definition at line 189 of file TF2Error.cpp.

◆ getCdrSerializedSize()

size_t tf2_msgs::msg::TF2Error::getCdrSerializedSize	(	const tf2_msgs::msg::TF2Error &	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 103 of file TF2Error.cpp.

References error_string().

Referenced by tf2_msgs::msg::TF2ErrorPubSubType::getSerializedSizeProvider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKeyMaxCdrSerializedSize()

size_t tf2_msgs::msg::TF2Error::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 195 of file TF2Error.cpp.

References tf2_msgs_msg_TF2Error_max_key_cdr_typesize.

Referenced by tf2_msgs::msg::TF2ErrorPubSubType::getKey(), and tf2_msgs::msg::TF2ErrorPubSubType::TF2ErrorPubSubType().

Here is the caller graph for this function:

◆ getMaxCdrSerializedSize()

size_t tf2_msgs::msg::TF2Error::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 96 of file TF2Error.cpp.

References tf2_msgs_msg_TF2Error_max_cdr_typesize.

Referenced by tf2_msgs::msg::TF2ErrorPubSubType::TF2ErrorPubSubType().

Here is the caller graph for this function:

◆ isKeyDefined()

bool tf2_msgs::msg::TF2Error::isKeyDefined ( )

static

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

Definition at line 202 of file TF2Error.cpp.

Referenced by tf2_msgs::msg::TF2ErrorPubSubType::TF2ErrorPubSubType().

Here is the caller graph for this function:

◆ operator!=()

bool tf2_msgs::msg::TF2Error::operator!= ( const TF2Error & x ) const

Comparison operator.

Parameters

x	tf2_msgs::msg::TF2Error object to compare.

Definition at line 90 of file TF2Error.cpp.

◆ operator=() [1/2]

tf2_msgs::msg::TF2Error & tf2_msgs::msg::TF2Error::operator= ( const TF2Error & x )

Copy assignment.

Parameters

x	Reference to the object tf2_msgs::msg::TF2Error that will be copied.

Definition at line 66 of file TF2Error.cpp.

References m_error, and m_error_string.

◆ operator=() [2/2]

tf2_msgs::msg::TF2Error & tf2_msgs::msg::TF2Error::operator= ( TF2Error && x )

noexcept

Move assignment.

Parameters

x	Reference to the object tf2_msgs::msg::TF2Error that will be copied.

Definition at line 75 of file TF2Error.cpp.

References m_error.

◆ operator==()

bool tf2_msgs::msg::TF2Error::operator== ( const TF2Error & x ) const

Comparison operator.

Parameters

x	tf2_msgs::msg::TF2Error object to compare.

Definition at line 84 of file TF2Error.cpp.

References m_error, and m_error_string.

◆ serialize()

void tf2_msgs::msg::TF2Error::serialize ( eprosima::fastcdr::Cdr & cdr ) const

This function serializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 114 of file TF2Error.cpp.

Referenced by tf2_msgs::msg::TF2ErrorPubSubType::serialize().

Here is the caller graph for this function:

◆ serializeKey()

void tf2_msgs::msg::TF2Error::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 207 of file TF2Error.cpp.

Referenced by tf2_msgs::msg::TF2ErrorPubSubType::getKey().

Here is the caller graph for this function:

Member Data Documentation

◆ m_error

uint8_t tf2_msgs::msg::TF2Error::m_error

private

Definition at line 234 of file TF2Error.h.

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

◆ m_error_string

std::string tf2_msgs::msg::TF2Error::m_error_string

private

Definition at line 235 of file TF2Error.h.

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

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

◆ TF2Error() [1/3]

◆ ~TF2Error()

◆ TF2Error() [2/3]

◆ TF2Error() [3/3]

Member Function Documentation

◆ deserialize()

◆ error() [1/3]

◆ error() [2/3]

◆ error() [3/3]

◆ error_string() [1/4]

◆ error_string() [2/4]

◆ error_string() [3/4]

◆ error_string() [4/4]

◆ getCdrSerializedSize()

◆ getKeyMaxCdrSerializedSize()

◆ getMaxCdrSerializedSize()

◆ isKeyDefined()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ serialize()

◆ serializeKey()

Member Data Documentation

◆ m_error

◆ m_error_string