Class AppliedAnnotationParameter

Class Documentation

class AppliedAnnotationParameter

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

Public Functions

RTPS_DllAPI AppliedAnnotationParameter()

Default constructor.

RTPS_DllAPI ~AppliedAnnotationParameter()

Default destructor.

RTPS_DllAPI AppliedAnnotationParameter(const AppliedAnnotationParameter &x)

Copy constructor.

Parameters:

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

RTPS_DllAPI AppliedAnnotationParameter(AppliedAnnotationParameter &&x)

Move constructor.

Parameters:

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

RTPS_DllAPI AppliedAnnotationParameter & operator= (const AppliedAnnotationParameter &x)

Copy assignment.

Parameters:

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

RTPS_DllAPI AppliedAnnotationParameter & operator= (AppliedAnnotationParameter &&x)

Move assignment.

Parameters:

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

inline void paramname_hash(const NameHash &_paramname_hash)

This function copies the value in member paramname_hash.

Parameters:

_paramname_hash – New value to be copied in member paramname_hash

inline void paramname_hash(NameHash &&_paramname_hash)

This function moves the value in member paramname_hash.

Parameters:

_paramname_hash – New value to be moved in member paramname_hash

inline const NameHash &paramname_hash() const

This function returns a constant reference to member paramname_hash.

Returns:

Constant reference to member paramname_hash

inline NameHash &paramname_hash()

This function returns a reference to member paramname_hash.

Returns:

Reference to member paramname_hash

inline void value(const AnnotationParameterValue &_value)

This function copies the value in member value.

Parameters:

_value – New value to be copied in member value

inline void value(AnnotationParameterValue &&_value)

This function moves the value in member value.

Parameters:

_value – New value to be moved in member value

inline const AnnotationParameterValue &value() const

This function returns a constant reference to member value.

Returns:

Constant reference to member value

inline AnnotationParameterValue &value()

This function returns a reference to member value.

Returns:

Reference to member value

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

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

This function serializes the key members of an object using CDR serialization.

Parameters:

cdr – CDR serialization object.

RTPS_DllAPI bool operator== (const AppliedAnnotationParameter &other) const

Public Members

size_t current_alignment   = 0)

Public Static Functions

static FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::AppliedAnnotationParameter::serialize()", "In favor of version using eprosima::fastcdr::serialize.") RTPS_DllAPI void serialize(eprosima FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::AppliedAnnotationParameter::deserialize()", "In favor of version using eprosima::fastcdr::deserialize.") RTPS_DllAPI void deserialize(eprosima RTPS_DllAPI size_t getKeyMaxCdrSerializedSize (size_t current_alignment=0)

This function serializes an object using CDR serialization.

This function deserializes an object using CDR serialization.

This function returns the maximum serialized size of the Key of an object depending on the buffer alignment.

Parameters:

  • cdr – CDR serialization object.

  • cdr – CDR serialization object.

  • current_alignment – Buffer alignment.

Returns:

Maximum serialized size.

static RTPS_DllAPI bool isKeyDefined ()

This function tells you if the Key has been defined for this type.