Fast RTPS  Version 2.6.1
Fast RTPS
TypeIdentifier Class Reference

#include <TypeIdentifier.h>

Public Member Functions

RTPS_DllAPI TypeIdentifier ()
 Default constructor. More...
 
RTPS_DllAPI ~TypeIdentifier ()
 Default destructor. More...
 
RTPS_DllAPI TypeIdentifier (const TypeIdentifier &x)
 Copy constructor. More...
 
RTPS_DllAPI TypeIdentifier (TypeIdentifier &&x)
 Move constructor. More...
 
RTPS_DllAPI TypeIdentifieroperator= (const TypeIdentifier &x)
 Copy assignment. More...
 
RTPS_DllAPI TypeIdentifieroperator= (TypeIdentifier &&x)
 Move assignment. More...
 
RTPS_DllAPI void _d (octet __d)
 This function sets the discriminator value. More...
 
RTPS_DllAPI octet _d () const
 This function returns the value of the discriminator. More...
 
RTPS_DllAPI octet & _d ()
 This function returns a reference to the discriminator. More...
 
RTPS_DllAPI void string_sdefn (StringSTypeDefn _string_sdefn)
 This function sets a value in member string_sdefn. More...
 
RTPS_DllAPI const StringSTypeDefnstring_sdefn () const
 This function returns the value of member string_sdefn. More...
 
RTPS_DllAPI StringSTypeDefnstring_sdefn ()
 This function returns a reference to member string_sdefn. More...
 
RTPS_DllAPI void string_ldefn (StringLTypeDefn _string_ldefn)
 This function sets a value in member string_ldefn. More...
 
RTPS_DllAPI const StringLTypeDefnstring_ldefn () const
 This function returns the value of member string_ldefn. More...
 
RTPS_DllAPI StringLTypeDefnstring_ldefn ()
 This function returns a reference to member string_ldefn. More...
 
RTPS_DllAPI void seq_sdefn (PlainSequenceSElemDefn _seq_sdefn)
 This function sets a value in member seq_sdefn. More...
 
RTPS_DllAPI const PlainSequenceSElemDefnseq_sdefn () const
 This function returns the value of member seq_sdefn. More...
 
RTPS_DllAPI PlainSequenceSElemDefnseq_sdefn ()
 This function returns a reference to member seq_sdefn. More...
 
RTPS_DllAPI void seq_ldefn (PlainSequenceLElemDefn _seq_ldefn)
 This function sets a value in member seq_ldefn. More...
 
RTPS_DllAPI const PlainSequenceLElemDefnseq_ldefn () const
 This function returns the value of member seq_ldefn. More...
 
RTPS_DllAPI PlainSequenceLElemDefnseq_ldefn ()
 This function returns a reference to member seq_ldefn. More...
 
RTPS_DllAPI void array_sdefn (PlainArraySElemDefn _array_sdefn)
 This function sets a value in member array_sdefn. More...
 
RTPS_DllAPI const PlainArraySElemDefnarray_sdefn () const
 This function returns the value of member array_sdefn. More...
 
RTPS_DllAPI PlainArraySElemDefnarray_sdefn ()
 This function returns a reference to member array_sdefn. More...
 
RTPS_DllAPI void array_ldefn (PlainArrayLElemDefn _array_ldefn)
 This function sets a value in member array_ldefn. More...
 
RTPS_DllAPI const PlainArrayLElemDefnarray_ldefn () const
 This function returns the value of member array_ldefn. More...
 
RTPS_DllAPI PlainArrayLElemDefnarray_ldefn ()
 This function returns a reference to member array_ldefn. More...
 
RTPS_DllAPI void map_sdefn (PlainMapSTypeDefn _map_sdefn)
 This function sets a value in member map_sdefn. More...
 
RTPS_DllAPI const PlainMapSTypeDefnmap_sdefn () const
 This function returns the value of member map_sdefn. More...
 
RTPS_DllAPI PlainMapSTypeDefnmap_sdefn ()
 This function returns a reference to member map_sdefn. More...
 
RTPS_DllAPI void map_ldefn (PlainMapLTypeDefn _map_ldefn)
 This function sets a value in member map_ldefn. More...
 
RTPS_DllAPI const PlainMapLTypeDefnmap_ldefn () const
 This function returns the value of member map_ldefn. More...
 
RTPS_DllAPI PlainMapLTypeDefnmap_ldefn ()
 This function returns a reference to member map_ldefn. More...
 
RTPS_DllAPI void sc_component_id (StronglyConnectedComponentId _sc_component_id)
 This function sets a value in member sc_component_id. More...
 
RTPS_DllAPI StronglyConnectedComponentId sc_component_id () const
 This function returns the value of member sc_component_id. More...
 
RTPS_DllAPI StronglyConnectedComponentIdsc_component_id ()
 This function returns a reference to member sc_component_id. More...
 
RTPS_DllAPI void equivalence_hash (EquivalenceHash _equivalence_hash)
 This function sets a value in member equivalence_hash. More...
 
RTPS_DllAPI const octet * equivalence_hash () const
 This function returns the value of member equivalence_hash. More...
 
RTPS_DllAPI octet * equivalence_hash ()
 This function returns a reference to member equivalence_hash. More...
 
RTPS_DllAPI void extended_defn (ExtendedTypeDefn _extended_defn)
 This function sets a value in member extended_defn. More...
 
RTPS_DllAPI const ExtendedTypeDefnextended_defn () const
 This function returns the value of member extended_defn. More...
 
RTPS_DllAPI ExtendedTypeDefnextended_defn ()
 This function returns a reference to member extended_defn. More...
 
RTPS_DllAPI void serialize (eprosima::fastcdr::Cdr &cdr) const
 This function serializes an object using CDR serialization. More...
 
RTPS_DllAPI void deserialize (eprosima::fastcdr::Cdr &cdr)
 This function deserializes an object using CDR serialization. More...
 
bool operator== (const TypeIdentifier &other) const
 Equals. More...
 
RTPS_DllAPI bool consistent (const TypeIdentifier &x, const fastdds::dds::TypeConsistencyEnforcementQosPolicy &consistency) const
 
RTPS_DllAPI std::string equivalence_hash_to_string () const
 equivalence_hash_to_string More...
 

Static Public Member Functions

static RTPS_DllAPI size_t getCdrSerializedSize (const TypeIdentifier &data, size_t current_alignment=0)
 This function returns the serialized size of a data depending on the buffer alignment. More...
 

Constructor & Destructor Documentation

◆ TypeIdentifier() [1/3]

RTPS_DllAPI TypeIdentifier ( )

Default constructor.

◆ ~TypeIdentifier()

RTPS_DllAPI ~TypeIdentifier ( )

Default destructor.

◆ TypeIdentifier() [2/3]

RTPS_DllAPI TypeIdentifier ( const TypeIdentifier x)

Copy constructor.

Parameters
xReference to the object TypeIdentifier that will be copied.

◆ TypeIdentifier() [3/3]

RTPS_DllAPI TypeIdentifier ( TypeIdentifier &&  x)

Move constructor.

Parameters
xReference to the object TypeIdentifier that will be copied.

Member Function Documentation

◆ _d() [1/3]

RTPS_DllAPI octet& _d ( )

This function returns a reference to the discriminator.

Returns
Reference to the discriminator.

◆ _d() [2/3]

RTPS_DllAPI octet _d ( ) const

This function returns the value of the discriminator.

Returns
Value of the discriminator

◆ _d() [3/3]

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

◆ array_ldefn() [1/3]

RTPS_DllAPI PlainArrayLElemDefn& array_ldefn ( )

This function returns a reference to member array_ldefn.

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

◆ array_ldefn() [2/3]

RTPS_DllAPI const PlainArrayLElemDefn& array_ldefn ( ) const

This function returns the value of member array_ldefn.

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

◆ array_ldefn() [3/3]

RTPS_DllAPI void array_ldefn ( PlainArrayLElemDefn  _array_ldefn)

This function sets a value in member array_ldefn.

Parameters
_array_ldefnNew value for member array_ldefn

◆ array_sdefn() [1/3]

RTPS_DllAPI PlainArraySElemDefn& array_sdefn ( )

This function returns a reference to member array_sdefn.

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

◆ array_sdefn() [2/3]

RTPS_DllAPI const PlainArraySElemDefn& array_sdefn ( ) const

This function returns the value of member array_sdefn.

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

◆ array_sdefn() [3/3]

RTPS_DllAPI void array_sdefn ( PlainArraySElemDefn  _array_sdefn)

This function sets a value in member array_sdefn.

Parameters
_array_sdefnNew value for member array_sdefn

◆ consistent()

RTPS_DllAPI bool consistent ( const TypeIdentifier x,
const fastdds::dds::TypeConsistencyEnforcementQosPolicy &  consistency 
) const

◆ deserialize()

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

This function deserializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

◆ equivalence_hash() [1/3]

RTPS_DllAPI octet* equivalence_hash ( )

This function returns a reference to member equivalence_hash.

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

◆ equivalence_hash() [2/3]

RTPS_DllAPI const octet* equivalence_hash ( ) const

This function returns the value of member equivalence_hash.

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

◆ equivalence_hash() [3/3]

RTPS_DllAPI void equivalence_hash ( EquivalenceHash  _equivalence_hash)

This function sets a value in member equivalence_hash.

Parameters
_equivalence_hashNew value for member equivalence_hash

◆ equivalence_hash_to_string()

RTPS_DllAPI std::string equivalence_hash_to_string ( ) const

equivalence_hash_to_string

Returns
string representation of the equivalence hash

◆ extended_defn() [1/3]

RTPS_DllAPI ExtendedTypeDefn& extended_defn ( )

This function returns a reference to member extended_defn.

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

◆ extended_defn() [2/3]

RTPS_DllAPI const ExtendedTypeDefn& extended_defn ( ) const

This function returns the value of member extended_defn.

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

◆ extended_defn() [3/3]

RTPS_DllAPI void extended_defn ( ExtendedTypeDefn  _extended_defn)

This function sets a value in member extended_defn.

Parameters
_extended_defnNew value for member extended_defn

◆ getCdrSerializedSize()

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

◆ map_ldefn() [1/3]

RTPS_DllAPI PlainMapLTypeDefn& map_ldefn ( )

This function returns a reference to member map_ldefn.

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

◆ map_ldefn() [2/3]

RTPS_DllAPI const PlainMapLTypeDefn& map_ldefn ( ) const

This function returns the value of member map_ldefn.

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

◆ map_ldefn() [3/3]

RTPS_DllAPI void map_ldefn ( PlainMapLTypeDefn  _map_ldefn)

This function sets a value in member map_ldefn.

Parameters
_map_ldefnNew value for member map_ldefn

◆ map_sdefn() [1/3]

RTPS_DllAPI PlainMapSTypeDefn& map_sdefn ( )

This function returns a reference to member map_sdefn.

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

◆ map_sdefn() [2/3]

RTPS_DllAPI const PlainMapSTypeDefn& map_sdefn ( ) const

This function returns the value of member map_sdefn.

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

◆ map_sdefn() [3/3]

RTPS_DllAPI void map_sdefn ( PlainMapSTypeDefn  _map_sdefn)

This function sets a value in member map_sdefn.

Parameters
_map_sdefnNew value for member map_sdefn

◆ operator=() [1/2]

RTPS_DllAPI TypeIdentifier& operator= ( const TypeIdentifier x)

Copy assignment.

Parameters
xReference to the object TypeIdentifier that will be copied.

◆ operator=() [2/2]

RTPS_DllAPI TypeIdentifier& operator= ( TypeIdentifier &&  x)

Move assignment.

Parameters
xReference to the object TypeIdentifier that will be copied.

◆ operator==()

bool operator== ( const TypeIdentifier other) const

Equals.

◆ sc_component_id() [1/3]

RTPS_DllAPI StronglyConnectedComponentId& sc_component_id ( )

This function returns a reference to member sc_component_id.

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

◆ sc_component_id() [2/3]

RTPS_DllAPI StronglyConnectedComponentId sc_component_id ( ) const

This function returns the value of member sc_component_id.

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

◆ sc_component_id() [3/3]

RTPS_DllAPI void sc_component_id ( StronglyConnectedComponentId  _sc_component_id)

This function sets a value in member sc_component_id.

Parameters
_sc_component_idNew value for member sc_component_id

◆ seq_ldefn() [1/3]

RTPS_DllAPI PlainSequenceLElemDefn& seq_ldefn ( )

This function returns a reference to member seq_ldefn.

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

◆ seq_ldefn() [2/3]

RTPS_DllAPI const PlainSequenceLElemDefn& seq_ldefn ( ) const

This function returns the value of member seq_ldefn.

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

◆ seq_ldefn() [3/3]

RTPS_DllAPI void seq_ldefn ( PlainSequenceLElemDefn  _seq_ldefn)

This function sets a value in member seq_ldefn.

Parameters
_seq_ldefnNew value for member seq_ldefn

◆ seq_sdefn() [1/3]

RTPS_DllAPI PlainSequenceSElemDefn& seq_sdefn ( )

This function returns a reference to member seq_sdefn.

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

◆ seq_sdefn() [2/3]

RTPS_DllAPI const PlainSequenceSElemDefn& seq_sdefn ( ) const

This function returns the value of member seq_sdefn.

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

◆ seq_sdefn() [3/3]

RTPS_DllAPI void seq_sdefn ( PlainSequenceSElemDefn  _seq_sdefn)

This function sets a value in member seq_sdefn.

Parameters
_seq_sdefnNew value for member seq_sdefn

◆ serialize()

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

This function serializes an object using CDR serialization.

Parameters
cdrCDR serialization object.

◆ string_ldefn() [1/3]

RTPS_DllAPI StringLTypeDefn& string_ldefn ( )

This function returns a reference to member string_ldefn.

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

◆ string_ldefn() [2/3]

RTPS_DllAPI const StringLTypeDefn& string_ldefn ( ) const

This function returns the value of member string_ldefn.

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

◆ string_ldefn() [3/3]

RTPS_DllAPI void string_ldefn ( StringLTypeDefn  _string_ldefn)

This function sets a value in member string_ldefn.

Parameters
_string_ldefnNew value for member string_ldefn

◆ string_sdefn() [1/3]

RTPS_DllAPI StringSTypeDefn& string_sdefn ( )

This function returns a reference to member string_sdefn.

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

◆ string_sdefn() [2/3]

RTPS_DllAPI const StringSTypeDefn& string_sdefn ( ) const

This function returns the value of member string_sdefn.

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

◆ string_sdefn() [3/3]

RTPS_DllAPI void string_sdefn ( StringSTypeDefn  _string_sdefn)

This function sets a value in member string_sdefn.

Parameters
_string_sdefnNew value for member string_sdefn

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