Fast RTPS  Version 2.14.1
Fast RTPS
Loading...
Searching...
No Matches
AnnotationParameterValue Class Reference

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

#include <AnnotationParameterValue.h>

Public Member Functions

RTPS_DllAPI AnnotationParameterValue ()
 Default constructor.
 
RTPS_DllAPI ~AnnotationParameterValue ()
 Default destructor.
 
RTPS_DllAPI AnnotationParameterValue (const AnnotationParameterValue &x)
 Copy constructor.
 
RTPS_DllAPI AnnotationParameterValue (AnnotationParameterValue &&x)
 Move constructor.
 
RTPS_DllAPI AnnotationParameterValueoperator= (const AnnotationParameterValue &x)
 Copy assignment.
 
RTPS_DllAPI AnnotationParameterValueoperator= (AnnotationParameterValue &&x)
 Move assignment.
 
RTPS_DllAPI void _d (char __d)
 This function sets the discriminator value.
 
RTPS_DllAPI char _d () const
 This function returns the value of the discriminator.
 
RTPS_DllAPI char & _d ()
 This function returns a reference to the discriminator.
 
RTPS_DllAPI void boolean_value (bool _boolean_value)
 This function sets a value in member boolean_value.
 
RTPS_DllAPI bool boolean_value () const
 This function returns the value of member boolean_value.
 
RTPS_DllAPI bool & boolean_value ()
 This function returns a reference to member boolean_value.
 
RTPS_DllAPI void byte_value (uint8_t _byte_value)
 This function sets a value in member byte_value.
 
RTPS_DllAPI uint8_t byte_value () const
 This function returns the value of member byte_value.
 
RTPS_DllAPI uint8_t & byte_value ()
 This function returns a reference to member byte_value.
 
RTPS_DllAPI void int16_value (int16_t _int16_value)
 This function sets a value in member int16_value.
 
RTPS_DllAPI int16_t int16_value () const
 This function returns the value of member int16_value.
 
RTPS_DllAPI int16_t & int16_value ()
 This function returns a 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.
 
RTPS_DllAPI uint16_t uint_16_value () const
 This function returns the value of member uint_16_value.
 
RTPS_DllAPI uint16_t & uint_16_value ()
 This function returns a reference to member uint_16_value.
 
RTPS_DllAPI void int32_value (int32_t _int32_value)
 This function sets a value in member int32_value.
 
RTPS_DllAPI int32_t int32_value () const
 This function returns the value of member int32_value.
 
RTPS_DllAPI int32_t & int32_value ()
 This function returns a reference to member int32_value.
 
RTPS_DllAPI void uint32_value (uint32_t _uint32_value)
 This function sets a value in member uint32_value.
 
RTPS_DllAPI uint32_t uint32_value () const
 This function returns the value of member uint32_value.
 
RTPS_DllAPI uint32_t & uint32_value ()
 This function returns a reference to member uint32_value.
 
RTPS_DllAPI void int64_value (int64_t _int64_value)
 This function sets a value in member int64_value.
 
RTPS_DllAPI int64_t int64_value () const
 This function returns the value of member int64_value.
 
RTPS_DllAPI int64_t & int64_value ()
 This function returns a reference to member int64_value.
 
RTPS_DllAPI void uint64_value (uint64_t _uint64_value)
 This function sets a value in member uint64_value.
 
RTPS_DllAPI uint64_t uint64_value () const
 This function returns the value of member uint64_value.
 
RTPS_DllAPI uint64_t & uint64_value ()
 This function returns a reference to member uint64_value.
 
RTPS_DllAPI void float32_value (float _float32_value)
 This function sets a value in member float32_value.
 
RTPS_DllAPI float float32_value () const
 This function returns the value of member float32_value.
 
RTPS_DllAPI float & float32_value ()
 This function returns a reference to member float32_value.
 
RTPS_DllAPI void float64_value (double _float64_value)
 This function sets a value in member float64_value.
 
RTPS_DllAPI double float64_value () const
 This function returns the value of member float64_value.
 
RTPS_DllAPI double & float64_value ()
 This function returns a reference to member float64_value.
 
RTPS_DllAPI void float128_value (long double _float128_value)
 This function sets a value in member float128_value.
 
RTPS_DllAPI long double float128_value () const
 This function returns the value of member float128_value.
 
RTPS_DllAPI long double & float128_value ()
 This function returns a reference to member float128_value.
 
RTPS_DllAPI void char_value (char _char_value)
 This function sets a value in member char_value.
 
RTPS_DllAPI char char_value () const
 This function returns the value of member char_value.
 
RTPS_DllAPI char & char_value ()
 This function returns a reference to member char_value.
 
RTPS_DllAPI void wchar_value (wchar_t _wchar_value)
 This function sets a value in member wchar_value.
 
RTPS_DllAPI wchar_t wchar_value () const
 This function returns the value of member wchar_value.
 
RTPS_DllAPI wchar_t & wchar_value ()
 This function returns a reference to member wchar_value.
 
RTPS_DllAPI void enumerated_value (int32_t _enumerated_value)
 This function sets a value in member enumerated_value.
 
RTPS_DllAPI int32_t enumerated_value () const
 This function returns the value of member enumerated_value.
 
RTPS_DllAPI int32_t & enumerated_value ()
 This function returns a reference to member enumerated_value.
 
RTPS_DllAPI void string8_value (const std::string &_string8_value)
 This function copies the value in member string8_value.
 
RTPS_DllAPI void string8_value (std::string &&_string8_value)
 This function moves the value in member string8_value.
 
RTPS_DllAPI const std::string & string8_value () const
 This function returns a constant reference to member string8_value.
 
RTPS_DllAPI std::string & string8_value ()
 This function returns a reference to member string8_value.
 
RTPS_DllAPI void string16_value (const std::wstring &_string16_value)
 This function copies the value in member string16_value.
 
RTPS_DllAPI void string16_value (std::wstring &&_string16_value)
 This function moves the value in member string16_value.
 
RTPS_DllAPI const std::wstring & string16_value () const
 This function returns a constant reference to member string16_value.
 
RTPS_DllAPI std::wstring & string16_value ()
 This function returns a reference to member string16_value.
 
RTPS_DllAPI void extended_value (const ExtendedAnnotationParameterValue &_extended_value)
 This function copies the value in member extended_value.
 
RTPS_DllAPI void extended_value (ExtendedAnnotationParameterValue &&_extended_value)
 This function moves the value in member extended_value.
 
RTPS_DllAPI const ExtendedAnnotationParameterValueextended_value () const
 This function returns a constant reference to member extended_value.
 
RTPS_DllAPI ExtendedAnnotationParameterValueextended_value ()
 This function returns a reference to member extended_value.
 
RTPS_DllAPI void serializeKey (eprosima::fastcdr::Cdr &cdr) const
 This function serializes the key members of an object using CDR serialization.
 
RTPS_DllAPI bool operator== (const AnnotationParameterValue &other) const
 
RTPS_DllAPI std::string to_string () const
 Aux method to return value as its string representation.
 
RTPS_DllAPI void from_string (const std::string &value)
 Aux method to set value from its string representation.
 

Static Public Member Functions

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.
 
static RTPS_DllAPI bool isKeyDefined ()
 This function tells you if the Key has been defined for this type.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ AnnotationParameterValue() [1/3]

RTPS_DllAPI AnnotationParameterValue ( )

Default constructor.

◆ ~AnnotationParameterValue()

RTPS_DllAPI ~AnnotationParameterValue ( )

Default destructor.

◆ AnnotationParameterValue() [2/3]

Copy constructor.

Parameters
xReference to the object AnnotationParameterValue that will be copied.

◆ AnnotationParameterValue() [3/3]

Move constructor.

Parameters
xReference to the object AnnotationParameterValue that will be copied.

Member Function Documentation

◆ _d() [1/3]

RTPS_DllAPI char & _d ( )

This function returns a reference to the discriminator.

Returns
Reference to the discriminator.

◆ _d() [2/3]

RTPS_DllAPI char _d ( ) const

This function returns the value of the discriminator.

Returns
Value of the discriminator

◆ _d() [3/3]

RTPS_DllAPI void _d ( char  __d)

This function sets the discriminator value.

Parameters
__dNew value for the discriminator.
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the new value doesn't correspond to the selected union member.

◆ boolean_value() [1/3]

RTPS_DllAPI bool & boolean_value ( )

This function returns a reference to member boolean_value.

Returns
Reference to member boolean_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ boolean_value() [2/3]

RTPS_DllAPI bool boolean_value ( ) const

This function returns the value of member boolean_value.

Returns
Value of member boolean_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ boolean_value() [3/3]

RTPS_DllAPI void boolean_value ( bool  _boolean_value)

This function sets a value in member boolean_value.

Parameters
_boolean_valueNew value for member boolean_value

◆ byte_value() [1/3]

RTPS_DllAPI uint8_t & byte_value ( )

This function returns a reference to member byte_value.

Returns
Reference to member byte_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ byte_value() [2/3]

RTPS_DllAPI uint8_t byte_value ( ) const

This function returns the value of member byte_value.

Returns
Value of member byte_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ byte_value() [3/3]

RTPS_DllAPI void byte_value ( uint8_t  _byte_value)

This function sets a value in member byte_value.

Parameters
_byte_valueNew value for member byte_value

◆ char_value() [1/3]

RTPS_DllAPI char & char_value ( )

This function returns a reference to member char_value.

Returns
Reference to member char_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ char_value() [2/3]

RTPS_DllAPI char char_value ( ) const

This function returns the value of member char_value.

Returns
Value of member char_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ char_value() [3/3]

RTPS_DllAPI void char_value ( char  _char_value)

This function sets a value in member char_value.

Parameters
_char_valueNew value for member char_value

◆ enumerated_value() [1/3]

RTPS_DllAPI int32_t & enumerated_value ( )

This function returns a reference to member enumerated_value.

Returns
Reference to member enumerated_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ enumerated_value() [2/3]

RTPS_DllAPI int32_t enumerated_value ( ) const

This function returns the value of member enumerated_value.

Returns
Value of member enumerated_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ enumerated_value() [3/3]

RTPS_DllAPI void enumerated_value ( int32_t  _enumerated_value)

This function sets a value in member enumerated_value.

Parameters
_enumerated_valueNew value for member enumerated_value

◆ extended_value() [1/4]

RTPS_DllAPI ExtendedAnnotationParameterValue & extended_value ( )

This function returns a reference to member extended_value.

Returns
Reference to member extended_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ extended_value() [2/4]

RTPS_DllAPI const ExtendedAnnotationParameterValue & extended_value ( ) const

This function returns a constant reference to member extended_value.

Returns
Constant reference to member extended_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ extended_value() [3/4]

RTPS_DllAPI void extended_value ( const ExtendedAnnotationParameterValue _extended_value)

This function copies the value in member extended_value.

Parameters
_extended_valueNew value to be copied in member extended_value

◆ extended_value() [4/4]

RTPS_DllAPI void extended_value ( ExtendedAnnotationParameterValue &&  _extended_value)

This function moves the value in member extended_value.

Parameters
_extended_valueNew value to be moved in member extended_value

◆ float128_value() [1/3]

RTPS_DllAPI long double & float128_value ( )

This function returns a reference to member float128_value.

Returns
Reference to member float128_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ float128_value() [2/3]

RTPS_DllAPI long double float128_value ( ) const

This function returns the value of member float128_value.

Returns
Value of member float128_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ float128_value() [3/3]

RTPS_DllAPI void float128_value ( long double  _float128_value)

This function sets a value in member float128_value.

Parameters
_float128_valueNew value for member float128_value

◆ float32_value() [1/3]

RTPS_DllAPI float & float32_value ( )

This function returns a reference to member float32_value.

Returns
Reference to member float32_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ float32_value() [2/3]

RTPS_DllAPI float float32_value ( ) const

This function returns the value of member float32_value.

Returns
Value of member float32_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ float32_value() [3/3]

RTPS_DllAPI void float32_value ( float  _float32_value)

This function sets a value in member float32_value.

Parameters
_float32_valueNew value for member float32_value

◆ float64_value() [1/3]

RTPS_DllAPI double & float64_value ( )

This function returns a reference to member float64_value.

Returns
Reference to member float64_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ float64_value() [2/3]

RTPS_DllAPI double float64_value ( ) const

This function returns the value of member float64_value.

Returns
Value of member float64_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ float64_value() [3/3]

RTPS_DllAPI void float64_value ( double  _float64_value)

This function sets a value in member float64_value.

Parameters
_float64_valueNew value for member float64_value

◆ from_string()

RTPS_DllAPI void from_string ( const std::string &  value)
inline

Aux method to set value from its string representation.

◆ getKeyMaxCdrSerializedSize()

static RTPS_DllAPI size_t getKeyMaxCdrSerializedSize ( size_t  current_alignment = 0)
static

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

Parameters
current_alignmentBuffer alignment.
Returns
Maximum serialized size.

◆ int16_value() [1/3]

RTPS_DllAPI int16_t & int16_value ( )

This function returns a reference to member int16_value.

Returns
Reference to member int16_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ int16_value() [2/3]

RTPS_DllAPI int16_t int16_value ( ) const

This function returns the value of member int16_value.

Returns
Value of member int16_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ int16_value() [3/3]

RTPS_DllAPI void int16_value ( int16_t  _int16_value)

This function sets a value in member int16_value.

Parameters
_int16_valueNew value for member int16_value

◆ int32_value() [1/3]

RTPS_DllAPI int32_t & int32_value ( )

This function returns a reference to member int32_value.

Returns
Reference to member int32_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ int32_value() [2/3]

RTPS_DllAPI int32_t int32_value ( ) const

This function returns the value of member int32_value.

Returns
Value of member int32_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ int32_value() [3/3]

RTPS_DllAPI void int32_value ( int32_t  _int32_value)

This function sets a value in member int32_value.

Parameters
_int32_valueNew value for member int32_value

◆ int64_value() [1/3]

RTPS_DllAPI int64_t & int64_value ( )

This function returns a reference to member int64_value.

Returns
Reference to member int64_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ int64_value() [2/3]

RTPS_DllAPI int64_t int64_value ( ) const

This function returns the value of member int64_value.

Returns
Value of member int64_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ int64_value() [3/3]

RTPS_DllAPI void int64_value ( int64_t  _int64_value)

This function sets a value in member int64_value.

Parameters
_int64_valueNew value for member int64_value

◆ isKeyDefined()

static RTPS_DllAPI bool isKeyDefined ( )
static

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

◆ operator=() [1/2]

RTPS_DllAPI AnnotationParameterValue & operator= ( AnnotationParameterValue &&  x)

Move assignment.

Parameters
xReference to the object AnnotationParameterValue that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI AnnotationParameterValue & operator= ( const AnnotationParameterValue x)

Copy assignment.

Parameters
xReference to the object AnnotationParameterValue that will be copied.

◆ operator==()

RTPS_DllAPI bool operator== ( const AnnotationParameterValue other) const

◆ serializeKey()

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

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

Parameters
cdrCDR serialization object.

◆ string16_value() [1/4]

RTPS_DllAPI std::wstring & string16_value ( )

This function returns a reference to member string16_value.

Returns
Reference to member string16_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ string16_value() [2/4]

RTPS_DllAPI const std::wstring & string16_value ( ) const

This function returns a constant reference to member string16_value.

Returns
Constant reference to member string16_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ string16_value() [3/4]

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

This function copies the value in member string16_value.

Parameters
_string16_valueNew value to be copied in member string16_value

◆ string16_value() [4/4]

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

This function moves the value in member string16_value.

Parameters
_string16_valueNew value to be moved in member string16_value

◆ string8_value() [1/4]

RTPS_DllAPI std::string & string8_value ( )

This function returns a reference to member string8_value.

Returns
Reference to member string8_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ string8_value() [2/4]

RTPS_DllAPI const std::string & string8_value ( ) const

This function returns a constant reference to member string8_value.

Returns
Constant reference to member string8_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ string8_value() [3/4]

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

This function copies the value in member string8_value.

Parameters
_string8_valueNew value to be copied in member string8_value

◆ string8_value() [4/4]

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

This function moves the value in member string8_value.

Parameters
_string8_valueNew value to be moved in member string8_value

◆ to_string()

RTPS_DllAPI std::string to_string ( ) const
inline

Aux method to return value as its string representation.

◆ uint32_value() [1/3]

RTPS_DllAPI uint32_t & uint32_value ( )

This function returns a reference to member uint32_value.

Returns
Reference to member uint32_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ uint32_value() [2/3]

RTPS_DllAPI uint32_t uint32_value ( ) const

This function returns the value of member uint32_value.

Returns
Value of member uint32_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ uint32_value() [3/3]

RTPS_DllAPI void uint32_value ( uint32_t  _uint32_value)

This function sets a value in member uint32_value.

Parameters
_uint32_valueNew value for member uint32_value

◆ uint64_value() [1/3]

RTPS_DllAPI uint64_t & uint64_value ( )

This function returns a reference to member uint64_value.

Returns
Reference to member uint64_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ uint64_value() [2/3]

RTPS_DllAPI uint64_t uint64_value ( ) const

This function returns the value of member uint64_value.

Returns
Value of member uint64_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ uint64_value() [3/3]

RTPS_DllAPI void uint64_value ( uint64_t  _uint64_value)

This function sets a value in member uint64_value.

Parameters
_uint64_valueNew value for member uint64_value

◆ uint_16_value() [1/3]

RTPS_DllAPI uint16_t & uint_16_value ( )

This function returns a reference to member uint_16_value.

Returns
Reference to member uint_16_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ uint_16_value() [2/3]

RTPS_DllAPI uint16_t uint_16_value ( ) const

This function returns the value of member uint_16_value.

Returns
Value of member uint_16_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ uint_16_value() [3/3]

RTPS_DllAPI void uint_16_value ( uint16_t  _uint_16_value)

This function sets a value in member uint_16_value.

Parameters
_uint_16_valueNew value for member uint_16_value

◆ wchar_value() [1/3]

RTPS_DllAPI wchar_t & wchar_value ( )

This function returns a reference to member wchar_value.

Returns
Reference to member wchar_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ wchar_value() [2/3]

RTPS_DllAPI wchar_t wchar_value ( ) const

This function returns the value of member wchar_value.

Returns
Value of member wchar_value
Exceptions
eprosima::fastcdr::BadParamExceptionThis exception is thrown if the requested union member is not the current selection.

◆ wchar_value() [3/3]

RTPS_DllAPI void wchar_value ( wchar_t  _wchar_value)

This function sets a value in member wchar_value.

Parameters
_wchar_valueNew value for member wchar_value

The documentation for this class was generated from the following file: