Class PlainMapLTypeDefn

• Defined in File TypeIdentifierTypes.h

Class Documentation

class PlainMapLTypeDefn

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

Public Functions

RTPS_DllAPI PlainMapLTypeDefn()

Default constructor.

RTPS_DllAPI ~PlainMapLTypeDefn()

Default destructor.

RTPS_DllAPI PlainMapLTypeDefn(const PlainMapLTypeDefn &x)

Copy constructor.

Parameters

x – Reference to the object PlainMapLTypeDefn that will be copied.

RTPS_DllAPI PlainMapLTypeDefn(PlainMapLTypeDefn &&x)

Move constructor.

Parameters

x – Reference to the object PlainMapLTypeDefn that will be copied.

RTPS_DllAPI PlainMapLTypeDefn & operator= (const PlainMapLTypeDefn &x)

Copy assignment.

Parameters

x – Reference to the object PlainMapLTypeDefn that will be copied.

RTPS_DllAPI PlainMapLTypeDefn & operator= (PlainMapLTypeDefn &&x)

Move assignment.

Parameters

x – Reference to the object PlainMapLTypeDefn that will be copied.

inline RTPS_DllAPI void header (const PlainCollectionHeader &_header)

This function copies the value in member header.

Parameters

_header – New value to be copied in member header

inline RTPS_DllAPI void header (PlainCollectionHeader &&_header)

This function moves the value in member header.

Parameters

_header – New value to be moved in member header

inline RTPS_DllAPI const PlainCollectionHeader & header () const

This function returns a constant reference to member header.

Returns

Constant reference to member header

inline RTPS_DllAPI PlainCollectionHeader & header ()

This function returns a reference to member header.

Returns

Reference to member header

inline RTPS_DllAPI void bound (LBound _bound)

This function sets a value in member bound.

Parameters

_bound – New value for member bound

inline RTPS_DllAPI LBound bound () const

This function returns the value of member bound.

Returns

Value of member bound

inline RTPS_DllAPI LBound & bound ()

This function returns a reference to member bound.

Returns

Reference to member bound

RTPS_DllAPI void element_identifier (const TypeIdentifier *_element_identifier)

This function sets a value in member element_identifier.

Parameters

_element_identifier – New value for member element_identifier

inline RTPS_DllAPI const TypeIdentifier * element_identifier () const

This function returns the value of member element_identifier.

Returns

Value of member element_identifier

inline RTPS_DllAPI TypeIdentifier * element_identifier ()

This function returns a reference to member element_identifier.

Returns

Reference to member element_identifier

inline RTPS_DllAPI void key_flags (CollectionElementFlag _key_flags)

This function sets a value in member key_flags.

Parameters

_key_flags – New value for member key_flags

inline RTPS_DllAPI CollectionElementFlag key_flags () const

This function returns the value of member key_flags.

Returns

Value of member key_flags

inline RTPS_DllAPI CollectionElementFlag & key_flags ()

This function returns a reference to member key_flags.

Returns

Reference to member key_flags

RTPS_DllAPI void key_identifier (const TypeIdentifier *_key_identifier)

This function sets a value in member key_identifier.

Parameters

_key_identifier – New value for member key_identifier

inline RTPS_DllAPI const TypeIdentifier * key_identifier () const

This function returns the value of member key_identifier.

Returns

Value of member key_identifier

inline RTPS_DllAPI TypeIdentifier * key_identifier ()

This function returns a reference to member key_identifier.

Returns

Reference to member key_identifier

RTPS_DllAPI void serialize (eprosima::fastcdr::Cdr &cdr) const

This function serializes an object using CDR serialization.

Parameters

cdr – CDR serialization object.

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

This function deserializes an object using CDR serialization.

Parameters

cdr – CDR serialization object.

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

Public Static 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.

Parameters

• data – Data which is calculated its serialized size.

• current_alignment – Buffer alignment.

Returns

Serialized size.