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

#include <underlay_message.h>

Collaboration diagram for apollo::cyber::transport::UnderlayMessage:

Public Member Functions
	UnderlayMessage ()
	Default constructor. More...

	~UnderlayMessage ()
	Default destructor. More...

	UnderlayMessage (const UnderlayMessage &x)
	Copy constructor. More...

	UnderlayMessage (UnderlayMessage &&x)
	Move constructor. More...

UnderlayMessage &	operator= (const UnderlayMessage &x)
	Copy assignment. More...

UnderlayMessage &	operator= (UnderlayMessage &&x)
	Move assignment. More...

void	timestamp (int32_t _timestamp)
	This function sets a value in member timestamp. More...

int32_t	timestamp () const
	This function returns the value of member timestamp. More...

int32_t &	timestamp ()
	This function returns a reference to member timestamp. More...

void	seq (int32_t _seq)
	This function sets a value in member seq. More...

int32_t	seq () const
	This function returns the value of member seq. More...

int32_t &	seq ()
	This function returns a reference to member seq. More...

void	data (const std::string &_data)
	This function copies the value in member data. More...

void	data (std::string &&_data)
	This function moves the value in member data. More...

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

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

void	datatype (const std::string &_datatype)
	This function copies the value in member datatype. More...

void	datatype (std::string &&_datatype)
	This function moves the value in member datatype. More...

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

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

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

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

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

Static Public Member Functions
static 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 size_t	getCdrSerializedSize (const UnderlayMessage &data, size_t current_alignment=0)
	This function returns the serialized size of a data depending on the buffer alignment. More...

static 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 bool	isKeyDefined ()
	This function tells you if the Key has been defined for this type. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ UnderlayMessage() [1/3]

apollo::cyber::transport::UnderlayMessage::UnderlayMessage ( )

Default constructor.

◆ ~UnderlayMessage()

apollo::cyber::transport::UnderlayMessage::~UnderlayMessage ( )

Default destructor.

◆ UnderlayMessage() [2/3]

apollo::cyber::transport::UnderlayMessage::UnderlayMessage ( const UnderlayMessage & x )

Copy constructor.

Parameters

x	Reference to the object UnderlayMessage that will be copied.

◆ UnderlayMessage() [3/3]

apollo::cyber::transport::UnderlayMessage::UnderlayMessage ( UnderlayMessage && x )

Move constructor.

Parameters

x	Reference to the object UnderlayMessage that will be copied.

Member Function Documentation

◆ data() [1/4]

void apollo::cyber::transport::UnderlayMessage::data ( const std::string & _data )

inline

This function copies the value in member data.

Parameters

_data New value to be copied in member data

◆ data() [2/4]

void apollo::cyber::transport::UnderlayMessage::data ( std::string && _data )

inline

This function moves the value in member data.

Parameters

_data New value to be moved in member data

◆ data() [3/4]

const std::string& apollo::cyber::transport::UnderlayMessage::data ( ) const

inline

This function returns a constant reference to member data.

Returns: Constant reference to member data

◆ data() [4/4]

std::string& apollo::cyber::transport::UnderlayMessage::data ( )

inline

This function returns a reference to member data.

Returns: Reference to member data

◆ datatype() [1/4]

void apollo::cyber::transport::UnderlayMessage::datatype ( const std::string & _datatype )

inline

This function copies the value in member datatype.

Parameters

_datatype New value to be copied in member datatype

◆ datatype() [2/4]

void apollo::cyber::transport::UnderlayMessage::datatype ( std::string && _datatype )

inline

This function moves the value in member datatype.

Parameters

_datatype New value to be moved in member datatype

◆ datatype() [3/4]

const std::string& apollo::cyber::transport::UnderlayMessage::datatype ( ) const

inline

This function returns a constant reference to member datatype.

Returns: Constant reference to member datatype

◆ datatype() [4/4]

std::string& apollo::cyber::transport::UnderlayMessage::datatype ( )

inline

This function returns a reference to member datatype.

Returns: Reference to member datatype

◆ deserialize()

void apollo::cyber::transport::UnderlayMessage::deserialize ( eprosima::fastcdr::Cdr & cdr )

This function deserializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

◆ getCdrSerializedSize()

static size_t apollo::cyber::transport::UnderlayMessage::getCdrSerializedSize	(	const UnderlayMessage &	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.

◆ getKeyMaxCdrSerializedSize()

static size_t apollo::cyber::transport::UnderlayMessage::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.

◆ getMaxCdrSerializedSize()

static size_t apollo::cyber::transport::UnderlayMessage::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.

◆ isKeyDefined()

static bool apollo::cyber::transport::UnderlayMessage::isKeyDefined ( )

static

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

◆ operator=() [1/2]

UnderlayMessage& apollo::cyber::transport::UnderlayMessage::operator= ( const UnderlayMessage & x )

Copy assignment.

Parameters

x	Reference to the object UnderlayMessage that will be copied.

◆ operator=() [2/2]

UnderlayMessage& apollo::cyber::transport::UnderlayMessage::operator= ( UnderlayMessage && x )

Move assignment.

Parameters

x	Reference to the object UnderlayMessage that will be copied.

◆ seq() [1/3]

void apollo::cyber::transport::UnderlayMessage::seq ( int32_t _seq )

inline

This function sets a value in member seq.

Parameters

_seq	New value for member seq

◆ seq() [2/3]

int32_t apollo::cyber::transport::UnderlayMessage::seq ( ) const

inline

This function returns the value of member seq.

Returns: Value of member seq

◆ seq() [3/3]

int32_t& apollo::cyber::transport::UnderlayMessage::seq ( )

inline

This function returns a reference to member seq.

Returns: Reference to member seq

◆ serialize()

void apollo::cyber::transport::UnderlayMessage::serialize ( eprosima::fastcdr::Cdr & cdr ) const

This function serializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

◆ serializeKey()

void apollo::cyber::transport::UnderlayMessage::serializeKey ( eprosima::fastcdr::Cdr & cdr ) const

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

Parameters

cdr	CDR serialization object.

◆ timestamp() [1/3]

void apollo::cyber::transport::UnderlayMessage::timestamp ( int32_t _timestamp )

inline

This function sets a value in member timestamp.

Parameters

_timestamp New value for member timestamp

◆ timestamp() [2/3]

int32_t apollo::cyber::transport::UnderlayMessage::timestamp ( ) const

inline

This function returns the value of member timestamp.

Returns: Value of member timestamp

◆ timestamp() [3/3]

int32_t& apollo::cyber::transport::UnderlayMessage::timestamp ( )

inline

This function returns a reference to member timestamp.

Returns: Reference to member timestamp

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

cyber/transport/rtps/underlay_message.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ UnderlayMessage() [1/3]

◆ ~UnderlayMessage()

◆ UnderlayMessage() [2/3]

◆ UnderlayMessage() [3/3]

Member Function Documentation

◆ data() [1/4]

◆ data() [2/4]

◆ data() [3/4]

◆ data() [4/4]

◆ datatype() [1/4]

◆ datatype() [2/4]

◆ datatype() [3/4]

◆ datatype() [4/4]

◆ deserialize()

◆ getCdrSerializedSize()

◆ getKeyMaxCdrSerializedSize()

◆ getMaxCdrSerializedSize()

◆ isKeyDefined()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ seq() [1/3]

◆ seq() [2/3]

◆ seq() [3/3]

◆ serialize()

◆ serializeKey()

◆ timestamp() [1/3]

◆ timestamp() [2/3]

◆ timestamp() [3/3]