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

#include <Image.h>

sensor_msgs::msg::Image 的协作图:

Public 成员函数
eProsima_user_DllExport std::vector< uint8_t > &	data ()
	This function returns a reference to member data

eProsima_user_DllExport const std::vector< uint8_t > &	data () const
	This function returns a constant reference to member data

eProsima_user_DllExport void	data (const std::vector< uint8_t > &_data)
	This function copies the value in member data

eProsima_user_DllExport void	data (std::vector< uint8_t > &&_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 std::string &	encoding ()
	This function returns a reference to member encoding

eProsima_user_DllExport const std::string &	encoding () const
	This function returns a constant reference to member encoding

eProsima_user_DllExport void	encoding (const std::string &_encoding)
	This function copies the value in member encoding

eProsima_user_DllExport void	encoding (std::string &&_encoding)
	This function moves the value in member encoding

eProsima_user_DllExport std_msgs::msg::Header &	header ()
	This function returns a reference to member header

eProsima_user_DllExport const std_msgs::msg::Header &	header () const
	This function returns a constant reference to member header

eProsima_user_DllExport void	header (const std_msgs::msg::Header &_header)
	This function copies the value in member header

eProsima_user_DllExport void	header (std_msgs::msg::Header &&_header)
	This function moves the value in member header

eProsima_user_DllExport uint32_t &	height ()
	This function returns a reference to member height

eProsima_user_DllExport uint32_t	height () const
	This function returns the value of member height

eProsima_user_DllExport void	height (uint32_t _height)
	This function sets a value in member height

eProsima_user_DllExport	Image ()
	Default constructor.

eProsima_user_DllExport	Image (const Image &x)
	Copy constructor.

eProsima_user_DllExport	Image (Image &&x) noexcept
	Move constructor.

eProsima_user_DllExport uint8_t &	is_bigendian ()
	This function returns a reference to member is_bigendian

eProsima_user_DllExport uint8_t	is_bigendian () const
	This function returns the value of member is_bigendian

eProsima_user_DllExport void	is_bigendian (uint8_t _is_bigendian)
	This function sets a value in member is_bigendian

eProsima_user_DllExport bool	operator!= (const Image &x) const
	Comparison operator.

eProsima_user_DllExport Image &	operator= (const Image &x)
	Copy assignment.

eProsima_user_DllExport Image &	operator= (Image &&x) noexcept
	Move assignment.

eProsima_user_DllExport bool	operator== (const Image &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 uint32_t &	step ()
	This function returns a reference to member step

eProsima_user_DllExport uint32_t	step () const
	This function returns the value of member step

eProsima_user_DllExport void	step (uint32_t _step)
	This function sets a value in member step

eProsima_user_DllExport uint32_t &	width ()
	This function returns a reference to member width

eProsima_user_DllExport uint32_t	width () const
	This function returns the value of member width

eProsima_user_DllExport void	width (uint32_t _width)
	This function sets a value in member width

eProsima_user_DllExport	~Image ()
	Default destructor.

静态 Public 成员函数
static eProsima_user_DllExport size_t	getCdrSerializedSize (const sensor_msgs::msg::Image &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::vector< uint8_t >	m_data

std::string	m_encoding

std_msgs::msg::Header	m_header

uint32_t	m_height

uint8_t	m_is_bigendian

uint32_t	m_step

uint32_t	m_width

详细描述

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

在文件 ros2/types/Image.h 第 72 行定义.

构造及析构函数说明

◆ Image() [1/3]

sensor_msgs::msg::Image::Image ( )

Default constructor.

在文件 Image.cpp 第 44 行定义.

引用了 m_encoding, m_height, m_is_bigendian, m_step , 以及 m_width.

◆ ~Image()

sensor_msgs::msg::Image::~Image ( )

Default destructor.

在文件 Image.cpp 第 61 行定义.

◆ Image() [2/3]

sensor_msgs::msg::Image::Image ( const Image & x )

Copy constructor.

参数

x	Reference to the object sensor_msgs::msg::Image that will be copied.

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

引用了 m_data, m_encoding, m_header, m_height, m_is_bigendian, m_step , 以及 m_width.

◆ Image() [3/3]

sensor_msgs::msg::Image::Image ( Image && x )

noexcept

Move constructor.

参数

x	Reference to the object sensor_msgs::msg::Image that will be copied.

在文件 Image.cpp 第 77 行定义.

成员函数说明

◆ data() [1/4]

std::vector< uint8_t > & sensor_msgs::msg::Image::data ( )

This function returns a reference to member data

返回: Reference to member data

在文件 Image.cpp 第 402 行定义.

◆ data() [2/4]

const std::vector< uint8_t > & sensor_msgs::msg::Image::data ( ) const

This function returns a constant reference to member data

返回: Constant reference to member data

在文件 Image.cpp 第 393 行定义.

◆ data() [3/4]

void sensor_msgs::msg::Image::data ( const std::vector< uint8_t > & _data )

This function copies the value in member data

参数

_data New value to be copied in member data

在文件 Image.cpp 第 373 行定义.

被这些函数引用 getCdrSerializedSize().

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

◆ data() [4/4]

void sensor_msgs::msg::Image::data ( std::vector< uint8_t > && _data )

This function moves the value in member data

参数

_data New value to be moved in member data

在文件 Image.cpp 第 383 行定义.

◆ deserialize()

void sensor_msgs::msg::Image::deserialize ( eprosima::fastcdr::Cdr & cdr )

This function deserializes an object using CDR serialization.

参数

cdr	CDR serialization object.

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

被这些函数引用 sensor_msgs::msg::ImagePubSubType::deserialize().

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

◆ encoding() [1/4]

std::string & sensor_msgs::msg::Image::encoding ( )

This function returns a reference to member encoding

返回: Reference to member encoding

在文件 Image.cpp 第 308 行定义.

◆ encoding() [2/4]

const std::string & sensor_msgs::msg::Image::encoding ( ) const

This function returns a constant reference to member encoding

返回: Constant reference to member encoding

在文件 Image.cpp 第 299 行定义.

◆ encoding() [3/4]

void sensor_msgs::msg::Image::encoding ( const std::string & _encoding )

This function copies the value in member encoding

参数

_encoding New value to be copied in member encoding

在文件 Image.cpp 第 279 行定义.

被这些函数引用 getCdrSerializedSize().

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

◆ encoding() [4/4]

void sensor_msgs::msg::Image::encoding ( std::string && _encoding )

This function moves the value in member encoding

参数

_encoding New value to be moved in member encoding

在文件 Image.cpp 第 289 行定义.

◆ getCdrSerializedSize()

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

在文件 Image.cpp 第 136 行定义.

引用了 data(), encoding(), std_msgs::msg::Header::getCdrSerializedSize() , 以及 header().

被这些函数引用 sensor_msgs::msg::ImagePubSubType::getSerializedSizeProvider().

函数调用图:

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

◆ getKeyMaxCdrSerializedSize()

size_t sensor_msgs::msg::Image::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.

在文件 Image.cpp 第 407 行定义.

引用了 sensor_msgs_msg_Image_max_key_cdr_typesize.

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

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

◆ getMaxCdrSerializedSize()

size_t sensor_msgs::msg::Image::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.

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

引用了 sensor_msgs_msg_Image_max_cdr_typesize.

被这些函数引用 sensor_msgs::msg::ImagePubSubType::ImagePubSubType().

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

◆ header() [1/4]

std_msgs::msg::Header & sensor_msgs::msg::Image::header ( )

This function returns a reference to member header

返回: Reference to member header

在文件 Image.cpp 第 214 行定义.

◆ header() [2/4]

const std_msgs::msg::Header & sensor_msgs::msg::Image::header ( ) const

This function returns a constant reference to member header

返回: Constant reference to member header

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

◆ header() [3/4]

void sensor_msgs::msg::Image::header ( const std_msgs::msg::Header & _header )

This function copies the value in member header

参数

_header New value to be copied in member header

在文件 Image.cpp 第 185 行定义.

被这些函数引用 getCdrSerializedSize().

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

◆ header() [4/4]

void sensor_msgs::msg::Image::header ( std_msgs::msg::Header && _header )

This function moves the value in member header

参数

_header New value to be moved in member header

在文件 Image.cpp 第 195 行定义.

◆ height() [1/3]

uint32_t & sensor_msgs::msg::Image::height ( )

This function returns a reference to member height

返回: Reference to member height

在文件 Image.cpp 第 242 行定义.

◆ height() [2/3]

uint32_t sensor_msgs::msg::Image::height ( ) const

This function returns the value of member height

返回: Value of member height

在文件 Image.cpp 第 233 行定义.

◆ height() [3/3]

void sensor_msgs::msg::Image::height ( uint32_t _height )

This function sets a value in member height

参数

_height New value for member height

在文件 Image.cpp 第 223 行定义.

◆ is_bigendian() [1/3]

uint8_t & sensor_msgs::msg::Image::is_bigendian ( )

This function returns a reference to member is_bigendian

返回: Reference to member is_bigendian

在文件 Image.cpp 第 336 行定义.

◆ is_bigendian() [2/3]

uint8_t sensor_msgs::msg::Image::is_bigendian ( ) const

This function returns the value of member is_bigendian

返回: Value of member is_bigendian

在文件 Image.cpp 第 327 行定义.

◆ is_bigendian() [3/3]

void sensor_msgs::msg::Image::is_bigendian ( uint8_t _is_bigendian )

This function sets a value in member is_bigendian

参数

_is_bigendian New value for member is_bigendian

在文件 Image.cpp 第 317 行定义.

◆ isKeyDefined()

bool sensor_msgs::msg::Image::isKeyDefined ( )

static

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

在文件 Image.cpp 第 414 行定义.

被这些函数引用 sensor_msgs::msg::ImagePubSubType::ImagePubSubType().

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

◆ operator!=()

bool sensor_msgs::msg::Image::operator!= ( const Image & x ) const

Comparison operator.

参数

x	sensor_msgs::msg::Image object to compare.

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

◆ operator=() [1/2]

sensor_msgs::msg::Image & sensor_msgs::msg::Image::operator= ( const Image & x )

Copy assignment.

参数

x	Reference to the object sensor_msgs::msg::Image that will be copied.

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

引用了 m_data, m_encoding, m_header, m_height, m_is_bigendian, m_step , 以及 m_width.

◆ operator=() [2/2]

sensor_msgs::msg::Image & sensor_msgs::msg::Image::operator= ( Image && x )

noexcept

Move assignment.

参数

x	Reference to the object sensor_msgs::msg::Image that will be copied.

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

◆ operator==()

bool sensor_msgs::msg::Image::operator== ( const Image & x ) const

Comparison operator.

参数

x	sensor_msgs::msg::Image object to compare.

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

引用了 m_data, m_encoding, m_header, m_height, m_is_bigendian, m_step , 以及 m_width.

◆ serialize()

void sensor_msgs::msg::Image::serialize ( eprosima::fastcdr::Cdr & cdr ) const

This function serializes an object using CDR serialization.

参数

cdr	CDR serialization object.

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

被这些函数引用 sensor_msgs::msg::ImagePubSubType::serialize().

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

◆ serializeKey()

void sensor_msgs::msg::Image::serializeKey ( eprosima::fastcdr::Cdr & cdr ) const

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

参数

cdr	CDR serialization object.

在文件 Image.cpp 第 419 行定义.

被这些函数引用 sensor_msgs::msg::ImagePubSubType::getKey().

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

◆ step() [1/3]

uint32_t & sensor_msgs::msg::Image::step ( )

This function returns a reference to member step

返回: Reference to member step

在文件 Image.cpp 第 364 行定义.

◆ step() [2/3]

uint32_t sensor_msgs::msg::Image::step ( ) const

This function returns the value of member step

返回: Value of member step

在文件 Image.cpp 第 355 行定义.

◆ step() [3/3]

void sensor_msgs::msg::Image::step ( uint32_t _step )

This function sets a value in member step

参数

_step New value for member step

在文件 Image.cpp 第 345 行定义.

◆ width() [1/3]

uint32_t & sensor_msgs::msg::Image::width ( )

This function returns a reference to member width

返回: Reference to member width

在文件 Image.cpp 第 270 行定义.

◆ width() [2/3]

uint32_t sensor_msgs::msg::Image::width ( ) const

This function returns the value of member width

返回: Value of member width

在文件 Image.cpp 第 261 行定义.

◆ width() [3/3]

void sensor_msgs::msg::Image::width ( uint32_t _width )

This function sets a value in member width

参数

_width New value for member width

在文件 Image.cpp 第 251 行定义.

类成员变量说明

◆ m_data

std::vector<uint8_t> sensor_msgs::msg::Image::m_data

private

在文件 ros2/types/Image.h 第 342 行定义.

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

◆ m_encoding

std::string sensor_msgs::msg::Image::m_encoding

private

在文件 ros2/types/Image.h 第 339 行定义.

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

◆ m_header

std_msgs::msg::Header sensor_msgs::msg::Image::m_header

private

在文件 ros2/types/Image.h 第 336 行定义.

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

◆ m_height

uint32_t sensor_msgs::msg::Image::m_height

private

在文件 ros2/types/Image.h 第 337 行定义.

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

◆ m_is_bigendian

uint8_t sensor_msgs::msg::Image::m_is_bigendian

private

在文件 ros2/types/Image.h 第 340 行定义.

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

◆ m_step

uint32_t sensor_msgs::msg::Image::m_step

private

在文件 ros2/types/Image.h 第 341 行定义.

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

◆ m_width

uint32_t sensor_msgs::msg::Image::m_width

private

在文件 ros2/types/Image.h 第 338 行定义.

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

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

Public 成员函数

静态 Public 成员函数

Private 属性

详细描述

构造及析构函数说明

◆ Image() [1/3]

◆ ~Image()

◆ Image() [2/3]

◆ Image() [3/3]

成员函数说明

◆ data() [1/4]

◆ data() [2/4]

◆ data() [3/4]

◆ data() [4/4]

◆ deserialize()

◆ encoding() [1/4]

◆ encoding() [2/4]

◆ encoding() [3/4]

◆ encoding() [4/4]

◆ getCdrSerializedSize()

◆ getKeyMaxCdrSerializedSize()

◆ getMaxCdrSerializedSize()

◆ header() [1/4]

◆ header() [2/4]

◆ header() [3/4]

◆ header() [4/4]

◆ height() [1/3]

◆ height() [2/3]

◆ height() [3/3]

◆ is_bigendian() [1/3]

◆ is_bigendian() [2/3]

◆ is_bigendian() [3/3]

◆ isKeyDefined()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ serialize()

◆ serializeKey()

◆ step() [1/3]

◆ step() [2/3]

◆ step() [3/3]

◆ width() [1/3]

◆ width() [2/3]

◆ width() [3/3]

类成员变量说明

◆ m_data

◆ m_encoding

◆ m_header

◆ m_height

◆ m_is_bigendian

◆ m_step

◆ m_width