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

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

#include <TypeObjectHashId.h>

Public Member Functions

 TypeObjectHashId ()
 Default constructor.
 
 ~TypeObjectHashId ()
 Default destructor.
 
 TypeObjectHashId (const TypeObjectHashId &x)
 Copy constructor.
 
 TypeObjectHashId (TypeObjectHashId &&x)
 Move constructor.
 
TypeObjectHashIdoperator= (const TypeObjectHashId &x)
 Copy assignment.
 
TypeObjectHashIdoperator= (TypeObjectHashId &&x)
 Move assignment.
 
void _d (uint8_t __d)
 This function sets the discriminator value.
 
uint8_t _d () const
 This function returns the value of the discriminator.
 
uint8_t & _d ()
 This function returns a reference to the discriminator.
 
void hash (const EquivalenceHash &_hash)
 This function copies the value in member hash.
 
void hash (EquivalenceHash &&_hash)
 This function moves the value in member hash.
 
const EquivalenceHashhash () const
 This function returns a constant reference to member hash.
 
EquivalenceHashhash ()
 This function returns a reference to member hash.
 
void serialize (eprosima::fastcdr::Cdr &cdr) const
 This function serializes an object using CDR serialization.
 
void deserialize (eprosima::fastcdr::Cdr &cdr)
 This function deserializes an object using CDR serialization.
 
void serializeKey (eprosima::fastcdr::Cdr &cdr) const
 This function serializes the key members of an object using CDR serialization.
 

Static Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ TypeObjectHashId() [1/3]

Default constructor.

◆ ~TypeObjectHashId()

Default destructor.

◆ TypeObjectHashId() [2/3]

Copy constructor.

Parameters
xReference to the object TypeObjectHashId that will be copied.

◆ TypeObjectHashId() [3/3]

Move constructor.

Parameters
xReference to the object TypeObjectHashId that will be copied.

Member Function Documentation

◆ _d() [1/3]

uint8_t & _d ( )

This function returns a reference to the discriminator.

Returns
Reference to the discriminator.

◆ _d() [2/3]

uint8_t _d ( ) const

This function returns the value of the discriminator.

Returns
Value of the discriminator

◆ _d() [3/3]

void _d ( uint8_t  __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.

◆ deserialize()

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

This function deserializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

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

◆ hash() [1/4]

EquivalenceHash & hash ( )

This function returns a reference to member hash.

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

◆ hash() [2/4]

const EquivalenceHash & hash ( ) const

This function returns a constant reference to member hash.

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

◆ hash() [3/4]

void hash ( const EquivalenceHash _hash)

This function copies the value in member hash.

Parameters
_hashNew value to be copied in member hash

◆ hash() [4/4]

void hash ( EquivalenceHash &&  _hash)

This function moves the value in member hash.

Parameters
_hashNew value to be moved in member hash

◆ isKeyDefined()

static bool isKeyDefined ( )
static

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

◆ operator=() [1/2]

TypeObjectHashId & operator= ( const TypeObjectHashId x)

Copy assignment.

Parameters
xReference to the object TypeObjectHashId that will be copied.

◆ operator=() [2/2]

TypeObjectHashId & operator= ( TypeObjectHashId &&  x)

Move assignment.

Parameters
xReference to the object TypeObjectHashId that will be copied.

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

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