Class PlainCollectionHeader

Class Documentation

class PlainCollectionHeader

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

Public Functions

RTPS_DllAPI PlainCollectionHeader()

Default constructor.

RTPS_DllAPI ~PlainCollectionHeader()

Default destructor.

RTPS_DllAPI PlainCollectionHeader(const PlainCollectionHeader &x)

Copy constructor.

Parameters:

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

RTPS_DllAPI PlainCollectionHeader(PlainCollectionHeader &&x)

Move constructor.

Parameters:

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

RTPS_DllAPI PlainCollectionHeader & operator= (const PlainCollectionHeader &x)

Copy assignment.

Parameters:

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

RTPS_DllAPI PlainCollectionHeader & operator= (PlainCollectionHeader &&x)

Move assignment.

Parameters:

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

inline RTPS_DllAPI void equiv_kind (EquivalenceKind _equiv_kind)

This function sets a value in member equiv_kind.

Parameters:

_equiv_kind – New value for member equiv_kind

inline RTPS_DllAPI EquivalenceKind equiv_kind () const

This function returns the value of member equiv_kind.

Returns:

Value of member equiv_kind

inline RTPS_DllAPI EquivalenceKind & equiv_kind ()

This function returns a reference to member equiv_kind.

Returns:

Reference to member equiv_kind

inline RTPS_DllAPI void element_flags (CollectionElementFlag _element_flags)

This function sets a value in member element_flags.

Parameters:

_element_flags – New value for member element_flags

inline RTPS_DllAPI CollectionElementFlag element_flags () const

This function returns the value of member element_flags.

Returns:

Value of member element_flags

inline RTPS_DllAPI CollectionElementFlag & element_flags ()

This function returns a reference to member element_flags.

Returns:

Reference to member element_flags

FASTDDS_SER_METHOD_DEPRECATED (3, "eprosima::fastrtps::types::PlainCollectionHeader::getCdrSerializedSize()", "In favor of version using eprosima::fastcdr::calculate_serialized_size.") RTPS_DllAPI static size_t getCdrSerializedSize(const PlainCollectionHeader &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::PlainCollectionHeader::serialize()", "In favor of version using eprosima::fastcdr::serialize.") RTPS_DllAPI void serialize(eprosima FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::PlainCollectionHeader::deserialize()", "In favor of version using eprosima::fastcdr::deserialize.") RTPS_DllAPI void deserialize(eprosima RTPS_DllAPI bool consistent (const PlainCollectionHeader &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)