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

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

#include <AnnotationParameterValue.h>

Public Member Functions

RTPS_DllAPI AppliedAnnotationParameter ()
 Default constructor.
 
RTPS_DllAPI ~AppliedAnnotationParameter ()
 Default destructor.
 
RTPS_DllAPI AppliedAnnotationParameter (const AppliedAnnotationParameter &x)
 Copy constructor.
 
RTPS_DllAPI AppliedAnnotationParameter (AppliedAnnotationParameter &&x)
 Move constructor.
 
RTPS_DllAPI AppliedAnnotationParameteroperator= (const AppliedAnnotationParameter &x)
 Copy assignment.
 
RTPS_DllAPI AppliedAnnotationParameteroperator= (AppliedAnnotationParameter &&x)
 Move assignment.
 
void paramname_hash (const NameHash &_paramname_hash)
 This function copies the value in member paramname_hash.
 
void paramname_hash (NameHash &&_paramname_hash)
 This function moves the value in member paramname_hash.
 
const NameHashparamname_hash () const
 This function returns a constant reference to member paramname_hash.
 
NameHashparamname_hash ()
 This function returns a reference to member paramname_hash.
 
void value (const AnnotationParameterValue &_value)
 This function copies the value in member value.
 
void value (AnnotationParameterValue &&_value)
 This function moves the value in member value.
 
const AnnotationParameterValuevalue () const
 This function returns a constant reference to member value.
 
AnnotationParameterValuevalue ()
 This function returns a reference to member 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 AppliedAnnotationParameter &other) const
 

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 structure AppliedAnnotationParameter defined by the user in the IDL file.

Constructor & Destructor Documentation

◆ AppliedAnnotationParameter() [1/3]

RTPS_DllAPI AppliedAnnotationParameter ( )

Default constructor.

◆ ~AppliedAnnotationParameter()

RTPS_DllAPI ~AppliedAnnotationParameter ( )

Default destructor.

◆ AppliedAnnotationParameter() [2/3]

Copy constructor.

Parameters
xReference to the object AppliedAnnotationParameter that will be copied.

◆ AppliedAnnotationParameter() [3/3]

Move constructor.

Parameters
xReference to the object AppliedAnnotationParameter that will be copied.

Member Function Documentation

◆ 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.

◆ 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 AppliedAnnotationParameter & operator= ( AppliedAnnotationParameter &&  x)

Move assignment.

Parameters
xReference to the object AppliedAnnotationParameter that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI AppliedAnnotationParameter & operator= ( const AppliedAnnotationParameter x)

Copy assignment.

Parameters
xReference to the object AppliedAnnotationParameter that will be copied.

◆ operator==()

RTPS_DllAPI bool operator== ( const AppliedAnnotationParameter other) const

◆ paramname_hash() [1/4]

NameHash & paramname_hash ( )
inline

This function returns a reference to member paramname_hash.

Returns
Reference to member paramname_hash

◆ paramname_hash() [2/4]

const NameHash & paramname_hash ( ) const
inline

This function returns a constant reference to member paramname_hash.

Returns
Constant reference to member paramname_hash

◆ paramname_hash() [3/4]

void paramname_hash ( const NameHash _paramname_hash)
inline

This function copies the value in member paramname_hash.

Parameters
_paramname_hashNew value to be copied in member paramname_hash

◆ paramname_hash() [4/4]

void paramname_hash ( NameHash &&  _paramname_hash)
inline

This function moves the value in member paramname_hash.

Parameters
_paramname_hashNew value to be moved in member paramname_hash

◆ 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.

◆ value() [1/4]

AnnotationParameterValue & value ( )
inline

This function returns a reference to member value.

Returns
Reference to member value

◆ value() [2/4]

const AnnotationParameterValue & value ( ) const
inline

This function returns a constant reference to member value.

Returns
Constant reference to member value

◆ value() [3/4]

void value ( AnnotationParameterValue &&  _value)
inline

This function moves the value in member value.

Parameters
_valueNew value to be moved in member value

◆ value() [4/4]

void value ( const AnnotationParameterValue _value)
inline

This function copies the value in member value.

Parameters
_valueNew value to be copied in member value

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