std_msgs::msg::String类 参考

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

#include <String.h>

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

Public 成员函数
eProsima_user_DllExport std::string &	data ()
	This function returns a reference to member data
eProsima_user_DllExport const std::string &	data () const
	This function returns a constant reference to member data
eProsima_user_DllExport void	data (const std::string &_data)
	This function copies the value in member data
eProsima_user_DllExport void	data (std::string &&_data)
	This function moves the value in member data
eProsima_user_DllExport void	deserialize (eprosima::fastcdr::Cdr &cdr)
	This function deserializes an object using CDR serialization.
eProsima_user_DllExport bool	operator!= (const String &x) const
	Comparison operator.
eProsima_user_DllExport String &	operator= (const String &x)
	Copy assignment.
eProsima_user_DllExport String &	operator= (String &&x) noexcept
	Move assignment.
eProsima_user_DllExport bool	operator== (const String &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	String ()
	Default constructor.
eProsima_user_DllExport	String (const String &x)
	Copy constructor.
eProsima_user_DllExport	String (String &&x) noexcept
	Move constructor.
eProsima_user_DllExport	~String ()
	Default destructor.

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

详细描述

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

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

构造及析构函数说明

String() [1/3]

std_msgs::msg::String::String

(

)

Default constructor.

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

引用了 m_data.

~String()

std_msgs::msg::String::~String

(

)

Default destructor.

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

String() [2/3]

std_msgs::msg::String::String

(

const String &

x

)

Copy constructor.

参数

x	Reference to the object std_msgs::msg::String that will be copied.

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

引用了 m_data.

String() [3/3]

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

noexcept

Move constructor.

参数

x	Reference to the object std_msgs::msg::String that will be copied.

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

成员函数说明

data() [1/4]

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

(

)

This function returns a reference to member data

返回

Reference to member data

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

data() [2/4]

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

(

)

const

This function returns a constant reference to member data

返回

Constant reference to member data

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

data() [3/4]

void std_msgs::msg::String::data

(

const std::string &

_data

)

This function copies the value in member data

参数

_data

New value to be copied in member data

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

被这些函数引用 getCdrSerializedSize().

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

data() [4/4]

void std_msgs::msg::String::data

(

std::string &&

_data

)

This function moves the value in member data

参数

_data

New value to be moved in member data

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

deserialize()

void std_msgs::msg::String::deserialize

(

eprosima::fastcdr::Cdr &

cdr

)

This function deserializes an object using CDR serialization.

参数

cdr	CDR serialization object.

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

被这些函数引用 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

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.

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

引用了 data().

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

函数调用图:

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

getKeyMaxCdrSerializedSize()

size_t std_msgs::msg::String::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.

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

引用了 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

This function returns the maximum serialized size of an object depending on the buffer alignment.

参数

current_alignment

Buffer alignment.

返回

Maximum serialized size.

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

引用了 std_msgs_msg_String_max_cdr_typesize.

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

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

isKeyDefined()

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

static

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

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

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

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

operator!=()

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

(

const String &

x

)

const

Comparison operator.

参数

x	std_msgs::msg::String object to compare.

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

operator=() [1/2]

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

(

const String &

x

)

Copy assignment.

参数

x	Reference to the object std_msgs::msg::String that will be copied.

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

引用了 m_data.

operator=() [2/2]

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

noexcept

Move assignment.

参数

x	Reference to the object std_msgs::msg::String that will be copied.

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

operator==()

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

(

const String &

x

)

const

Comparison operator.

参数

x	std_msgs::msg::String object to compare.

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

引用了 m_data.

serialize()

void std_msgs::msg::String::serialize

(

eprosima::fastcdr::Cdr &

cdr

)

const

This function serializes an object using CDR serialization.

参数

cdr	CDR serialization object.

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

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

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

serializeKey()

void std_msgs::msg::String::serializeKey

(

eprosima::fastcdr::Cdr &

cdr

)

const

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

参数

cdr	CDR serialization object.

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

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

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

类成员变量说明

m_data

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

private

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

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

---

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

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