std_msgs::msg::Header类 参考

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

#include <Header.h>

std_msgs::msg::Header 的协作图:

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

静态 Public 成员函数
static eProsima_user_DllExport size_t	getCdrSerializedSize (const std_msgs::msg::Header &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_frame_id
builtin_interfaces::msg::Time	m_stamp

详细描述

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

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

构造及析构函数说明

Header() [1/3]

std_msgs::msg::Header::Header

(

)

Default constructor.

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

引用了 m_frame_id.

~Header()

std_msgs::msg::Header::~Header

(

)

Default destructor.

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

Header() [2/3]

std_msgs::msg::Header::Header

(

const Header &

x

)

Copy constructor.

参数

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

在文件 Header.cpp 第 51 行定义.

引用了 m_frame_id , 以及 m_stamp.

Header() [3/3]

std_msgs::msg::Header::Header ( Header && x )

noexcept

Move constructor.

参数

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

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

成员函数说明

deserialize()

void std_msgs::msg::Header::deserialize

(

eprosima::fastcdr::Cdr &

cdr

)

This function deserializes an object using CDR serialization.

参数

cdr	CDR serialization object.

在文件 Header.cpp 第 120 行定义.

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

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

frame_id() [1/4]

std::string & std_msgs::msg::Header::frame_id

(

)

This function returns a reference to member frame_id

返回

Reference to member frame_id

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

frame_id() [2/4]

const std::string & std_msgs::msg::Header::frame_id

(

)

const

This function returns a constant reference to member frame_id

返回

Constant reference to member frame_id

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

frame_id() [3/4]

void std_msgs::msg::Header::frame_id

(

const std::string &

_frame_id

)

This function copies the value in member frame_id

参数

_frame_id

New value to be copied in member frame_id

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

被这些函数引用 getCdrSerializedSize(), carla::ros2::CarlaDepthCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaDVSCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaISCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaNormalsCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaOpticalFlowCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaRGBCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaSSCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaGNSSPublisher::SetData(), carla::ros2::CarlaTransformPublisher::SetData(), carla::ros2::CarlaLineInvasionPublisher::SetData(), carla::ros2::CarlaIMUPublisher::SetData(), carla::ros2::CarlaRadarPublisher::SetData(), carla::ros2::CarlaDepthCameraPublisher::SetData(), carla::ros2::CarlaDVSCameraPublisher::SetData(), carla::ros2::CarlaISCameraPublisher::SetData(), carla::ros2::CarlaLidarPublisher::SetData(), carla::ros2::CarlaNormalsCameraPublisher::SetData(), carla::ros2::CarlaOpticalFlowCameraPublisher::SetData(), carla::ros2::CarlaSemanticLidarPublisher::SetData(), carla::ros2::CarlaSSCameraPublisher::SetData(), carla::ros2::CarlaCollisionPublisher::SetData() , 以及 carla::ros2::CarlaRGBCameraPublisher::SetImageData().

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

frame_id() [4/4]

void std_msgs::msg::Header::frame_id

(

std::string &&

_frame_id

)

This function moves the value in member frame_id

参数

_frame_id

New value to be moved in member frame_id

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

getCdrSerializedSize()

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

在文件 Header.cpp 第 102 行定义.

引用了 frame_id(), builtin_interfaces::msg::Time::getCdrSerializedSize() , 以及 stamp().

被这些函数引用 carla_msgs::msg::CarlaCollisionEvent::getCdrSerializedSize(), carla_msgs::msg::CarlaEgoVehicleControl::getCdrSerializedSize(), carla_msgs::msg::LaneInvasionEvent::getCdrSerializedSize(), geometry_msgs::msg::TransformStamped::getCdrSerializedSize(), nav_msgs::msg::Odometry::getCdrSerializedSize(), sensor_msgs::msg::CameraInfo::getCdrSerializedSize(), sensor_msgs::msg::Image::getCdrSerializedSize(), sensor_msgs::msg::Imu::getCdrSerializedSize(), sensor_msgs::msg::NavSatFix::getCdrSerializedSize(), sensor_msgs::msg::PointCloud2::getCdrSerializedSize() , 以及 std_msgs::msg::HeaderPubSubType::getSerializedSizeProvider().

函数调用图:

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

getKeyMaxCdrSerializedSize()

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

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

引用了 std_msgs_msg_Header_max_key_cdr_typesize.

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

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

getMaxCdrSerializedSize()

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

在文件 Header.cpp 第 95 行定义.

引用了 std_msgs_msg_Header_max_cdr_typesize.

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

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

isKeyDefined()

bool std_msgs::msg::Header::isKeyDefined ( )

static

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

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

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

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

operator!=()

bool std_msgs::msg::Header::operator!=

(

const Header &

x

)

const

Comparison operator.

参数

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

在文件 Header.cpp 第 89 行定义.

operator=() [1/2]

std_msgs::msg::Header & std_msgs::msg::Header::operator=

(

const Header &

x

)

Copy assignment.

参数

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

在文件 Header.cpp 第 65 行定义.

引用了 m_frame_id , 以及 m_stamp.

operator=() [2/2]

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

noexcept

Move assignment.

参数

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

在文件 Header.cpp 第 74 行定义.

operator==()

bool std_msgs::msg::Header::operator==

(

const Header &

x

)

const

Comparison operator.

参数

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

在文件 Header.cpp 第 83 行定义.

引用了 m_frame_id , 以及 m_stamp.

serialize()

void std_msgs::msg::Header::serialize

(

eprosima::fastcdr::Cdr &

cdr

)

const

This function serializes an object using CDR serialization.

参数

cdr	CDR serialization object.

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

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

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

serializeKey()

void std_msgs::msg::Header::serializeKey

(

eprosima::fastcdr::Cdr &

cdr

)

const

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

参数

cdr	CDR serialization object.

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

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

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

stamp() [1/4]

builtin_interfaces::msg::Time & std_msgs::msg::Header::stamp

(

)

This function returns a reference to member stamp

返回

Reference to member stamp

在文件 Header.cpp 第 160 行定义.

stamp() [2/4]

const builtin_interfaces::msg::Time & std_msgs::msg::Header::stamp

(

)

const

This function returns a constant reference to member stamp

返回

Constant reference to member stamp

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

stamp() [3/4]

void std_msgs::msg::Header::stamp

(

builtin_interfaces::msg::Time &&

_stamp

)

This function moves the value in member stamp

参数

_stamp

New value to be moved in member stamp

在文件 Header.cpp 第 141 行定义.

stamp() [4/4]

void std_msgs::msg::Header::stamp

(

const builtin_interfaces::msg::Time &

_stamp

)

This function copies the value in member stamp

参数

_stamp

New value to be copied in member stamp

在文件 Header.cpp 第 131 行定义.

被这些函数引用 getCdrSerializedSize(), carla::ros2::CarlaDepthCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaDVSCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaISCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaNormalsCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaOpticalFlowCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaRGBCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaSSCameraPublisher::SetCameraInfoData(), carla::ros2::CarlaGNSSPublisher::SetData(), carla::ros2::CarlaTransformPublisher::SetData(), carla::ros2::CarlaLineInvasionPublisher::SetData(), carla::ros2::CarlaIMUPublisher::SetData(), carla::ros2::CarlaRadarPublisher::SetData(), carla::ros2::CarlaDepthCameraPublisher::SetData(), carla::ros2::CarlaDVSCameraPublisher::SetData(), carla::ros2::CarlaISCameraPublisher::SetData(), carla::ros2::CarlaLidarPublisher::SetData(), carla::ros2::CarlaNormalsCameraPublisher::SetData(), carla::ros2::CarlaOpticalFlowCameraPublisher::SetData(), carla::ros2::CarlaSemanticLidarPublisher::SetData(), carla::ros2::CarlaSSCameraPublisher::SetData(), carla::ros2::CarlaCollisionPublisher::SetData() , 以及 carla::ros2::CarlaRGBCameraPublisher::SetImageData().

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

类成员变量说明

m_frame_id

std::string std_msgs::msg::Header::m_frame_id

private

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

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

m_stamp

builtin_interfaces::msg::Time std_msgs::msg::Header::m_stamp

private

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

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

---

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

• Header.h
• Header.cpp