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

#include <Twist.h>

Collaboration diagram for geometry_msgs::msg::Twist:

Public Member Functions
eProsima_user_DllExport void	angular (const geometry_msgs::msg::Vector3 &_angular)
	This function copies the value in member angular. More...

eProsima_user_DllExport void	angular (geometry_msgs::msg::Vector3 &&_angular)
	This function moves the value in member angular. More...

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

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

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

eProsima_user_DllExport void	linear (const geometry_msgs::msg::Vector3 &_linear)
	This function copies the value in member linear. More...

eProsima_user_DllExport void	linear (geometry_msgs::msg::Vector3 &&_linear)
	This function moves the value in member linear. More...

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static eProsima_user_DllExport size_t	getCdrSerializedSize (const geometry_msgs::msg::Twist &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
geometry_msgs::msg::Vector3	m_angular

geometry_msgs::msg::Vector3	m_linear

Detailed Description

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

Definition at line 72 of file Twist.h.

Constructor & Destructor Documentation

◆ Twist() [1/3]

geometry_msgs::msg::Twist::Twist ( )

Default constructor.

Definition at line 42 of file Twist.cpp.

◆ ~Twist()

geometry_msgs::msg::Twist::~Twist ( )

Default destructor.

Definition at line 46 of file Twist.cpp.

◆ Twist() [2/3]

geometry_msgs::msg::Twist::Twist ( const Twist & x )

Copy constructor.

Parameters

x	Reference to the object geometry_msgs::msg::Twist that will be copied.

Definition at line 50 of file Twist.cpp.

References m_angular, and m_linear.

◆ Twist() [3/3]

geometry_msgs::msg::Twist::Twist ( Twist && x )

noexcept

Move constructor.

Parameters

x	Reference to the object geometry_msgs::msg::Twist that will be copied.

Definition at line 57 of file Twist.cpp.

Member Function Documentation

◆ angular() [1/4]

void geometry_msgs::msg::Twist::angular ( const geometry_msgs::msg::Vector3 & _angular )

This function copies the value in member angular.

Parameters

_angular New value to be copied in member angular

Definition at line 168 of file Twist.cpp.

Referenced by getCdrSerializedSize().

Here is the caller graph for this function:

◆ angular() [2/4]

void geometry_msgs::msg::Twist::angular ( geometry_msgs::msg::Vector3 && _angular )

This function moves the value in member angular.

Parameters

_angular New value to be moved in member angular

Definition at line 178 of file Twist.cpp.

◆ angular() [3/4]

const geometry_msgs::msg::Vector3 & geometry_msgs::msg::Twist::angular ( ) const

This function returns a constant reference to member angular.

Returns: Constant reference to member angular

Definition at line 188 of file Twist.cpp.

◆ angular() [4/4]

geometry_msgs::msg::Vector3 & geometry_msgs::msg::Twist::angular ( )

This function returns a reference to member angular.

Returns: Reference to member angular

Definition at line 197 of file Twist.cpp.

◆ deserialize()

void geometry_msgs::msg::Twist::deserialize ( eprosima::fastcdr::Cdr & cdr )

This function deserializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 119 of file Twist.cpp.

Referenced by geometry_msgs::msg::TwistPubSubType::deserialize().

Here is the caller graph for this function:

◆ getCdrSerializedSize()

size_t geometry_msgs::msg::Twist::getCdrSerializedSize	(	const geometry_msgs::msg::Twist &	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 101 of file Twist.cpp.

References angular(), geometry_msgs::msg::Vector3::getCdrSerializedSize(), and linear().

Referenced by geometry_msgs::msg::TwistWithCovariance::getCdrSerializedSize(), and geometry_msgs::msg::TwistPubSubType::getSerializedSizeProvider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKeyMaxCdrSerializedSize()

size_t geometry_msgs::msg::Twist::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 203 of file Twist.cpp.

References geometry_msgs_msg_Twist_max_key_cdr_typesize.

Referenced by geometry_msgs::msg::TwistPubSubType::getKey(), and geometry_msgs::msg::TwistPubSubType::TwistPubSubType().

Here is the caller graph for this function:

◆ getMaxCdrSerializedSize()

size_t geometry_msgs::msg::Twist::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 94 of file Twist.cpp.

References geometry_msgs_msg_Twist_max_cdr_typesize.

Referenced by geometry_msgs::msg::TwistPubSubType::TwistPubSubType().

Here is the caller graph for this function:

◆ isKeyDefined()

bool geometry_msgs::msg::Twist::isKeyDefined ( )

static

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

Definition at line 210 of file Twist.cpp.

Referenced by geometry_msgs::msg::TwistPubSubType::TwistPubSubType().

Here is the caller graph for this function:

◆ linear() [1/4]

void geometry_msgs::msg::Twist::linear ( const geometry_msgs::msg::Vector3 & _linear )

This function copies the value in member linear.

Parameters

_linear New value to be copied in member linear

Definition at line 130 of file Twist.cpp.

Referenced by getCdrSerializedSize().

Here is the caller graph for this function:

◆ linear() [2/4]

void geometry_msgs::msg::Twist::linear ( geometry_msgs::msg::Vector3 && _linear )

This function moves the value in member linear.

Parameters

_linear New value to be moved in member linear

Definition at line 140 of file Twist.cpp.

◆ linear() [3/4]

const geometry_msgs::msg::Vector3 & geometry_msgs::msg::Twist::linear ( ) const

This function returns a constant reference to member linear.

Returns: Constant reference to member linear

Definition at line 150 of file Twist.cpp.

◆ linear() [4/4]

geometry_msgs::msg::Vector3 & geometry_msgs::msg::Twist::linear ( )

This function returns a reference to member linear.

Returns: Reference to member linear

Definition at line 159 of file Twist.cpp.

◆ operator!=()

bool geometry_msgs::msg::Twist::operator!= ( const Twist & x ) const

Comparison operator.

Parameters

x	geometry_msgs::msg::Twist object to compare.

Definition at line 88 of file Twist.cpp.

◆ operator=() [1/2]

geometry_msgs::msg::Twist & geometry_msgs::msg::Twist::operator= ( const Twist & x )

Copy assignment.

Parameters

x	Reference to the object geometry_msgs::msg::Twist that will be copied.

Definition at line 64 of file Twist.cpp.

References m_angular, and m_linear.

◆ operator=() [2/2]

geometry_msgs::msg::Twist & geometry_msgs::msg::Twist::operator= ( Twist && x )

noexcept

Move assignment.

Parameters

x	Reference to the object geometry_msgs::msg::Twist that will be copied.

Definition at line 73 of file Twist.cpp.

◆ operator==()

bool geometry_msgs::msg::Twist::operator== ( const Twist & x ) const

Comparison operator.

Parameters

x	geometry_msgs::msg::Twist object to compare.

Definition at line 82 of file Twist.cpp.

References m_angular, and m_linear.

◆ serialize()

void geometry_msgs::msg::Twist::serialize ( eprosima::fastcdr::Cdr & cdr ) const

This function serializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 112 of file Twist.cpp.

Referenced by geometry_msgs::msg::TwistPubSubType::serialize().

Here is the caller graph for this function:

◆ serializeKey()

void geometry_msgs::msg::Twist::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 215 of file Twist.cpp.

Referenced by geometry_msgs::msg::TwistPubSubType::getKey().

Here is the caller graph for this function:

Member Data Documentation

◆ m_angular

geometry_msgs::msg::Vector3 geometry_msgs::msg::Twist::m_angular

private

Definition at line 235 of file Twist.h.

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

◆ m_linear

geometry_msgs::msg::Vector3 geometry_msgs::msg::Twist::m_linear

private

Definition at line 234 of file Twist.h.

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

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

◆ Twist() [1/3]

◆ ~Twist()

◆ Twist() [2/3]

◆ Twist() [3/3]

Member Function Documentation

◆ angular() [1/4]

◆ angular() [2/4]

◆ angular() [3/4]

◆ angular() [4/4]

◆ deserialize()

◆ getCdrSerializedSize()

◆ getKeyMaxCdrSerializedSize()

◆ getMaxCdrSerializedSize()

◆ isKeyDefined()

◆ linear() [1/4]

◆ linear() [2/4]

◆ linear() [3/4]

◆ linear() [4/4]

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ serialize()

◆ serializeKey()

Member Data Documentation

◆ m_angular

◆ m_linear