Fast RTPS  Version 2.5.0
Fast RTPS
PlainCollectionHeader Class Referencefinal

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

#include <TypeIdentifierTypes.h>

Public Member Functions

RTPS_DllAPI PlainCollectionHeader ()
 Default constructor. More...
 
RTPS_DllAPI ~PlainCollectionHeader ()
 Default destructor. More...
 
RTPS_DllAPI PlainCollectionHeader (const PlainCollectionHeader &x)
 Copy constructor. More...
 
RTPS_DllAPI PlainCollectionHeader (PlainCollectionHeader &&x)
 Move constructor. More...
 
RTPS_DllAPI PlainCollectionHeaderoperator= (const PlainCollectionHeader &x)
 Copy assignment. More...
 
RTPS_DllAPI PlainCollectionHeaderoperator= (PlainCollectionHeader &&x)
 Move assignment. More...
 
RTPS_DllAPI void equiv_kind (EquivalenceKind _equiv_kind)
 This function sets a value in member equiv_kind. More...
 
RTPS_DllAPI EquivalenceKind equiv_kind () const
 This function returns the value of member equiv_kind. More...
 
RTPS_DllAPI EquivalenceKindequiv_kind ()
 This function returns a reference to member equiv_kind. More...
 
RTPS_DllAPI void element_flags (CollectionElementFlag _element_flags)
 This function sets a value in member element_flags. More...
 
RTPS_DllAPI CollectionElementFlag element_flags () const
 This function returns the value of member element_flags. More...
 
RTPS_DllAPI CollectionElementFlagelement_flags ()
 This function returns a reference to member element_flags. 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 consistent (const PlainCollectionHeader &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 

Static Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ PlainCollectionHeader() [1/3]

RTPS_DllAPI PlainCollectionHeader ( )

Default constructor.

◆ ~PlainCollectionHeader()

RTPS_DllAPI ~PlainCollectionHeader ( )

Default destructor.

◆ PlainCollectionHeader() [2/3]

RTPS_DllAPI PlainCollectionHeader ( const PlainCollectionHeader x)

Copy constructor.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

◆ PlainCollectionHeader() [3/3]

Move constructor.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

Member Function Documentation

◆ consistent()

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

◆ deserialize()

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

This function deserializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

◆ element_flags() [1/3]

RTPS_DllAPI CollectionElementFlag& element_flags ( )
inline

This function returns a reference to member element_flags.

Returns
Reference to member element_flags

◆ element_flags() [2/3]

RTPS_DllAPI CollectionElementFlag element_flags ( ) const
inline

This function returns the value of member element_flags.

Returns
Value of member element_flags

◆ element_flags() [3/3]

RTPS_DllAPI void element_flags ( CollectionElementFlag  _element_flags)
inline

This function sets a value in member element_flags.

Parameters
_element_flagsNew value for member element_flags

◆ equiv_kind() [1/3]

RTPS_DllAPI EquivalenceKind& equiv_kind ( )
inline

This function returns a reference to member equiv_kind.

Returns
Reference to member equiv_kind

◆ equiv_kind() [2/3]

RTPS_DllAPI EquivalenceKind equiv_kind ( ) const
inline

This function returns the value of member equiv_kind.

Returns
Value of member equiv_kind

◆ equiv_kind() [3/3]

RTPS_DllAPI void equiv_kind ( EquivalenceKind  _equiv_kind)
inline

This function sets a value in member equiv_kind.

Parameters
_equiv_kindNew value for member equiv_kind

◆ getCdrSerializedSize()

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

◆ operator=() [1/2]

RTPS_DllAPI PlainCollectionHeader& operator= ( const PlainCollectionHeader x)

Copy assignment.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI PlainCollectionHeader& operator= ( PlainCollectionHeader &&  x)

Move assignment.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

◆ 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: