geometry_msgs::msg::Point32类 参考

This class represents the structure Point32 defined by the user in the IDL file.这个类表示用户在IDL（接口定义语言）文件中定义的 Point32 结构体， 更多...

#include <Point32.h>

geometry_msgs::msg::Point32 的协作图:

Public 成员函数
eProsima_user_DllExport void	deserialize (eprosima::fastcdr::Cdr &cdr)
eProsima_user_DllExport bool	operator!= (const Point32 &x) const
eProsima_user_DllExport Point32 &	operator= (const Point32 &x)
eProsima_user_DllExport Point32 &	operator= (Point32 &&x) noexcept
eProsima_user_DllExport bool	operator== (const Point32 &x) const
eProsima_user_DllExport	Point32 ()
eProsima_user_DllExport	Point32 (const Point32 &x)
eProsima_user_DllExport	Point32 (Point32 &&x) noexcept
eProsima_user_DllExport void	serialize (eprosima::fastcdr::Cdr &cdr) const
eProsima_user_DllExport void	serializeKey (eprosima::fastcdr::Cdr &cdr) const
eProsima_user_DllExport float &	x ()
	此函数返回成员变量 x（即 m_x）的引用，外部可通过该引用获取和修改 x 坐标的值，提供了一种可读写的方式来访问 x 坐标，方便外部根据需要修改其值
eProsima_user_DllExport float	x () const
	此函数返回成员变量 x（即 m_x）的值，提供了一种只读的方式来获取 x 坐标的值，保障了数据的安全性，避免外部误修改
eProsima_user_DllExport void	x (float _x)
	此函数用于设置成员变量 x（即 m_x）的值，传入新的 float 类型值进行赋值，提供了一种外部修改 Point32 对象中 x 坐标值的方式
eProsima_user_DllExport float &	y ()
	此函数返回成员变量 y（即 m_y）的引用，外部可通过该引用获取和修改 y 坐标的值，便于外部按需改变该坐标值
eProsima_user_DllExport float	y () const
	此函数返回成员变量 y（即 m_y）的值，提供了一种只读的方式来获取 y 坐标的值，用于外部获取该坐标信息但不修改
eProsima_user_DllExport void	y (float _y)
	此函数用于设置成员变量 y（即 m_y）的值，传入新的 float 类型值进行赋值，方便外部更新 y 坐标的值
eProsima_user_DllExport float &	z ()
	此函数返回成员变量 z（即 m_z）的引用，外部可通过该引用获取和修改 z 坐标的值，方便外部操作该坐标
eProsima_user_DllExport float	z () const
eProsima_user_DllExport void	z (float _z)
	此函数用于设置成员变量 z（即 m_z）的值，传入新的 float 类型值进行赋值，用于更新 z 坐标的值
eProsima_user_DllExport	~Point32 ()

静态 Public 成员函数
static eProsima_user_DllExport size_t	getCdrSerializedSize (const geometry_msgs::msg::Point32 &data, size_t current_alignment=0)
static eProsima_user_DllExport size_t	getKeyMaxCdrSerializedSize (size_t current_alignment=0)
static eProsima_user_DllExport size_t	getMaxCdrSerializedSize (size_t current_alignment=0)
static eProsima_user_DllExport bool	isKeyDefined ()

Private 属性
float	m_x
float	m_y
float	m_z

详细描述

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

这个类表示用户在IDL（接口定义语言）文件中定义的 Point32 结构体，

在文件 Point32.h 第 92 行定义.

构造及析构函数说明

Point32() [1/3]

geometry_msgs::msg::Point32::Point32

(

)

默认构造函数，用于创建一个 Point32 类的默认初始化对象

在文件 Point32.cpp 第 47 行定义.

引用了 m_x, m_y , 以及 m_z.

~Point32()

geometry_msgs::msg::Point32::~Point32

(

)

默认析构函数，用于在对象生命周期结束时进行资源清理等操作

在文件 Point32.cpp 第 58 行定义.

Point32() [2/3]

geometry_msgs::msg::Point32::Point32

(

const Point32 &

x

)

拷贝构造函数，用于从另一个已存在的 Point32 对象创建一个新的相同副本，参数 x 是要拷贝的那个 Point32 对象的引用

在文件 Point32.cpp 第 63 行定义.

引用了 m_x, m_y , 以及 m_z.

Point32() [3/3]

geometry_msgs::msg::Point32::Point32 ( Point32 && x )

noexcept

移动构造函数，用于高效地“窃取”另一个 Point32 对象的资源来初始化新对象，参数 x 是要移动资源的那个 Point32 对象的引用， 它通常比拷贝构造函数更高效，适用于临时对象等情况

在文件 Point32.cpp 第 72 行定义.

成员函数说明

deserialize()

void geometry_msgs::msg::Point32::deserialize

(

eprosima::fastcdr::Cdr &

cdr

)

使用CDR序列化方式对对象进行反序列化的函数，参数 cdr 是用于执行CDR反序列化操作的对象，从给定的CDR格式数据中还原出 Point32 对象， 比如从接收到的网络数据或者存储的数据中恢复出对应的对象实例

在文件 Point32.cpp 第 151 行定义.

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

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

getCdrSerializedSize()

size_t geometry_msgs::msg::Point32::getCdrSerializedSize ( const geometry_msgs::msg::Point32 & data, size_t current_alignment = 0 )

static

根据缓冲区对齐情况，返回给定数据的序列化大小的函数，参数 data 是要计算序列化大小的数据（这里是 Point32 类型的对象）， current_alignment 是当前缓冲区的对齐方式，返回值就是对应的数据序列化后的大小，用于准确知道存储或传输该数据实际需要的空间

在文件 Point32.cpp 第 125 行定义.

引用了 current_alignment , 以及 initial_alignment.

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

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

getKeyMaxCdrSerializedSize()

size_t geometry_msgs::msg::Point32::getKeyMaxCdrSerializedSize ( size_t current_alignment = 0 )

static

根据缓冲区对齐情况，返回对象的键（Key）的最大序列化大小的函数，参数 current_alignment 是当前缓冲区的对齐方式， 返回值就是对应的键的最大序列化大小，在涉及到以键值对形式处理对象等场景中会用到，比如在某些存储或查找操作中确定键的空间需求

在文件 Point32.cpp 第 244 行定义.

引用了 current_alignment , 以及 geometry_msgs_msg_Point32_max_key_cdr_typesize.

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

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

getMaxCdrSerializedSize()

size_t geometry_msgs::msg::Point32::getMaxCdrSerializedSize ( size_t current_alignment = 0 )

static

根据缓冲区对齐情况，返回一个对象最大序列化大小的函数，参数 current_alignment 是当前缓冲区的对齐方式， 返回值就是对应的最大序列化大小，用于确定存储或传输该对象时所需的最大空间等情况

在文件 Point32.cpp 第 117 行定义.

引用了 current_alignment , 以及 geometry_msgs_msg_Point32_max_cdr_typesize.

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

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

isKeyDefined()

bool geometry_msgs::msg::Point32::isKeyDefined ( )

static

判断该类型是否已经定义了键（Key）的函数，如果已经定义则返回 true，否则返回 false，用于在相关操作前检查键是否存在

在文件 Point32.cpp 第 252 行定义.

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

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

operator!=()

bool geometry_msgs::msg::Point32::operator!=

(

const Point32 &

x

)

const

不等比较运算符重载，用于比较当前 Point32 对象和另一个 Point32 对象是否不相等，参数 x 是要与之比较的那个 Point32 对象

在文件 Point32.cpp 第 110 行定义.

operator=() [1/2]

geometry_msgs::msg::Point32 & geometry_msgs::msg::Point32::operator=

(

const Point32 &

x

)

拷贝赋值运算符重载，用于将一个 Point32 对象的值复制到另一个已存在的 Point32 对象中，参数 x 是提供值的那个 Point32 对象的引用

在文件 Point32.cpp 第 81 行定义.

引用了 m_x, m_y , 以及 m_z.

operator=() [2/2]

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

noexcept

移动赋值运算符重载，用于将一个 Point32 对象的资源移动（转移）到另一个已存在的 Point32 对象中，参数 x 是提供资源的那个 Point32 对象的引用

在文件 Point32.cpp 第 92 行定义.

引用了 m_x.

operator==()

bool geometry_msgs::msg::Point32::operator==

(

const Point32 &

x

)

const

相等比较运算符重载，用于比较当前 Point32 对象和另一个 Point32 对象是否相等，参数 x 是要与之比较的那个 Point32 对象

在文件 Point32.cpp 第 103 行定义.

引用了 m_x, m_y , 以及 m_z.

serialize()

void geometry_msgs::msg::Point32::serialize

(

eprosima::fastcdr::Cdr &

cdr

)

const

使用CDR序列化方式对对象进行序列化的函数，参数 cdr 是用于执行CDR序列化操作的对象，将当前 Point32 对象按照CDR格式进行序列化， 以便进行数据传输、存储等后续操作

在文件 Point32.cpp 第 142 行定义.

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

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

serializeKey()

void geometry_msgs::msg::Point32::serializeKey

(

eprosima::fastcdr::Cdr &

cdr

)

const

使用CDR序列化方式对对象的键成员进行序列化的函数，参数 cdr 是用于执行CDR序列化操作的对象，将当前 Point32 对象中与键相关的成员按照CDR格式进行序列化， 比如在一些需要单独处理键的场景中使用

在文件 Point32.cpp 第 258 行定义.

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

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

x() [1/3]

float & geometry_msgs::msg::Point32::x

(

)

此函数返回成员变量 x（即 m_x）的引用，外部可通过该引用获取和修改 x 坐标的值，提供了一种可读写的方式来访问 x 坐标，方便外部根据需要修改其值

返回成员变量 x 的引用的函数，通过返回引用可以直接对成员 x 进行修改等操作

返回

成员变量 x 的引用。

在文件 Point32.cpp 第 182 行定义.

x() [2/3]

float geometry_msgs::msg::Point32::x

(

)

const

此函数返回成员变量 x（即 m_x）的值，提供了一种只读的方式来获取 x 坐标的值，保障了数据的安全性，避免外部误修改

获取成员变量 x 的值的函数，返回成员 x 当前存储的值

返回

成员变量 x 的值。

在文件 Point32.cpp 第 173 行定义.

x() [3/3]

void geometry_msgs::msg::Point32::x

(

float

_x

)

此函数用于设置成员变量 x（即 m_x）的值，传入新的 float 类型值进行赋值，提供了一种外部修改 Point32 对象中 x 坐标值的方式

设置成员变量 x 的值的函数，参数 _x 是要设置给成员 x 的新值

参数

_x	要设置给成员变量 x 的新值。

在文件 Point32.cpp 第 163 行定义.

y() [1/3]

float & geometry_msgs::msg::Point32::y

(

)

此函数返回成员变量 y（即 m_y）的引用，外部可通过该引用获取和修改 y 坐标的值，便于外部按需改变该坐标值

返回成员变量 y 的引用的函数，通过返回引用可以直接对成员 y 进行修改等操作

返回

成员变量 y 的引用。

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

y() [2/3]

float geometry_msgs::msg::Point32::y

(

)

const

此函数返回成员变量 y（即 m_y）的值，提供了一种只读的方式来获取 y 坐标的值，用于外部获取该坐标信息但不修改

此函数返回成员变量 z（即 m_z）的值，提供了一种只读的方式来获取 z 坐标的值，供外部获取该坐标信息

获取成员变量 y 的值的函数，返回成员 y 当前存储的值

返回

成员变量 y 的值。

成员变量 z 的值。

在文件 Point32.cpp 第 201 行定义.

y() [3/3]

void geometry_msgs::msg::Point32::y

(

float

_y

)

此函数用于设置成员变量 y（即 m_y）的值，传入新的 float 类型值进行赋值，方便外部更新 y 坐标的值

设置成员变量 y 的值的函数，参数 _y 是要设置给成员 y 的新值

参数

_y	要设置给成员变量 y 的新值。

在文件 Point32.cpp 第 191 行定义.

z() [1/3]

float & geometry_msgs::msg::Point32::z

(

)

此函数返回成员变量 z（即 m_z）的引用，外部可通过该引用获取和修改 z 坐标的值，方便外部操作该坐标

返回成员变量 z 的引用的函数，通过返回引用可以直接对成员 z 进行修改等操作

返回

成员变量 z 的引用。

在文件 Point32.cpp 第 238 行定义.

z() [2/3]

eProsima_user_DllExport float geometry_msgs::msg::Point32::z

(

)

const

获取成员变量 z 的值的函数，返回成员 z 当前存储的值

z() [3/3]

void geometry_msgs::msg::Point32::z

(

float

_z

)

此函数用于设置成员变量 z（即 m_z）的值，传入新的 float 类型值进行赋值，用于更新 z 坐标的值

设置成员变量 z 的值的函数，参数 _z 是要设置给成员 z 的新值

参数

_z	要设置给成员变量 z 的新值。

在文件 Point32.cpp 第 219 行定义.

类成员变量说明

m_x

float geometry_msgs::msg::Point32::m_x

private

在文件 Point32.h 第 217 行定义.

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

m_y

float geometry_msgs::msg::Point32::m_y

private

在文件 Point32.h 第 219 行定义.

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

m_z

float geometry_msgs::msg::Point32::m_z

private

在文件 Point32.h 第 221 行定义.

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

---

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

• Point32.h
• Point32.cpp