std_msgs::msg::String类 参考

这个类表示用户在IDL文件中定义的结构体String。 更多...

#include <String.h>

std_msgs::msg::String 的协作图:

Public 成员函数
eProsima_user_DllExport std::string &	data ()
	这个函数返回成员数据的引用
eProsima_user_DllExport const std::string &	data () const
	这个函数返回成员数据的常量引用
eProsima_user_DllExport void	data (const std::string &_data)
	这个函数复制成员数据的值
eProsima_user_DllExport void	data (std::string &&_data)
	这个函数移动成员数据的值
eProsima_user_DllExport void	deserialize (eprosima::fastcdr::Cdr &cdr)
	这个函数使用CDR序列化反序列化对象。
eProsima_user_DllExport bool	operator!= (const String &x) const
	比较运算符。
eProsima_user_DllExport String &	operator= (const String &x)
	拷贝赋值运算符。
eProsima_user_DllExport String &	operator= (String &&x) noexcept
	移动赋值运算符。
eProsima_user_DllExport bool	operator== (const String &x) const
	比较运算符。
eProsima_user_DllExport void	serialize (eprosima::fastcdr::Cdr &cdr) const
	这个函数使用CDR序列化序列化对象。
eProsima_user_DllExport void	serializeKey (eprosima::fastcdr::Cdr &cdr) const
	这个函数使用CDR序列化序列化对象的键成员。
eProsima_user_DllExport	String ()
	默认构造函数。
eProsima_user_DllExport	String (const String &x)
	拷贝构造函数。
eProsima_user_DllExport	String (String &&x) noexcept
	移动构造函数。
eProsima_user_DllExport	~String ()
	默认析构函数。

静态 Public 成员函数
static eProsima_user_DllExport size_t	getCdrSerializedSize (const std_msgs::msg::String &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 属性
std::string	m_data

详细描述

这个类表示用户在IDL文件中定义的结构体String。

在文件 ros2/types/String.h 第 70 行定义.

构造及析构函数说明

String() [1/3]

std_msgs::msg::String::String

(

)

默认构造函数。

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

引用了 m_data.

~String()

std_msgs::msg::String::~String

(

)

默认析构函数。

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

String() [2/3]

std_msgs::msg::String::String

(

const String &

x

)

拷贝构造函数。

参数

x	将被拷贝的std_msgs::msg::String对象的引用。

在文件 String.cpp 第 52 行定义.

引用了 m_data.

String() [3/3]

std_msgs::msg::String::String ( String && x )

noexcept

移动构造函数。

参数

x	将被移动的std_msgs::msg::String对象的引用。

在文件 String.cpp 第 59 行定义.

成员函数说明

data() [1/4]

std::string & std_msgs::msg::String::data

(

)

这个函数返回成员数据的引用

此函数返回对成员数据的引用

返回

成员数据的引用

对成员数据的引用

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

data() [2/4]

const std::string & std_msgs::msg::String::data

(

)

const

这个函数返回成员数据的常量引用

此函数返回对成员数据的常量引用

返回

成员数据的常量引用

对成员数据的常量引用

在文件 String.cpp 第 154 行定义.

data() [3/4]

void std_msgs::msg::String::data

(

const std::string &

_data

)

这个函数复制成员数据的值

此函数将新值复制到成员数据中

参数

_data	成员数据的新值，将被复制。
_data	要复制到成员数据的新值

在文件 String.cpp 第 134 行定义.

被这些函数引用 getCdrSerializedSize().

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

data() [4/4]

void std_msgs::msg::String::data

(

std::string &&

_data

)

这个函数移动成员数据的值

此函数将新值移动到成员数据中

参数

_data	成员数据的新值，将被移动。
_data	要移动到成员数据的新值

在文件 String.cpp 第 144 行定义.

deserialize()

void std_msgs::msg::String::deserialize

(

eprosima::fastcdr::Cdr &

cdr

)

这个函数使用CDR序列化反序列化对象。

参数

cdr

CDR序列化对象。

在文件 String.cpp 第 124 行定义.

被这些函数引用 std_msgs::msg::StringPubSubType::deserialize().

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

getCdrSerializedSize()

size_t std_msgs::msg::String::getCdrSerializedSize ( const std_msgs::msg::String & data, size_t current_alignment = 0 )

static

这个函数返回数据的序列化大小 取决于缓冲区对齐。

参数

data	计算其序列化大小的数据。
current_alignment	缓冲区对齐。

返回

序列化大小。

在文件 String.cpp 第 106 行定义.

引用了 current_alignment, data() , 以及 initial_alignment.

被这些函数引用 std_msgs::msg::StringPubSubType::getSerializedSizeProvider().

函数调用图:

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

getKeyMaxCdrSerializedSize()

size_t std_msgs::msg::String::getKeyMaxCdrSerializedSize ( size_t current_alignment = 0 )

static

这个函数返回对象键的最大序列化大小 取决于缓冲区对齐。

参数

current_alignment

缓冲区对齐。

返回

最大序列化大小。

在文件 String.cpp 第 169 行定义.

引用了 current_alignment , 以及 std_msgs_msg_String_max_key_cdr_typesize.

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

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

getMaxCdrSerializedSize()

size_t std_msgs::msg::String::getMaxCdrSerializedSize ( size_t current_alignment = 0 )

static

这个函数返回对象的最大序列化大小 取决于缓冲区对齐。

参数

current_alignment

缓冲区对齐。

返回

最大序列化大小。

在文件 String.cpp 第 98 行定义.

引用了 current_alignment , 以及 std_msgs_msg_String_max_cdr_typesize.

被这些函数引用 std_msgs::msg::StringPubSubType::StringPubSubType().

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

isKeyDefined()

bool std_msgs::msg::String::isKeyDefined ( )

static

这个函数告诉你这个类型是否定义了键

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

被这些函数引用 std_msgs::msg::StringPubSubType::StringPubSubType().

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

operator!=()

bool std_msgs::msg::String::operator!=

(

const String &

x

)

const

比较运算符。

参数

x	要比较的std_msgs::msg::String对象。

在文件 String.cpp 第 91 行定义.

operator=() [1/2]

std_msgs::msg::String & std_msgs::msg::String::operator=

(

const String &

x

)

拷贝赋值运算符。

参数

x	将被拷贝的std_msgs::msg::String对象的引用。

在文件 String.cpp 第 66 行定义.

引用了 m_data.

operator=() [2/2]

std_msgs::msg::String & std_msgs::msg::String::operator= ( String && x )

noexcept

移动赋值运算符。

参数

x	将被移动的std_msgs::msg::String对象的引用。

在文件 String.cpp 第 75 行定义.

operator==()

bool std_msgs::msg::String::operator==

(

const String &

x

)

const

比较运算符。

参数

x	要比较的std_msgs::msg::String对象。

在文件 String.cpp 第 84 行定义.

引用了 m_data.

serialize()

void std_msgs::msg::String::serialize

(

eprosima::fastcdr::Cdr &

cdr

)

const

这个函数使用CDR序列化序列化对象。

参数

cdr

CDR序列化对象。

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

被这些函数引用 std_msgs::msg::StringPubSubType::serialize().

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

serializeKey()

void std_msgs::msg::String::serializeKey

(

eprosima::fastcdr::Cdr &

cdr

)

const

这个函数使用CDR序列化序列化对象的键成员。

参数

cdr

CDR序列化对象。

在文件 String.cpp 第 183 行定义.

被这些函数引用 std_msgs::msg::StringPubSubType::getKey().

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

类成员变量说明

m_data

std::string std_msgs::msg::String::m_data

private

在文件 ros2/types/String.h 第 208 行定义.

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

---

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

• ros2/types/String.h
• String.cpp