Fast RTPS  Version 2.4.0
Fast RTPS
AppliedAnnotationParameter Class Reference

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

#include <AnnotationParameterValue.h>

Public Member Functions

 AppliedAnnotationParameter ()
 Default constructor. More...
 
 ~AppliedAnnotationParameter ()
 Default destructor. More...
 
 AppliedAnnotationParameter (const AppliedAnnotationParameter &x)
 Copy constructor. More...
 
 AppliedAnnotationParameter (AppliedAnnotationParameter &&x)
 Move constructor. More...
 
AppliedAnnotationParameteroperator= (const AppliedAnnotationParameter &x)
 Copy assignment. More...
 
AppliedAnnotationParameteroperator= (AppliedAnnotationParameter &&x)
 Move assignment. More...
 
void paramname_hash (const NameHash &_paramname_hash)
 This function copies the value in member paramname_hash. More...
 
void paramname_hash (NameHash &&_paramname_hash)
 This function moves the value in member paramname_hash. More...
 
const NameHashparamname_hash () const
 This function returns a constant reference to member paramname_hash. More...
 
NameHashparamname_hash ()
 This function returns a reference to member paramname_hash. More...
 
void value (const AnnotationParameterValue &_value)
 This function copies the value in member value. More...
 
void value (AnnotationParameterValue &&_value)
 This function moves the value in member value. More...
 
const AnnotationParameterValuevalue () const
 This function returns a constant reference to member value. More...
 
AnnotationParameterValuevalue ()
 This function returns a reference to member value. More...
 
void serialize (eprosima::fastcdr::Cdr &cdr) const
 This function serializes an object using CDR serialization. More...
 
void deserialize (eprosima::fastcdr::Cdr &cdr)
 This function deserializes an object using CDR serialization. More...
 
void serializeKey (eprosima::fastcdr::Cdr &cdr) const
 This function serializes the key members of an object using CDR serialization. More...
 
bool operator== (const AppliedAnnotationParameter &other) const
 

Static Public Member Functions

static size_t getCdrSerializedSize (const AppliedAnnotationParameter &data, size_t current_alignment=0)
 This function returns the serialized size of a data depending on the buffer alignment. More...
 
static 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. More...
 
static bool isKeyDefined ()
 This function tells you if the Key has been defined for this type. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ AppliedAnnotationParameter() [1/3]

Default constructor.

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

◆ deserialize()

void deserialize ( eprosima::fastcdr::Cdr &  cdr)

This function deserializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

◆ getCdrSerializedSize()

static size_t getCdrSerializedSize ( const AppliedAnnotationParameter data,
size_t  current_alignment = 0 
)
static

This function returns the serialized size of a data depending on the buffer alignment.

Parameters
dataData which is calculated its serialized size.
current_alignmentBuffer alignment.
Returns
Serialized size.

◆ getKeyMaxCdrSerializedSize()

static 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 bool isKeyDefined ( )
static

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

◆ operator=() [1/2]

Move assignment.

Parameters
xReference to the object AppliedAnnotationParameter that will be copied.

◆ operator=() [2/2]

Copy assignment.

Parameters
xReference to the object AppliedAnnotationParameter that will be copied.

◆ operator==()

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

◆ serialize()

void serialize ( eprosima::fastcdr::Cdr &  cdr) const

This function serializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

◆ serializeKey()

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: