ExtendedAnnotationParameterValue Class Reference

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

#include <AnnotationParameterValue.h>

Public Member Functions
RTPS_DllAPI	ExtendedAnnotationParameterValue ()
	Default constructor. More...
RTPS_DllAPI	~ExtendedAnnotationParameterValue ()
	Default destructor. More...
RTPS_DllAPI	ExtendedAnnotationParameterValue (const ExtendedAnnotationParameterValue &x)
	Copy constructor. More...
RTPS_DllAPI	ExtendedAnnotationParameterValue (ExtendedAnnotationParameterValue &&x)
	Move constructor. More...
RTPS_DllAPI ExtendedAnnotationParameterValue &	operator= (const ExtendedAnnotationParameterValue &x)
	Copy assignment. More...
RTPS_DllAPI ExtendedAnnotationParameterValue &	operator= (ExtendedAnnotationParameterValue &&x)
	Move assignment. More...
RTPS_DllAPI void	serialize (eprosima::fastcdr::Cdr &cdr) const
	This function serializes an object using CDR serialization. More...
RTPS_DllAPI void	deserialize (eprosima::fastcdr::Cdr &cdr)
	This function deserializes an object using CDR serialization. More...
RTPS_DllAPI void	serializeKey (eprosima::fastcdr::Cdr &cdr) const
	This function serializes the key members of an object using CDR serialization. More...
RTPS_DllAPI bool	operator== (const ExtendedAnnotationParameterValue &) const

Static Public Member Functions
static RTPS_DllAPI size_t	getCdrSerializedSize (const ExtendedAnnotationParameterValue &data, size_t current_alignment=0)
	This function returns the serialized size of a data depending on the buffer alignment. More...
static RTPS_DllAPI 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 RTPS_DllAPI bool	isKeyDefined ()
	This function tells you if the Key has been defined for this type. More...

Detailed Description

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

Constructor & Destructor Documentation

ExtendedAnnotationParameterValue() [1/3]

RTPS_DllAPI ExtendedAnnotationParameterValue

(

)

Default constructor.

~ExtendedAnnotationParameterValue()

RTPS_DllAPI ~ExtendedAnnotationParameterValue

(

)

Default destructor.

ExtendedAnnotationParameterValue() [2/3]

RTPS_DllAPI ExtendedAnnotationParameterValue

(

const ExtendedAnnotationParameterValue &

x

)

Copy constructor.

Parameters

x	Reference to the object ExtendedAnnotationParameterValue that will be copied.

ExtendedAnnotationParameterValue() [3/3]

RTPS_DllAPI ExtendedAnnotationParameterValue

(

ExtendedAnnotationParameterValue &&

x

)

Move constructor.

Parameters

x	Reference to the object ExtendedAnnotationParameterValue that will be copied.

Member Function Documentation

deserialize()

RTPS_DllAPI void deserialize

(

eprosima::fastcdr::Cdr &

cdr

)

This function deserializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

getCdrSerializedSize()

static RTPS_DllAPI size_t getCdrSerializedSize ( const ExtendedAnnotationParameterValue &  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 RTPS_DllAPI size_t 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.

isKeyDefined()

static RTPS_DllAPI bool isKeyDefined ( )

static

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

operator=() [1/2]

RTPS_DllAPI ExtendedAnnotationParameterValue& operator=

(

const ExtendedAnnotationParameterValue &

x

)

Copy assignment.

Parameters

x	Reference to the object ExtendedAnnotationParameterValue that will be copied.

operator=() [2/2]

RTPS_DllAPI ExtendedAnnotationParameterValue& operator=

(

ExtendedAnnotationParameterValue &&

x

)

Move assignment.

Parameters

x	Reference to the object ExtendedAnnotationParameterValue that will be copied.

operator==()

RTPS_DllAPI bool operator== ( const ExtendedAnnotationParameterValue &  ) const

inline

serialize()

RTPS_DllAPI void serialize

(

eprosima::fastcdr::Cdr &

cdr

)

const

This function serializes an object using CDR serialization.

Parameters

cdr	CDR serialization object.

serializeKey()

RTPS_DllAPI void serializeKey

(

eprosima::fastcdr::Cdr &

cdr

)

const

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

Parameters

cdr	CDR serialization object.

---

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

• include/fastrtps/types/AnnotationParameterValue.h