Fast DDS  Version 3.0.1
Fast DDS
Loading...
Searching...
No Matches
PlainCollectionHeader Class Reference

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

#include <dds_xtypes_typeobject.hpp>

Public Member Functions

eProsima_user_DllExport PlainCollectionHeader ()
 Default constructor.
 
eProsima_user_DllExport ~PlainCollectionHeader ()
 Default destructor.
 
eProsima_user_DllExport PlainCollectionHeader (const PlainCollectionHeader &x)
 Copy constructor.
 
eProsima_user_DllExport PlainCollectionHeader (PlainCollectionHeader &&x) noexcept
 Move constructor.
 
eProsima_user_DllExport PlainCollectionHeaderoperator= (const PlainCollectionHeader &x)
 Copy assignment.
 
eProsima_user_DllExport PlainCollectionHeaderoperator= (PlainCollectionHeader &&x) noexcept
 Move assignment.
 
eProsima_user_DllExport bool operator== (const PlainCollectionHeader &x) const
 Comparison operator.
 
eProsima_user_DllExport bool operator!= (const PlainCollectionHeader &x) const
 Comparison operator.
 
eProsima_user_DllExport void equiv_kind (EquivalenceKind _equiv_kind)
 This function sets a value in member equiv_kind.
 
eProsima_user_DllExport EquivalenceKind equiv_kind () const
 This function returns the value of member equiv_kind.
 
eProsima_user_DllExport EquivalenceKindequiv_kind ()
 This function returns a reference to member equiv_kind.
 
eProsima_user_DllExport void element_flags (const CollectionElementFlag &_element_flags)
 This function copies the value in member element_flags.
 
eProsima_user_DllExport void element_flags (CollectionElementFlag &&_element_flags)
 This function moves the value in member element_flags.
 
eProsima_user_DllExport const CollectionElementFlagelement_flags () const
 This function returns a constant reference to member element_flags.
 
eProsima_user_DllExport CollectionElementFlagelement_flags ()
 This function returns a reference to member element_flags.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PlainCollectionHeader() [1/3]

eProsima_user_DllExport PlainCollectionHeader ( )
inline

Default constructor.

◆ ~PlainCollectionHeader()

eProsima_user_DllExport ~PlainCollectionHeader ( )
inline

Default destructor.

◆ PlainCollectionHeader() [2/3]

eProsima_user_DllExport PlainCollectionHeader ( const PlainCollectionHeader x)
inline

Copy constructor.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

◆ PlainCollectionHeader() [3/3]

eProsima_user_DllExport PlainCollectionHeader ( PlainCollectionHeader &&  x)
inlinenoexcept

Move constructor.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

Member Function Documentation

◆ element_flags() [1/4]

eProsima_user_DllExport CollectionElementFlag & element_flags ( )
inline

This function returns a reference to member element_flags.

Returns
Reference to member element_flags

◆ element_flags() [2/4]

eProsima_user_DllExport const CollectionElementFlag & element_flags ( ) const
inline

This function returns a constant reference to member element_flags.

Returns
Constant reference to member element_flags

◆ element_flags() [3/4]

eProsima_user_DllExport void element_flags ( CollectionElementFlag &&  _element_flags)
inline

This function moves the value in member element_flags.

Parameters
_element_flagsNew value to be moved in member element_flags

◆ element_flags() [4/4]

eProsima_user_DllExport void element_flags ( const CollectionElementFlag _element_flags)
inline

This function copies the value in member element_flags.

Parameters
_element_flagsNew value to be copied in member element_flags

◆ equiv_kind() [1/3]

eProsima_user_DllExport EquivalenceKind & equiv_kind ( )
inline

This function returns a reference to member equiv_kind.

Returns
Reference to member equiv_kind

◆ equiv_kind() [2/3]

eProsima_user_DllExport EquivalenceKind equiv_kind ( ) const
inline

This function returns the value of member equiv_kind.

Returns
Value of member equiv_kind

◆ equiv_kind() [3/3]

eProsima_user_DllExport 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!=()

eProsima_user_DllExport bool operator!= ( const PlainCollectionHeader x) const
inline

Comparison operator.

Parameters
xPlainCollectionHeader object to compare.

◆ operator=() [1/2]

eProsima_user_DllExport PlainCollectionHeader & operator= ( const PlainCollectionHeader x)
inline

Copy assignment.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

◆ operator=() [2/2]

eProsima_user_DllExport PlainCollectionHeader & operator= ( PlainCollectionHeader &&  x)
inlinenoexcept

Move assignment.

Parameters
xReference to the object PlainCollectionHeader that will be copied.

◆ operator==()

eProsima_user_DllExport bool operator== ( const PlainCollectionHeader x) const
inline

Comparison operator.

Parameters
xPlainCollectionHeader object to compare.

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