Fast DDS  Version 3.1.2
Fast DDS
Loading...
Searching...
No Matches

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

#include <dds_xtypes_typeobject.hpp>

Public Member Functions

eProsima_user_DllExport CommonBitfield ()
 Default constructor.
 
eProsima_user_DllExport ~CommonBitfield ()
 Default destructor.
 
eProsima_user_DllExport CommonBitfield (const CommonBitfield &x)
 Copy constructor.
 
eProsima_user_DllExport CommonBitfield (CommonBitfield &&x) noexcept
 Move constructor.
 
eProsima_user_DllExport CommonBitfieldoperator= (const CommonBitfield &x)
 Copy assignment.
 
eProsima_user_DllExport CommonBitfieldoperator= (CommonBitfield &&x) noexcept
 Move assignment.
 
eProsima_user_DllExport bool operator== (const CommonBitfield &x) const
 Comparison operator.
 
eProsima_user_DllExport bool operator!= (const CommonBitfield &x) const
 Comparison operator.
 
eProsima_user_DllExport void position (uint16_t _position)
 This function sets a value in member position.
 
eProsima_user_DllExport uint16_t position () const
 This function returns the value of member position.
 
eProsima_user_DllExport uint16_t & position ()
 This function returns a reference to member position.
 
eProsima_user_DllExport void flags (const BitsetMemberFlag &_flags)
 This function copies the value in member flags.
 
eProsima_user_DllExport void flags (BitsetMemberFlag &&_flags)
 This function moves the value in member flags.
 
eProsima_user_DllExport const BitsetMemberFlagflags () const
 This function returns a constant reference to member flags.
 
eProsima_user_DllExport BitsetMemberFlagflags ()
 This function returns a reference to member flags.
 
eProsima_user_DllExport void bitcount (uint8_t _bitcount)
 This function sets a value in member bitcount.
 
eProsima_user_DllExport uint8_t bitcount () const
 This function returns the value of member bitcount.
 
eProsima_user_DllExport uint8_t & bitcount ()
 This function returns a reference to member bitcount.
 
eProsima_user_DllExport void holder_type (TypeKind _holder_type)
 This function sets a value in member holder_type.
 
eProsima_user_DllExport TypeKind holder_type () const
 This function returns the value of member holder_type.
 
eProsima_user_DllExport TypeKindholder_type ()
 This function returns a reference to member holder_type.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CommonBitfield() [1/3]

eProsima_user_DllExport CommonBitfield ( )
inline

Default constructor.

◆ ~CommonBitfield()

eProsima_user_DllExport ~CommonBitfield ( )
inline

Default destructor.

◆ CommonBitfield() [2/3]

eProsima_user_DllExport CommonBitfield ( const CommonBitfield & x)
inline

Copy constructor.

Parameters
xReference to the object CommonBitfield that will be copied.

◆ CommonBitfield() [3/3]

eProsima_user_DllExport CommonBitfield ( CommonBitfield && x)
inlinenoexcept

Move constructor.

Parameters
xReference to the object CommonBitfield that will be copied.

Member Function Documentation

◆ bitcount() [1/3]

eProsima_user_DllExport uint8_t & bitcount ( )
inline

This function returns a reference to member bitcount.

Returns
Reference to member bitcount

◆ bitcount() [2/3]

eProsima_user_DllExport uint8_t bitcount ( ) const
inline

This function returns the value of member bitcount.

Returns
Value of member bitcount

◆ bitcount() [3/3]

eProsima_user_DllExport void bitcount ( uint8_t _bitcount)
inline

This function sets a value in member bitcount.

Parameters
_bitcountNew value for member bitcount

◆ flags() [1/4]

eProsima_user_DllExport BitsetMemberFlag & flags ( )
inline

This function returns a reference to member flags.

Returns
Reference to member flags

◆ flags() [2/4]

eProsima_user_DllExport const BitsetMemberFlag & flags ( ) const
inline

This function returns a constant reference to member flags.

Returns
Constant reference to member flags

◆ flags() [3/4]

eProsima_user_DllExport void flags ( BitsetMemberFlag && _flags)
inline

This function moves the value in member flags.

Parameters
_flagsNew value to be moved in member flags

◆ flags() [4/4]

eProsima_user_DllExport void flags ( const BitsetMemberFlag & _flags)
inline

This function copies the value in member flags.

Parameters
_flagsNew value to be copied in member flags

◆ holder_type() [1/3]

eProsima_user_DllExport TypeKind & holder_type ( )
inline

This function returns a reference to member holder_type.

Returns
Reference to member holder_type

◆ holder_type() [2/3]

eProsima_user_DllExport TypeKind holder_type ( ) const
inline

This function returns the value of member holder_type.

Returns
Value of member holder_type

◆ holder_type() [3/3]

eProsima_user_DllExport void holder_type ( TypeKind _holder_type)
inline

This function sets a value in member holder_type.

Parameters
_holder_typeNew value for member holder_type

◆ operator!=()

eProsima_user_DllExport bool operator!= ( const CommonBitfield & x) const
inline

Comparison operator.

Parameters
xCommonBitfield object to compare.

◆ operator=() [1/2]

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

Move assignment.

Parameters
xReference to the object CommonBitfield that will be copied.

◆ operator=() [2/2]

eProsima_user_DllExport CommonBitfield & operator= ( const CommonBitfield & x)
inline

Copy assignment.

Parameters
xReference to the object CommonBitfield that will be copied.

◆ operator==()

eProsima_user_DllExport bool operator== ( const CommonBitfield & x) const
inline

Comparison operator.

Parameters
xCommonBitfield object to compare.

◆ position() [1/3]

eProsima_user_DllExport uint16_t & position ( )
inline

This function returns a reference to member position.

Returns
Reference to member position

◆ position() [2/3]

eProsima_user_DllExport uint16_t position ( ) const
inline

This function returns the value of member position.

Returns
Value of member position

◆ position() [3/3]

eProsima_user_DllExport void position ( uint16_t _position)
inline

This function sets a value in member position.

Parameters
_positionNew value for member position

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