Class AnnotationParameterValue

Defined in File AnnotationParameterValue.h

Class Documentation

class AnnotationParameterValue

This class represents the union AnnotationParameterValue defined by the user in the IDL file.

Public Functions

RTPS_DllAPI AnnotationParameterValue(): Default constructor.

RTPS_DllAPI ~AnnotationParameterValue(): Default destructor.

RTPS_DllAPI AnnotationParameterValue(const AnnotationParameterValue &x)

Copy constructor.

Parameters: x – Reference to the object AnnotationParameterValue that will be copied.

RTPS_DllAPI AnnotationParameterValue(AnnotationParameterValue &&x)

Move constructor.

Parameters: x – Reference to the object AnnotationParameterValue that will be copied.

RTPS_DllAPI AnnotationParameterValue & operator= (const AnnotationParameterValue &x)

Copy assignment.

Parameters: x – Reference to the object AnnotationParameterValue that will be copied.

RTPS_DllAPI AnnotationParameterValue & operator= (AnnotationParameterValue &&x)

Move assignment.

Parameters: x – Reference to the object AnnotationParameterValue that will be copied.

RTPS_DllAPI void _d (char __d)

This function sets the discriminator value.

Parameters: __d – New value for the discriminator.
Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the new value doesn’t correspond to the selected union member.

RTPS_DllAPI char _d () const

This function returns the value of the discriminator.

Returns: Value of the discriminator

RTPS_DllAPI char & _d ()

This function returns a reference to the discriminator.

Returns: Reference to the discriminator.

RTPS_DllAPI void boolean_value (bool _boolean_value)

This function sets a value in member boolean_value.

Parameters: _boolean_value – New value for member boolean_value

RTPS_DllAPI bool boolean_value () const

This function returns the value of member boolean_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member boolean_value

RTPS_DllAPI bool & boolean_value ()

This function returns a reference to member boolean_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member boolean_value

RTPS_DllAPI void byte_value (uint8_t _byte_value)

This function sets a value in member byte_value.

Parameters: _byte_value – New value for member byte_value

RTPS_DllAPI uint8_t byte_value () const

This function returns the value of member byte_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member byte_value

RTPS_DllAPI uint8_t & byte_value ()

This function returns a reference to member byte_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member byte_value

RTPS_DllAPI void int16_value (int16_t _int16_value)

This function sets a value in member int16_value.

Parameters: _int16_value – New value for member int16_value

RTPS_DllAPI int16_t int16_value () const

This function returns the value of member int16_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member int16_value

RTPS_DllAPI int16_t & int16_value ()

This function returns a reference to member int16_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member int16_value

RTPS_DllAPI void uint_16_value (uint16_t _uint_16_value)

This function sets a value in member uint_16_value.

Parameters: _uint_16_value – New value for member uint_16_value

RTPS_DllAPI uint16_t uint_16_value () const

This function returns the value of member uint_16_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member uint_16_value

RTPS_DllAPI uint16_t & uint_16_value ()

This function returns a reference to member uint_16_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member uint_16_value

RTPS_DllAPI void int32_value (int32_t _int32_value)

This function sets a value in member int32_value.

Parameters: _int32_value – New value for member int32_value

RTPS_DllAPI int32_t int32_value () const

This function returns the value of member int32_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member int32_value

RTPS_DllAPI int32_t & int32_value ()

This function returns a reference to member int32_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member int32_value

RTPS_DllAPI void uint32_value (uint32_t _uint32_value)

This function sets a value in member uint32_value.

Parameters: _uint32_value – New value for member uint32_value

RTPS_DllAPI uint32_t uint32_value () const

This function returns the value of member uint32_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member uint32_value

RTPS_DllAPI uint32_t & uint32_value ()

This function returns a reference to member uint32_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member uint32_value

RTPS_DllAPI void int64_value (int64_t _int64_value)

This function sets a value in member int64_value.

Parameters: _int64_value – New value for member int64_value

RTPS_DllAPI int64_t int64_value () const

This function returns the value of member int64_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member int64_value

RTPS_DllAPI int64_t & int64_value ()

This function returns a reference to member int64_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member int64_value

RTPS_DllAPI void uint64_value (uint64_t _uint64_value)

This function sets a value in member uint64_value.

Parameters: _uint64_value – New value for member uint64_value

RTPS_DllAPI uint64_t uint64_value () const

This function returns the value of member uint64_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member uint64_value

RTPS_DllAPI uint64_t & uint64_value ()

This function returns a reference to member uint64_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member uint64_value

RTPS_DllAPI void float32_value (float _float32_value)

This function sets a value in member float32_value.

Parameters: _float32_value – New value for member float32_value

RTPS_DllAPI float float32_value () const

This function returns the value of member float32_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member float32_value

RTPS_DllAPI float & float32_value ()

This function returns a reference to member float32_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member float32_value

RTPS_DllAPI void float64_value (double _float64_value)

This function sets a value in member float64_value.

Parameters: _float64_value – New value for member float64_value

RTPS_DllAPI double float64_value () const

This function returns the value of member float64_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member float64_value

RTPS_DllAPI double & float64_value ()

This function returns a reference to member float64_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member float64_value

RTPS_DllAPI void float128_value (long double _float128_value)

This function sets a value in member float128_value.

Parameters: _float128_value – New value for member float128_value

RTPS_DllAPI long double float128_value () const

This function returns the value of member float128_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member float128_value

RTPS_DllAPI long double & float128_value ()

This function returns a reference to member float128_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member float128_value

RTPS_DllAPI void char_value (char _char_value)

This function sets a value in member char_value.

Parameters: _char_value – New value for member char_value

RTPS_DllAPI char char_value () const

This function returns the value of member char_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member char_value

RTPS_DllAPI char & char_value ()

This function returns a reference to member char_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member char_value

RTPS_DllAPI void wchar_value (wchar_t _wchar_value)

This function sets a value in member wchar_value.

Parameters: _wchar_value – New value for member wchar_value

RTPS_DllAPI wchar_t wchar_value () const

This function returns the value of member wchar_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member wchar_value

RTPS_DllAPI wchar_t & wchar_value ()

This function returns a reference to member wchar_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member wchar_value

RTPS_DllAPI void enumerated_value (int32_t _enumerated_value)

This function sets a value in member enumerated_value.

Parameters: _enumerated_value – New value for member enumerated_value

RTPS_DllAPI int32_t enumerated_value () const

This function returns the value of member enumerated_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Value of member enumerated_value

RTPS_DllAPI int32_t & enumerated_value ()

This function returns a reference to member enumerated_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member enumerated_value

RTPS_DllAPI void string8_value (const std::string &_string8_value)

This function copies the value in member string8_value.

Parameters: _string8_value – New value to be copied in member string8_value

RTPS_DllAPI void string8_value (std::string &&_string8_value)

This function moves the value in member string8_value.

Parameters: _string8_value – New value to be moved in member string8_value

RTPS_DllAPI const std::string & string8_value () const

This function returns a constant reference to member string8_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Constant reference to member string8_value

RTPS_DllAPI std::string & string8_value ()

This function returns a reference to member string8_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member string8_value

RTPS_DllAPI void string16_value (const std::wstring &_string16_value)

This function copies the value in member string16_value.

Parameters: _string16_value – New value to be copied in member string16_value

RTPS_DllAPI void string16_value (std::wstring &&_string16_value)

This function moves the value in member string16_value.

Parameters: _string16_value – New value to be moved in member string16_value

RTPS_DllAPI const std::wstring & string16_value () const

This function returns a constant reference to member string16_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Constant reference to member string16_value

RTPS_DllAPI std::wstring & string16_value ()

This function returns a reference to member string16_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member string16_value

RTPS_DllAPI void extended_value (const ExtendedAnnotationParameterValue &_extended_value)

This function copies the value in member extended_value.

Parameters: _extended_value – New value to be copied in member extended_value

RTPS_DllAPI void extended_value (ExtendedAnnotationParameterValue &&_extended_value)

This function moves the value in member extended_value.

Parameters: _extended_value – New value to be moved in member extended_value

RTPS_DllAPI const ExtendedAnnotationParameterValue & extended_value () const

This function returns a constant reference to member extended_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Constant reference to member extended_value

RTPS_DllAPI ExtendedAnnotationParameterValue & extended_value ()

This function returns a reference to member extended_value.

Throws: eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.
Returns: Reference to member extended_value

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 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 AnnotationParameterValue &other) const

inline RTPS_DllAPI std::string to_string () const: Aux method to return value as its string representation.

inline RTPS_DllAPI void from_string (const std::string &value): Aux method to set value from its string representation.

Public Static Functions

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

static RTPS_DllAPI size_t getKeyMaxCdrSerializedSize (size_t current_alignment=0)

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

Parameters: 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.