Fast RTPS  Version 2.8.0
Fast RTPS
TypeObject Class Reference

#include <TypeObject.h>

Public Member Functions

RTPS_DllAPI TypeObject ()
 Default constructor. More...
 
RTPS_DllAPI ~TypeObject ()
 Default destructor. More...
 
RTPS_DllAPI TypeObject (const TypeObject &x)
 Copy constructor. More...
 
RTPS_DllAPI TypeObject (TypeObject &&x)
 Move constructor. More...
 
RTPS_DllAPI TypeObjectoperator= (const TypeObject &x)
 Copy assignment. More...
 
RTPS_DllAPI TypeObjectoperator= (TypeObject &&x)
 Move assignment. More...
 
RTPS_DllAPI void _d (uint8_t __d)
 This function sets the discriminator value. More...
 
RTPS_DllAPI uint8_t _d () const
 This function returns the value of the discriminator. More...
 
RTPS_DllAPI uint8_t & _d ()
 This function returns a reference to the discriminator. More...
 
RTPS_DllAPI void complete (const CompleteTypeObject &_complete)
 This function copies the value in member complete. More...
 
RTPS_DllAPI void complete (CompleteTypeObject &&_complete)
 This function moves the value in member complete. More...
 
RTPS_DllAPI const CompleteTypeObjectcomplete () const
 This function returns a constant reference to member complete. More...
 
RTPS_DllAPI CompleteTypeObjectcomplete ()
 This function returns a reference to member complete. More...
 
RTPS_DllAPI void minimal (const MinimalTypeObject &_minimal)
 This function copies the value in member minimal. More...
 
RTPS_DllAPI void minimal (MinimalTypeObject &&_minimal)
 This function moves the value in member minimal. More...
 
RTPS_DllAPI const MinimalTypeObjectminimal () const
 This function returns a constant reference to member minimal. More...
 
RTPS_DllAPI MinimalTypeObjectminimal ()
 This function returns a reference to member minimal. 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 bool operator== (const TypeObject &other) const
 
RTPS_DllAPI bool consistent (const TypeObject &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 This function check type consistency enforcement with the given TypeObject x. More...
 

Static Public Member Functions

static RTPS_DllAPI size_t getCdrSerializedSize (const TypeObject &data, size_t current_alignment=0)
 This function returns the serialized size of a data depending on the buffer alignment. More...
 

Constructor & Destructor Documentation

◆ TypeObject() [1/3]

RTPS_DllAPI TypeObject ( )

Default constructor.

◆ ~TypeObject()

RTPS_DllAPI ~TypeObject ( )

Default destructor.

◆ TypeObject() [2/3]

RTPS_DllAPI TypeObject ( const TypeObject x)

Copy constructor.

Parameters
xReference to the object TypeObject that will be copied.

◆ TypeObject() [3/3]

RTPS_DllAPI TypeObject ( TypeObject &&  x)

Move constructor.

Parameters
xReference to the object TypeObject that will be copied.

Member Function Documentation

◆ _d() [1/3]

RTPS_DllAPI uint8_t& _d ( )

This function returns a reference to the discriminator.

Returns
Reference to the discriminator.

◆ _d() [2/3]

RTPS_DllAPI uint8_t _d ( ) const

This function returns the value of the discriminator.

Returns
Value of the discriminator

◆ _d() [3/3]

RTPS_DllAPI void _d ( uint8_t  __d)

This function sets the discriminator value.

Parameters
__dNew value for the discriminator.
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the new value doesn't correspond to the selected union member.

◆ complete() [1/4]

RTPS_DllAPI CompleteTypeObject& complete ( )

This function returns a reference to member complete.

Returns
Reference to member complete
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ complete() [2/4]

RTPS_DllAPI const CompleteTypeObject& complete ( ) const

This function returns a constant reference to member complete.

Returns
Constant reference to member complete
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ complete() [3/4]

RTPS_DllAPI void complete ( CompleteTypeObject &&  _complete)

This function moves the value in member complete.

Parameters
_completeNew value to be moved in member complete

◆ complete() [4/4]

RTPS_DllAPI void complete ( const CompleteTypeObject _complete)

This function copies the value in member complete.

Parameters
_completeNew value to be copied in member complete

◆ consistent()

RTPS_DllAPI bool consistent ( const TypeObject x,
const fastdds::dds::TypeConsistencyEnforcementQosPolicy &  consistency 
) const

This function check type consistency enforcement with the given TypeObject x.

Parameters
xTypeObject to check if can be assigned to the current instance.
consistencyfastdds::dds::TypeConsistencyEnforcementQoSPolicy to apply.

◆ deserialize()

RTPS_DllAPI void deserialize ( eprosima::fastcdr::Cdr &  cdr)

This function deserializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

◆ getCdrSerializedSize()

static RTPS_DllAPI size_t getCdrSerializedSize ( const TypeObject data,
size_t  current_alignment = 0 
)
static

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

Parameters
dataData which is calculated its serialized size.
current_alignmentBuffer alignment.
Returns
Serialized size.

◆ minimal() [1/4]

RTPS_DllAPI MinimalTypeObject& minimal ( )

This function returns a reference to member minimal.

Returns
Reference to member minimal
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ minimal() [2/4]

RTPS_DllAPI const MinimalTypeObject& minimal ( ) const

This function returns a constant reference to member minimal.

Returns
Constant reference to member minimal
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ minimal() [3/4]

RTPS_DllAPI void minimal ( const MinimalTypeObject _minimal)

This function copies the value in member minimal.

Parameters
_minimalNew value to be copied in member minimal

◆ minimal() [4/4]

RTPS_DllAPI void minimal ( MinimalTypeObject &&  _minimal)

This function moves the value in member minimal.

Parameters
_minimalNew value to be moved in member minimal

◆ operator=() [1/2]

RTPS_DllAPI TypeObject& operator= ( const TypeObject x)

Copy assignment.

Parameters
xReference to the object TypeObject that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI TypeObject& operator= ( TypeObject &&  x)

Move assignment.

Parameters
xReference to the object TypeObject that will be copied.

◆ operator==()

RTPS_DllAPI bool operator== ( const TypeObject other) const

◆ serialize()

RTPS_DllAPI void serialize ( eprosima::fastcdr::Cdr &  cdr) const

This function serializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

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