Class PlainMapSTypeDefn

Class Documentation

class PlainMapSTypeDefn

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

Public Functions

RTPS_DllAPI PlainMapSTypeDefn()

Default constructor.

RTPS_DllAPI ~PlainMapSTypeDefn()

Default destructor.

RTPS_DllAPI PlainMapSTypeDefn(const PlainMapSTypeDefn &x)

Copy constructor.

Parameters:

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

RTPS_DllAPI PlainMapSTypeDefn(PlainMapSTypeDefn &&x)

Move constructor.

Parameters:

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

RTPS_DllAPI PlainMapSTypeDefn & operator= (const PlainMapSTypeDefn &x)

Copy assignment.

Parameters:

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

RTPS_DllAPI PlainMapSTypeDefn & operator= (PlainMapSTypeDefn &&x)

Move assignment.

Parameters:

x – Reference to the object PlainMapSTypeDefn 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 (SBound _bound)

This function sets a value in member bound.

Parameters:

_bound – New value for member bound

inline RTPS_DllAPI SBound bound () const

This function returns the value of member bound.

Returns:

Value of member bound

inline RTPS_DllAPI SBound & 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

FASTDDS_SER_METHOD_DEPRECATED (3, "eprosima::fastrtps::types::PlainMapSTypeDefn::getCdrSerializedSize()", "In favor of version using eprosima::fastcdr::calculate_serialized_size.") RTPS_DllAPI static size_t getCdrSerializedSize(const PlainMapSTypeDefn &data

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.

FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::PlainMapSTypeDefn::serialize()", "In favor of version using eprosima::fastcdr::serialize.") RTPS_DllAPI void serialize(eprosima FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::PlainMapSTypeDefn::deserialize()", "In favor of version using eprosima::fastcdr::deserialize.") RTPS_DllAPI void deserialize(eprosima RTPS_DllAPI bool consistent (const PlainMapSTypeDefn &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const

This function serializes an object using CDR serialization.

This function deserializes an object using CDR serialization.

Parameters:

  • cdr – CDR serialization object.

  • cdr – CDR serialization object.

Public Members

size_t current_alignment   = 0)