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

#include <agnostictopicif.h>

Public Member Functions
eProsima_user_DllExport	AgnosticTopic ()
	Default constructor. More...

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

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

eProsima_user_DllExport	AgnosticTopic (AgnosticTopic &&x)
	Move constructor. More...

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

eProsima_user_DllExport AgnosticTopic &	operator= (AgnosticTopic &&x)
	Move assignment. More...

eProsima_user_DllExport void	sample_id (uint32_t _sample_id)
	This function sets a value in member sample_id. More...

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

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

eProsima_user_DllExport void	time_stamp (rtctk::TimeStamp _time_stamp)
	This function sets a value in member time_stamp. More...

eProsima_user_DllExport rtctk::TimeStamp	time_stamp () const
	This function returns the value of member time_stamp. More...

eProsima_user_DllExport rtctk::TimeStamp &	time_stamp ()
	This function returns a reference to member time_stamp. More...

eProsima_user_DllExport void	serialized_data (const rtctk::GenPayLoad &_serialized_data)
	This function copies the value in member serialized_data. More...

eProsima_user_DllExport void	serialized_data (rtctk::GenPayLoad &&_serialized_data)
	This function moves the value in member serialized_data. More...

eProsima_user_DllExport const rtctk::GenPayLoad &	serialized_data () const
	This function returns a constant reference to member serialized_data. More...

eProsima_user_DllExport rtctk::GenPayLoad &	serialized_data ()
	This function returns a reference to member serialized_data. More...

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

eProsima_user_DllExport void	deserialize (eprosima::fastcdr::Cdr &cdr)
	This function deserializes 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...

Static Public Member Functions
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 size_t	getCdrSerializedSize (const rtctk::AgnosticTopic &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 bool	isKeyDefined ()
	This function tells you if the Key has been defined for this type. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ AgnosticTopic() [1/3]

rtctk::AgnosticTopic::AgnosticTopic ( )

Default constructor.

◆ ~AgnosticTopic()

rtctk::AgnosticTopic::~AgnosticTopic ( )

Default destructor.

◆ AgnosticTopic() [2/3]

rtctk::AgnosticTopic::AgnosticTopic ( const AgnosticTopic & x )

Copy constructor.

Parameters

x	Reference to the object rtctk::AgnosticTopic that will be copied.

◆ AgnosticTopic() [3/3]

rtctk::AgnosticTopic::AgnosticTopic ( AgnosticTopic && x )

Move constructor.

Parameters

x	Reference to the object rtctk::AgnosticTopic that will be copied.

Member Function Documentation

◆ deserialize()

void rtctk::AgnosticTopic::deserialize ( eprosima::fastcdr::Cdr & cdr )

This function deserializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

◆ getCdrSerializedSize()

size_t rtctk::AgnosticTopic::getCdrSerializedSize	(	const rtctk::AgnosticTopic &	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()

size_t rtctk::AgnosticTopic::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()

size_t rtctk::AgnosticTopic::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()

bool rtctk::AgnosticTopic::isKeyDefined ( )

static

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

◆ operator=() [1/2]

rtctk::AgnosticTopic & rtctk::AgnosticTopic::operator= ( AgnosticTopic && x )

Move assignment.

Parameters

x	Reference to the object rtctk::AgnosticTopic that will be copied.

◆ operator=() [2/2]

rtctk::AgnosticTopic & rtctk::AgnosticTopic::operator= ( const AgnosticTopic & x )

Copy assignment.

Parameters

x	Reference to the object rtctk::AgnosticTopic that will be copied.

◆ sample_id() [1/3]

uint32_t & rtctk::AgnosticTopic::sample_id ( )

This function returns a reference to member sample_id.

Returns: Reference to member sample_id

◆ sample_id() [2/3]

uint32_t rtctk::AgnosticTopic::sample_id ( ) const

This function returns the value of member sample_id.

Returns: Value of member sample_id

◆ sample_id() [3/3]

void rtctk::AgnosticTopic::sample_id ( uint32_t _sample_id )

This function sets a value in member sample_id.

Parameters

_sample_id New value for member sample_id

◆ serialize()

void rtctk::AgnosticTopic::serialize ( eprosima::fastcdr::Cdr & cdr ) const

This function serializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

◆ serialized_data() [1/4]

rtctk::GenPayLoad & rtctk::AgnosticTopic::serialized_data ( )

This function returns a reference to member serialized_data.

Returns: Reference to member serialized_data

◆ serialized_data() [2/4]

const rtctk::GenPayLoad & rtctk::AgnosticTopic::serialized_data ( ) const

This function returns a constant reference to member serialized_data.

Returns: Constant reference to member serialized_data

◆ serialized_data() [3/4]

void rtctk::AgnosticTopic::serialized_data ( const rtctk::GenPayLoad & _serialized_data )

This function copies the value in member serialized_data.

Parameters

_serialized_data New value to be copied in member serialized_data

◆ serialized_data() [4/4]

void rtctk::AgnosticTopic::serialized_data ( rtctk::GenPayLoad && _serialized_data )

This function moves the value in member serialized_data.

Parameters

_serialized_data New value to be moved in member serialized_data

◆ serializeKey()

void rtctk::AgnosticTopic::serializeKey ( eprosima::fastcdr::Cdr & cdr ) const

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

Parameters

cdr	CDR serialization object.

◆ time_stamp() [1/3]

rtctk::TimeStamp & rtctk::AgnosticTopic::time_stamp ( )

This function returns a reference to member time_stamp.

Returns: Reference to member time_stamp

◆ time_stamp() [2/3]

rtctk::TimeStamp rtctk::AgnosticTopic::time_stamp ( ) const

This function returns the value of member time_stamp.

Returns: Value of member time_stamp

◆ time_stamp() [3/3]

void rtctk::AgnosticTopic::time_stamp ( rtctk::TimeStamp _time_stamp )

This function sets a value in member time_stamp.

Parameters

_time_stamp New value for member time_stamp

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

componentFramework/interfaces/dataPath/agnostictopicif/src/include/rtctk/fastdds/agnostictopicif.h
componentFramework/interfaces/dataPath/agnostictopicif/src/agnostictopicif.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AgnosticTopic() [1/3]

◆ ~AgnosticTopic()

◆ AgnosticTopic() [2/3]

◆ AgnosticTopic() [3/3]

Member Function Documentation

◆ deserialize()

◆ getCdrSerializedSize()

◆ getKeyMaxCdrSerializedSize()

◆ getMaxCdrSerializedSize()

◆ isKeyDefined()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ sample_id() [1/3]

◆ sample_id() [2/3]

◆ sample_id() [3/3]

◆ serialize()

◆ serialized_data() [1/4]

◆ serialized_data() [2/4]

◆ serialized_data() [3/4]

◆ serialized_data() [4/4]

◆ serializeKey()

◆ time_stamp() [1/3]

◆ time_stamp() [2/3]

◆ time_stamp() [3/3]