geometry_msgs::msg::Point类 参考

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

#include <Point.h>

geometry_msgs::msg::Point 的协作图:

Public 成员函数
eProsima_user_DllExport void	deserialize (eprosima::fastcdr::Cdr &cdr)
	This function deserializes an object using CDR serialization. 更多...
eProsima_user_DllExport bool	operator!= (const Point &x) const
	Comparison operator. 更多...
eProsima_user_DllExport Point &	operator= (const Point &x)
	Copy assignment. 更多...
eProsima_user_DllExport Point &	operator= (Point &&x) noexcept
	Move assignment. 更多...
eProsima_user_DllExport bool	operator== (const Point &x) const
	Comparison operator. 更多...
eProsima_user_DllExport	Point ()
	Default constructor. 更多...
eProsima_user_DllExport	Point (const Point &x)
	Copy constructor. 更多...
eProsima_user_DllExport	Point (Point &&x) noexcept
	Move constructor. 更多...
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 double &	x ()
	This function returns a reference to member x 更多...
eProsima_user_DllExport double	x () const
	This function returns the value of member x 更多...
eProsima_user_DllExport void	x (double _x)
	This function sets a value in member x 更多...
eProsima_user_DllExport double &	y ()
	This function returns a reference to member y 更多...
eProsima_user_DllExport double	y () const
	This function returns the value of member y 更多...
eProsima_user_DllExport void	y (double _y)
	This function sets a value in member y 更多...
eProsima_user_DllExport double &	z ()
	This function returns a reference to member z 更多...
eProsima_user_DllExport double	z () const
	This function returns the value of member z 更多...
eProsima_user_DllExport void	z (double _z)
	This function sets a value in member z 更多...
eProsima_user_DllExport	~Point ()
	Default destructor. 更多...

静态 Public 成员函数
static eProsima_user_DllExport size_t	getCdrSerializedSize (const geometry_msgs::msg::Point &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 属性
double	m_x
double	m_y
double	m_z

详细描述

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

在文件 Point.h 第 70 行定义.

构造及析构函数说明

Point() [1/3]

geometry_msgs::msg::Point::Point

(

)

Default constructor.

在文件 Point.cpp 第 40 行定义.

引用了 m_x, m_y , 以及 m_z.

~Point()

geometry_msgs::msg::Point::~Point

(

)

Default destructor.

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

Point() [2/3]

geometry_msgs::msg::Point::Point

(

const Point &

x

)

Copy constructor.

参数

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

在文件 Point.cpp 第 54 行定义.

引用了 m_x, m_y , 以及 m_z.

Point() [3/3]

geometry_msgs::msg::Point::Point ( Point &&  x )

noexcept

Move constructor.

参数

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

在文件 Point.cpp 第 62 行定义.

成员函数说明

deserialize()

void geometry_msgs::msg::Point::deserialize

(

eprosima::fastcdr::Cdr &

cdr

)

This function deserializes an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 Point.cpp 第 137 行定义.

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

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

getCdrSerializedSize()

size_t geometry_msgs::msg::Point::getCdrSerializedSize ( const geometry_msgs::msg::Point &  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.

在文件 Point.cpp 第 116 行定义.

引用了 current_alignment , 以及 initial_alignment.

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

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

getKeyMaxCdrSerializedSize()

size_t geometry_msgs::msg::Point::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.

在文件 Point.cpp 第 229 行定义.

引用了 current_alignment , 以及 geometry_msgs_msg_Point_max_key_cdr_typesize.

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

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

getMaxCdrSerializedSize()

size_t geometry_msgs::msg::Point::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.

在文件 Point.cpp 第 109 行定义.

引用了 current_alignment , 以及 geometry_msgs_msg_Point_max_cdr_typesize.

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

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

isKeyDefined()

bool geometry_msgs::msg::Point::isKeyDefined ( )

static

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

在文件 Point.cpp 第 236 行定义.

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

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

operator!=()

bool geometry_msgs::msg::Point::operator!=

(

const Point &

x

)

const

Comparison operator.

参数

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

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

operator=() [1/2]

geometry_msgs::msg::Point & geometry_msgs::msg::Point::operator=

(

const Point &

x

)

Copy assignment.

参数

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

在文件 Point.cpp 第 70 行定义.

引用了 m_x, m_y , 以及 m_z.

operator=() [2/2]

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

noexcept

Move assignment.

参数

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

在文件 Point.cpp 第 80 行定义.

引用了 m_x.

operator==()

bool geometry_msgs::msg::Point::operator==

(

const Point &

x

)

const

Comparison operator.

参数

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

在文件 Point.cpp 第 97 行定义.

引用了 m_x, m_y , 以及 m_z.

serialize()

void geometry_msgs::msg::Point::serialize

(

eprosima::fastcdr::Cdr &

cdr

)

const

This function serializes an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 Point.cpp 第 129 行定义.

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

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

serializeKey()

void geometry_msgs::msg::Point::serializeKey

(

eprosima::fastcdr::Cdr &

cdr

)

const

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

参数

cdr	CDR serialization object.

在文件 Point.cpp 第 241 行定义.

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

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

x() [1/3]

double & geometry_msgs::msg::Point::x

(

)

This function returns a reference to member x

返回

Reference to member x

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

x() [2/3]

double geometry_msgs::msg::Point::x

(

)

const

This function returns the value of member x

返回

Value of member x

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

x() [3/3]

void geometry_msgs::msg::Point::x

(

double

_x

)

This function sets a value in member x

参数

_x	New value for member x

在文件 Point.cpp 第 149 行定义.

y() [1/3]

double & geometry_msgs::msg::Point::y

(

)

This function returns a reference to member y

返回

Reference to member y

在文件 Point.cpp 第 196 行定义.

y() [2/3]

double geometry_msgs::msg::Point::y

(

)

const

This function returns the value of member y

返回

Value of member y

在文件 Point.cpp 第 187 行定义.

y() [3/3]

void geometry_msgs::msg::Point::y

(

double

_y

)

This function sets a value in member y

参数

_y	New value for member y

在文件 Point.cpp 第 177 行定义.

z() [1/3]

double & geometry_msgs::msg::Point::z

(

)

This function returns a reference to member z

返回

Reference to member z

在文件 Point.cpp 第 224 行定义.

z() [2/3]

double geometry_msgs::msg::Point::z

(

)

const

This function returns the value of member z

返回

Value of member z

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

z() [3/3]

void geometry_msgs::msg::Point::z

(

double

_z

)

This function sets a value in member z

参数

_z	New value for member z

在文件 Point.cpp 第 205 行定义.

类成员变量说明

m_x

double geometry_msgs::msg::Point::m_x

private

在文件 Point.h 第 238 行定义.

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

m_y

double geometry_msgs::msg::Point::m_y

private

在文件 Point.h 第 239 行定义.

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

m_z

double geometry_msgs::msg::Point::m_z

private

在文件 Point.h 第 240 行定义.

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

---

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

• Point.h
• Point.cpp