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

#include <PointField.h>

Collaboration diagram for sensor_msgs::msg::PointField:

Public Member Functions
eProsima_user_DllExport void	count (uint32_t _count)
	This function sets a value in member count. More...

eProsima_user_DllExport uint32_t	count () const
	This function returns the value of member count. More...

eProsima_user_DllExport uint32_t &	count ()
	This function returns a reference to member count. More...

eProsima_user_DllExport void	datatype (uint8_t _datatype)
	This function sets a value in member datatype. More...

eProsima_user_DllExport uint8_t	datatype () const
	This function returns the value of member datatype. More...

eProsima_user_DllExport uint8_t &	datatype ()
	This function returns a reference to member datatype. More...

eProsima_user_DllExport void	deserialize (eprosima::fastcdr::Cdr &cdr)
	This function deserializes an object using CDR serialization. More...

eProsima_user_DllExport void	name (const std::string &_name)
	This function copies the value in member name. More...

eProsima_user_DllExport void	name (std::string &&_name)
	This function moves the value in member name. More...

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

eProsima_user_DllExport std::string &	name ()
	This function returns a reference to member name. More...

eProsima_user_DllExport void	offset (uint32_t _offset)
	This function sets a value in member offset. More...

eProsima_user_DllExport uint32_t	offset () const
	This function returns the value of member offset. More...

eProsima_user_DllExport uint32_t &	offset ()
	This function returns a reference to member offset. More...

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

eProsima_user_DllExport PointField &	operator= (const PointField &x)
	Copy assignment. More...

eProsima_user_DllExport PointField &	operator= (PointField &&x) noexcept
	Move assignment. More...

eProsima_user_DllExport bool	operator== (const PointField &x) const
	Comparison operator. More...

eProsima_user_DllExport	PointField ()
	Default constructor. More...

eProsima_user_DllExport	PointField (const PointField &x)
	Copy constructor. More...

eProsima_user_DllExport	PointField (PointField &&x) noexcept
	Move constructor. More...

eProsima_user_DllExport void	serialize (eprosima::fastcdr::Cdr &cdr) const
	This function serializes an object using CDR serialization. More...

eProsima_user_DllExport void	serializeKey (eprosima::fastcdr::Cdr &cdr) const
	This function serializes the key members of an object using CDR serialization. More...

eProsima_user_DllExport	~PointField ()
	Default destructor. More...

Static Public Member Functions
static eProsima_user_DllExport size_t	getCdrSerializedSize (const sensor_msgs::msg::PointField &data, size_t current_alignment=0)
	This function returns the serialized size of a data depending on the buffer alignment. More...

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. More...

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. More...

static eProsima_user_DllExport bool	isKeyDefined ()
	This function tells you if the Key has been defined for this type. More...

Private Attributes
uint32_t	m_count

uint8_t	m_datatype

std::string	m_name

uint32_t	m_offset

Detailed Description

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

Definition at line 79 of file PointField.h.

Constructor & Destructor Documentation

◆ PointField() [1/3]

sensor_msgs::msg::PointField::PointField ( )

Default constructor.

Definition at line 40 of file PointField.cpp.

◆ ~PointField()

sensor_msgs::msg::PointField::~PointField ( )

Default destructor.

Definition at line 52 of file PointField.cpp.

◆ PointField() [2/3]

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

Copy constructor.

Parameters

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

Definition at line 56 of file PointField.cpp.

References m_count, m_datatype, m_name, and m_offset.

◆ PointField() [3/3]

sensor_msgs::msg::PointField::PointField ( PointField && x )

noexcept

Move constructor.

Parameters

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

Definition at line 65 of file PointField.cpp.

Member Function Documentation

◆ count() [1/3]

void sensor_msgs::msg::PointField::count ( uint32_t _count )

This function sets a value in member count.

Parameters

_count New value for member count

Definition at line 244 of file PointField.cpp.

Referenced by carla::ros2::CarlaLidarPublisher::SetData(), carla::ros2::CarlaSemanticLidarPublisher::SetData(), carla::ros2::CarlaRadarPublisher::SetData(), and carla::ros2::CarlaDVSCameraPublisher::SetPointCloudData().

Here is the caller graph for this function:

◆ count() [2/3]

uint32_t sensor_msgs::msg::PointField::count ( ) const

This function returns the value of member count.

Returns: Value of member count

Definition at line 254 of file PointField.cpp.

◆ count() [3/3]

uint32_t & sensor_msgs::msg::PointField::count ( )

This function returns a reference to member count.

Returns: Reference to member count

Definition at line 263 of file PointField.cpp.

◆ datatype() [1/3]

void sensor_msgs::msg::PointField::datatype ( uint8_t _datatype )

This function sets a value in member datatype.

Parameters

_datatype New value for member datatype

Definition at line 216 of file PointField.cpp.

Referenced by carla::ros2::CarlaLidarPublisher::SetData(), carla::ros2::CarlaSemanticLidarPublisher::SetData(), carla::ros2::CarlaRadarPublisher::SetData(), and carla::ros2::CarlaDVSCameraPublisher::SetPointCloudData().

Here is the caller graph for this function:

◆ datatype() [2/3]

uint8_t sensor_msgs::msg::PointField::datatype ( ) const

This function returns the value of member datatype.

Returns: Value of member datatype

Definition at line 226 of file PointField.cpp.

◆ datatype() [3/3]

uint8_t & sensor_msgs::msg::PointField::datatype ( )

This function returns a reference to member datatype.

Returns: Reference to member datatype

Definition at line 235 of file PointField.cpp.

◆ deserialize()

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

This function deserializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 137 of file PointField.cpp.

Referenced by sensor_msgs::msg::PointFieldPubSubType::deserialize().

Here is the caller graph for this function:

◆ getCdrSerializedSize()

size_t sensor_msgs::msg::PointField::getCdrSerializedSize	(	const sensor_msgs::msg::PointField &	data,
		size_t	current_alignment = `0`
	)

static

This function returns the serialized size of a data depending on the buffer alignment.

Parameters

data	Data which is calculated its serialized size.
current_alignment	Buffer alignment.

Returns: Serialized size.

Definition at line 115 of file PointField.cpp.

References name().

Referenced by sensor_msgs::msg::PointCloud2::getCdrSerializedSize(), and sensor_msgs::msg::PointFieldPubSubType::getSerializedSizeProvider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKeyMaxCdrSerializedSize()

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

Parameters

current_alignment Buffer alignment.

Returns: Maximum serialized size.

Definition at line 268 of file PointField.cpp.

References sensor_msgs_msg_PointField_max_key_cdr_typesize.

Referenced by sensor_msgs::msg::PointFieldPubSubType::getKey(), and sensor_msgs::msg::PointFieldPubSubType::PointFieldPubSubType().

Here is the caller graph for this function:

◆ getMaxCdrSerializedSize()

size_t sensor_msgs::msg::PointField::getMaxCdrSerializedSize ( size_t current_alignment = 0 )

static

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

Parameters

current_alignment Buffer alignment.

Returns: Maximum serialized size.

Definition at line 108 of file PointField.cpp.

References sensor_msgs_msg_PointField_max_cdr_typesize.

Referenced by sensor_msgs::msg::PointFieldPubSubType::PointFieldPubSubType().

Here is the caller graph for this function:

◆ isKeyDefined()

bool sensor_msgs::msg::PointField::isKeyDefined ( )

static

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

Definition at line 275 of file PointField.cpp.

Referenced by sensor_msgs::msg::PointFieldPubSubType::PointFieldPubSubType().

Here is the caller graph for this function:

◆ name() [1/4]

void sensor_msgs::msg::PointField::name ( const std::string & _name )

This function copies the value in member name.

Parameters

_name New value to be copied in member name

Definition at line 150 of file PointField.cpp.

Referenced by getCdrSerializedSize(), carla::ros2::CarlaSemanticLidarPublisher::SetData(), carla::ros2::CarlaLidarPublisher::SetData(), carla::ros2::CarlaRadarPublisher::SetData(), and carla::ros2::CarlaDVSCameraPublisher::SetPointCloudData().

Here is the caller graph for this function:

◆ name() [2/4]

void sensor_msgs::msg::PointField::name ( std::string && _name )

This function moves the value in member name.

Parameters

_name New value to be moved in member name

Definition at line 160 of file PointField.cpp.

◆ name() [3/4]

const std::string & sensor_msgs::msg::PointField::name ( ) const

This function returns a constant reference to member name.

Returns: Constant reference to member name

Definition at line 170 of file PointField.cpp.

◆ name() [4/4]

std::string & sensor_msgs::msg::PointField::name ( )

This function returns a reference to member name.

Returns: Reference to member name

Definition at line 179 of file PointField.cpp.

◆ offset() [1/3]

void sensor_msgs::msg::PointField::offset ( uint32_t _offset )

This function sets a value in member offset.

Parameters

_offset New value for member offset

Definition at line 188 of file PointField.cpp.

Referenced by carla::ros2::CarlaLidarPublisher::SetData(), carla::ros2::CarlaSemanticLidarPublisher::SetData(), carla::ros2::CarlaRadarPublisher::SetData(), and carla::ros2::CarlaDVSCameraPublisher::SetPointCloudData().

Here is the caller graph for this function:

◆ offset() [2/3]

uint32_t sensor_msgs::msg::PointField::offset ( ) const

This function returns the value of member offset.

Returns: Value of member offset

Definition at line 198 of file PointField.cpp.

◆ offset() [3/3]

uint32_t & sensor_msgs::msg::PointField::offset ( )

This function returns a reference to member offset.

Returns: Reference to member offset

Definition at line 207 of file PointField.cpp.

◆ operator!=()

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

Comparison operator.

Parameters

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

Definition at line 102 of file PointField.cpp.

◆ operator=() [1/2]

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

Copy assignment.

Parameters

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

Definition at line 74 of file PointField.cpp.

References m_count, m_datatype, m_name, and m_offset.

◆ operator=() [2/2]

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

noexcept

Move assignment.

Parameters

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

Definition at line 85 of file PointField.cpp.

◆ operator==()

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

Comparison operator.

Parameters

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

Definition at line 96 of file PointField.cpp.

References m_count, m_datatype, m_name, and m_offset.

◆ serialize()

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

This function serializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

Definition at line 128 of file PointField.cpp.

Referenced by sensor_msgs::msg::PointFieldPubSubType::serialize().

Here is the caller graph for this function:

◆ serializeKey()

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

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

Parameters

cdr	CDR serialization object.

Definition at line 280 of file PointField.cpp.

Referenced by sensor_msgs::msg::PointFieldPubSubType::getKey().

Here is the caller graph for this function:

Member Data Documentation

◆ m_count

uint32_t sensor_msgs::msg::PointField::m_count

private

Definition at line 275 of file PointField.h.

Referenced by operator=(), operator==(), and PointField().

◆ m_datatype

uint8_t sensor_msgs::msg::PointField::m_datatype

private

Definition at line 274 of file PointField.h.

Referenced by operator=(), operator==(), and PointField().

◆ m_name

std::string sensor_msgs::msg::PointField::m_name

private

Definition at line 272 of file PointField.h.

Referenced by operator=(), operator==(), and PointField().

◆ m_offset

uint32_t sensor_msgs::msg::PointField::m_offset

private

Definition at line 273 of file PointField.h.

Referenced by operator=(), operator==(), and PointField().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PointField() [1/3]

◆ ~PointField()

◆ PointField() [2/3]

◆ PointField() [3/3]

Member Function Documentation

◆ count() [1/3]

◆ count() [2/3]

◆ count() [3/3]

◆ datatype() [1/3]

◆ datatype() [2/3]

◆ datatype() [3/3]

◆ deserialize()

◆ getCdrSerializedSize()

◆ getKeyMaxCdrSerializedSize()

◆ getMaxCdrSerializedSize()

◆ isKeyDefined()

◆ name() [1/4]

◆ name() [2/4]

◆ name() [3/4]

◆ name() [4/4]

◆ offset() [1/3]

◆ offset() [2/3]

◆ offset() [3/3]

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ serialize()

◆ serializeKey()

Member Data Documentation

◆ m_count

◆ m_datatype

◆ m_name

◆ m_offset