Fast RTPS  Version 2.5.1
Fast RTPS
PlainMapLTypeDefn Class Referencefinal

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

#include <TypeIdentifierTypes.h>

Public Member Functions

RTPS_DllAPI PlainMapLTypeDefn ()
 Default constructor. More...
 
RTPS_DllAPI ~PlainMapLTypeDefn ()
 Default destructor. More...
 
RTPS_DllAPI PlainMapLTypeDefn (const PlainMapLTypeDefn &x)
 Copy constructor. More...
 
RTPS_DllAPI PlainMapLTypeDefn (PlainMapLTypeDefn &&x)
 Move constructor. More...
 
RTPS_DllAPI PlainMapLTypeDefnoperator= (const PlainMapLTypeDefn &x)
 Copy assignment. More...
 
RTPS_DllAPI PlainMapLTypeDefnoperator= (PlainMapLTypeDefn &&x)
 Move assignment. More...
 
RTPS_DllAPI void header (const PlainCollectionHeader &_header)
 This function copies the value in member header. More...
 
RTPS_DllAPI void header (PlainCollectionHeader &&_header)
 This function moves the value in member header. More...
 
RTPS_DllAPI const PlainCollectionHeaderheader () const
 This function returns a constant reference to member header. More...
 
RTPS_DllAPI PlainCollectionHeaderheader ()
 This function returns a reference to member header. More...
 
RTPS_DllAPI void bound (LBound _bound)
 This function sets a value in member bound. More...
 
RTPS_DllAPI LBound bound () const
 This function returns the value of member bound. More...
 
RTPS_DllAPI LBoundbound ()
 This function returns a reference to member bound. More...
 
RTPS_DllAPI void element_identifier (const TypeIdentifier *_element_identifier)
 This function sets a value in member element_identifier. More...
 
RTPS_DllAPI const TypeIdentifierelement_identifier () const
 This function returns the value of member element_identifier. More...
 
RTPS_DllAPI TypeIdentifierelement_identifier ()
 This function returns a reference to member element_identifier. More...
 
RTPS_DllAPI void key_flags (CollectionElementFlag _key_flags)
 This function sets a value in member key_flags. More...
 
RTPS_DllAPI CollectionElementFlag key_flags () const
 This function returns the value of member key_flags. More...
 
RTPS_DllAPI CollectionElementFlagkey_flags ()
 This function returns a reference to member key_flags. More...
 
RTPS_DllAPI void key_identifier (const TypeIdentifier *_key_identifier)
 This function sets a value in member key_identifier. More...
 
RTPS_DllAPI const TypeIdentifierkey_identifier () const
 This function returns the value of member key_identifier. More...
 
RTPS_DllAPI TypeIdentifierkey_identifier ()
 This function returns a reference to member key_identifier. 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 PlainMapLTypeDefn &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 

Static Public Member Functions

static RTPS_DllAPI size_t getCdrSerializedSize (const PlainMapLTypeDefn &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 PlainMapLTypeDefn defined by the user in the IDL file.

Constructor & Destructor Documentation

◆ PlainMapLTypeDefn() [1/3]

RTPS_DllAPI PlainMapLTypeDefn ( )

Default constructor.

◆ ~PlainMapLTypeDefn()

RTPS_DllAPI ~PlainMapLTypeDefn ( )

Default destructor.

◆ PlainMapLTypeDefn() [2/3]

RTPS_DllAPI PlainMapLTypeDefn ( const PlainMapLTypeDefn x)

Copy constructor.

Parameters
xReference to the object PlainMapLTypeDefn that will be copied.

◆ PlainMapLTypeDefn() [3/3]

RTPS_DllAPI PlainMapLTypeDefn ( PlainMapLTypeDefn &&  x)

Move constructor.

Parameters
xReference to the object PlainMapLTypeDefn that will be copied.

Member Function Documentation

◆ bound() [1/3]

RTPS_DllAPI LBound& bound ( )
inline

This function returns a reference to member bound.

Returns
Reference to member bound

◆ bound() [2/3]

RTPS_DllAPI LBound bound ( ) const
inline

This function returns the value of member bound.

Returns
Value of member bound

◆ bound() [3/3]

RTPS_DllAPI void bound ( LBound  _bound)
inline

This function sets a value in member bound.

Parameters
_boundNew value for member bound

◆ consistent()

RTPS_DllAPI bool consistent ( const PlainMapLTypeDefn 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_identifier() [1/3]

RTPS_DllAPI TypeIdentifier* element_identifier ( )
inline

This function returns a reference to member element_identifier.

Returns
Reference to member element_identifier

◆ element_identifier() [2/3]

RTPS_DllAPI const TypeIdentifier* element_identifier ( ) const
inline

This function returns the value of member element_identifier.

Returns
Value of member element_identifier

◆ element_identifier() [3/3]

RTPS_DllAPI void element_identifier ( const TypeIdentifier _element_identifier)

This function sets a value in member element_identifier.

Parameters
_element_identifierNew value for member element_identifier

◆ getCdrSerializedSize()

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

◆ header() [1/4]

RTPS_DllAPI PlainCollectionHeader& header ( )
inline

This function returns a reference to member header.

Returns
Reference to member header

◆ header() [2/4]

RTPS_DllAPI const PlainCollectionHeader& header ( ) const
inline

This function returns a constant reference to member header.

Returns
Constant reference to member header

◆ header() [3/4]

RTPS_DllAPI void header ( const PlainCollectionHeader _header)
inline

This function copies the value in member header.

Parameters
_headerNew value to be copied in member header

◆ header() [4/4]

RTPS_DllAPI void header ( PlainCollectionHeader &&  _header)
inline

This function moves the value in member header.

Parameters
_headerNew value to be moved in member header

◆ key_flags() [1/3]

RTPS_DllAPI CollectionElementFlag& key_flags ( )
inline

This function returns a reference to member key_flags.

Returns
Reference to member key_flags

◆ key_flags() [2/3]

RTPS_DllAPI CollectionElementFlag key_flags ( ) const
inline

This function returns the value of member key_flags.

Returns
Value of member key_flags

◆ key_flags() [3/3]

RTPS_DllAPI void key_flags ( CollectionElementFlag  _key_flags)
inline

This function sets a value in member key_flags.

Parameters
_key_flagsNew value for member key_flags

◆ key_identifier() [1/3]

RTPS_DllAPI TypeIdentifier* key_identifier ( )
inline

This function returns a reference to member key_identifier.

Returns
Reference to member key_identifier

◆ key_identifier() [2/3]

RTPS_DllAPI const TypeIdentifier* key_identifier ( ) const
inline

This function returns the value of member key_identifier.

Returns
Value of member key_identifier

◆ key_identifier() [3/3]

RTPS_DllAPI void key_identifier ( const TypeIdentifier _key_identifier)

This function sets a value in member key_identifier.

Parameters
_key_identifierNew value for member key_identifier

◆ operator=() [1/2]

RTPS_DllAPI PlainMapLTypeDefn& operator= ( const PlainMapLTypeDefn x)

Copy assignment.

Parameters
xReference to the object PlainMapLTypeDefn that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI PlainMapLTypeDefn& operator= ( PlainMapLTypeDefn &&  x)

Move assignment.

Parameters
xReference to the object PlainMapLTypeDefn 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: