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

#include <Twist.h>

geometry_msgs::msg::Twist 的协作图:

Public 成员函数
eProsima_user_DllExport geometry_msgs::msg::Vector3 &	angular ()
	This function returns a reference to member angular

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

eProsima_user_DllExport void	angular (const geometry_msgs::msg::Vector3 &_angular)
	This function copies the value in member angular

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

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

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

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

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

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

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

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

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

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

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

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

eProsima_user_DllExport	Twist ()
	Default constructor.

eProsima_user_DllExport	Twist (const Twist &x)
	Copy constructor.

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

eProsima_user_DllExport	~Twist ()
	Default destructor.

静态 Public 成员函数
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.

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.

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.

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

Private 属性
geometry_msgs::msg::Vector3	m_angular

geometry_msgs::msg::Vector3	m_linear

详细描述

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

在文件 Twist.h 第 72 行定义.

构造及析构函数说明

◆ Twist() [1/3]

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

Default constructor.

在文件 Twist.cpp 第 42 行定义.

◆ ~Twist()

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

Default destructor.

在文件 Twist.cpp 第 46 行定义.

◆ Twist() [2/3]

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

Copy constructor.

参数

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

在文件 Twist.cpp 第 50 行定义.

引用了 m_angular , 以及 m_linear.

◆ Twist() [3/3]

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

noexcept

Move constructor.

参数

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

在文件 Twist.cpp 第 57 行定义.

成员函数说明

◆ angular() [1/4]

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

This function returns a reference to member angular

返回: Reference to member angular

在文件 Twist.cpp 第 197 行定义.

◆ angular() [2/4]

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

This function returns a constant reference to member angular

返回: Constant reference to member angular

在文件 Twist.cpp 第 188 行定义.

◆ angular() [3/4]

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

This function copies the value in member angular

参数

_angular New value to be copied in member angular

在文件 Twist.cpp 第 168 行定义.

被这些函数引用 getCdrSerializedSize().

这是这个函数的调用关系图:

◆ angular() [4/4]

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

This function moves the value in member angular

参数

_angular New value to be moved in member angular

在文件 Twist.cpp 第 178 行定义.

◆ deserialize()

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

This function deserializes an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 Twist.cpp 第 119 行定义.

被这些函数引用 geometry_msgs::msg::TwistPubSubType::deserialize().

这是这个函数的调用关系图:

◆ 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.

参数

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

返回: Serialized size.

在文件 Twist.cpp 第 101 行定义.

引用了 angular(), geometry_msgs::msg::Vector3::getCdrSerializedSize() , 以及 linear().

被这些函数引用 geometry_msgs::msg::TwistWithCovariance::getCdrSerializedSize() , 以及 geometry_msgs::msg::TwistPubSubType::getSerializedSizeProvider().

函数调用图:

这是这个函数的调用关系图:

◆ 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.

参数

current_alignment Buffer alignment.

返回: Maximum serialized size.

在文件 Twist.cpp 第 203 行定义.

引用了 geometry_msgs_msg_Twist_max_key_cdr_typesize.

被这些函数引用 geometry_msgs::msg::TwistPubSubType::getKey() , 以及 geometry_msgs::msg::TwistPubSubType::TwistPubSubType().

这是这个函数的调用关系图:

◆ 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.

参数

current_alignment Buffer alignment.

返回: Maximum serialized size.

在文件 Twist.cpp 第 94 行定义.

引用了 geometry_msgs_msg_Twist_max_cdr_typesize.

被这些函数引用 geometry_msgs::msg::TwistPubSubType::TwistPubSubType().

这是这个函数的调用关系图:

◆ isKeyDefined()

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

static

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

在文件 Twist.cpp 第 210 行定义.

被这些函数引用 geometry_msgs::msg::TwistPubSubType::TwistPubSubType().

这是这个函数的调用关系图:

◆ linear() [1/4]

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

This function returns a reference to member linear

返回: Reference to member linear

在文件 Twist.cpp 第 159 行定义.

◆ linear() [2/4]

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

This function returns a constant reference to member linear

返回: Constant reference to member linear

在文件 Twist.cpp 第 150 行定义.

◆ linear() [3/4]

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

This function copies the value in member linear

参数

_linear New value to be copied in member linear

在文件 Twist.cpp 第 130 行定义.

被这些函数引用 getCdrSerializedSize().

这是这个函数的调用关系图:

◆ linear() [4/4]

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

This function moves the value in member linear

参数

_linear New value to be moved in member linear

在文件 Twist.cpp 第 140 行定义.

◆ operator!=()

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

Comparison operator.

参数

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

在文件 Twist.cpp 第 88 行定义.

◆ operator=() [1/2]

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

Copy assignment.

参数

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

在文件 Twist.cpp 第 64 行定义.

引用了 m_angular , 以及 m_linear.

◆ operator=() [2/2]

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

noexcept

Move assignment.

参数

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

在文件 Twist.cpp 第 73 行定义.

◆ operator==()

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

Comparison operator.

参数

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

在文件 Twist.cpp 第 82 行定义.

引用了 m_angular , 以及 m_linear.

◆ serialize()

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

This function serializes an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 Twist.cpp 第 112 行定义.

被这些函数引用 geometry_msgs::msg::TwistPubSubType::serialize().

这是这个函数的调用关系图:

◆ serializeKey()

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

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

参数

cdr	CDR serialization object.

在文件 Twist.cpp 第 215 行定义.

被这些函数引用 geometry_msgs::msg::TwistPubSubType::getKey().

这是这个函数的调用关系图:

类成员变量说明

◆ m_angular

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

private

在文件 Twist.h 第 235 行定义.

被这些函数引用 operator=(), operator==() , 以及 Twist().

◆ m_linear

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

private

在文件 Twist.h 第 234 行定义.

被这些函数引用 operator=(), operator==() , 以及 Twist().

该类的文档由以下文件生成:

Public 成员函数

静态 Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ Twist() [1/3]

◆ ~Twist()

◆ Twist() [2/3]

◆ Twist() [3/3]

成员函数说明

◆ 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()

类成员变量说明

◆ m_angular

◆ m_linear