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

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

◆ 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

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

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