Class TypeIdentifier

Class Documentation

class TypeIdentifier

Public Functions

RTPS_DllAPI TypeIdentifier()

Default constructor.

RTPS_DllAPI ~TypeIdentifier()

Default destructor.

RTPS_DllAPI TypeIdentifier(const TypeIdentifier &x)

Copy constructor.

Parameters:

x – Reference to the object TypeIdentifier that will be copied.

RTPS_DllAPI TypeIdentifier(TypeIdentifier &&x)

Move constructor.

Parameters:

x – Reference to the object TypeIdentifier that will be copied.

RTPS_DllAPI TypeIdentifier & operator= (const TypeIdentifier &x)

Copy assignment.

Parameters:

x – Reference to the object TypeIdentifier that will be copied.

RTPS_DllAPI TypeIdentifier & operator= (TypeIdentifier &&x)

Move assignment.

Parameters:

x – Reference to the object TypeIdentifier that will be copied.

RTPS_DllAPI void _d (octet __d)

This function sets the discriminator value.

Parameters:

__d – New value for the discriminator.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the new value doesn’t correspond to the selected union member.

RTPS_DllAPI octet _d () const

This function returns the value of the discriminator.

Returns:

Value of the discriminator

RTPS_DllAPI octet & _d ()

This function returns a reference to the discriminator.

Returns:

Reference to the discriminator.

RTPS_DllAPI void string_sdefn (StringSTypeDefn _string_sdefn)

This function sets a value in member string_sdefn.

Parameters:

_string_sdefn – New value for member string_sdefn

RTPS_DllAPI const StringSTypeDefn & string_sdefn () const

This function returns the value of member string_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member string_sdefn

RTPS_DllAPI StringSTypeDefn & string_sdefn ()

This function returns a reference to member string_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member string_sdefn

RTPS_DllAPI void string_ldefn (StringLTypeDefn _string_ldefn)

This function sets a value in member string_ldefn.

Parameters:

_string_ldefn – New value for member string_ldefn

RTPS_DllAPI const StringLTypeDefn & string_ldefn () const

This function returns the value of member string_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member string_ldefn

RTPS_DllAPI StringLTypeDefn & string_ldefn ()

This function returns a reference to member string_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member string_ldefn

RTPS_DllAPI void seq_sdefn (PlainSequenceSElemDefn _seq_sdefn)

This function sets a value in member seq_sdefn.

Parameters:

_seq_sdefn – New value for member seq_sdefn

RTPS_DllAPI const PlainSequenceSElemDefn & seq_sdefn () const

This function returns the value of member seq_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member seq_sdefn

RTPS_DllAPI PlainSequenceSElemDefn & seq_sdefn ()

This function returns a reference to member seq_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member seq_sdefn

RTPS_DllAPI void seq_ldefn (PlainSequenceLElemDefn _seq_ldefn)

This function sets a value in member seq_ldefn.

Parameters:

_seq_ldefn – New value for member seq_ldefn

RTPS_DllAPI const PlainSequenceLElemDefn & seq_ldefn () const

This function returns the value of member seq_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member seq_ldefn

RTPS_DllAPI PlainSequenceLElemDefn & seq_ldefn ()

This function returns a reference to member seq_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member seq_ldefn

RTPS_DllAPI void array_sdefn (PlainArraySElemDefn _array_sdefn)

This function sets a value in member array_sdefn.

Parameters:

_array_sdefn – New value for member array_sdefn

RTPS_DllAPI const PlainArraySElemDefn & array_sdefn () const

This function returns the value of member array_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member array_sdefn

RTPS_DllAPI PlainArraySElemDefn & array_sdefn ()

This function returns a reference to member array_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member array_sdefn

RTPS_DllAPI void array_ldefn (PlainArrayLElemDefn _array_ldefn)

This function sets a value in member array_ldefn.

Parameters:

_array_ldefn – New value for member array_ldefn

RTPS_DllAPI const PlainArrayLElemDefn & array_ldefn () const

This function returns the value of member array_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member array_ldefn

RTPS_DllAPI PlainArrayLElemDefn & array_ldefn ()

This function returns a reference to member array_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member array_ldefn

RTPS_DllAPI void map_sdefn (PlainMapSTypeDefn _map_sdefn)

This function sets a value in member map_sdefn.

Parameters:

_map_sdefn – New value for member map_sdefn

RTPS_DllAPI const PlainMapSTypeDefn & map_sdefn () const

This function returns the value of member map_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member map_sdefn

RTPS_DllAPI PlainMapSTypeDefn & map_sdefn ()

This function returns a reference to member map_sdefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member map_sdefn

RTPS_DllAPI void map_ldefn (PlainMapLTypeDefn _map_ldefn)

This function sets a value in member map_ldefn.

Parameters:

_map_ldefn – New value for member map_ldefn

RTPS_DllAPI const PlainMapLTypeDefn & map_ldefn () const

This function returns the value of member map_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member map_ldefn

RTPS_DllAPI PlainMapLTypeDefn & map_ldefn ()

This function returns a reference to member map_ldefn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member map_ldefn

RTPS_DllAPI void sc_component_id (StronglyConnectedComponentId _sc_component_id)

This function sets a value in member sc_component_id.

Parameters:

_sc_component_id – New value for member sc_component_id

RTPS_DllAPI StronglyConnectedComponentId sc_component_id () const

This function returns the value of member sc_component_id.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member sc_component_id

RTPS_DllAPI StronglyConnectedComponentId & sc_component_id ()

This function returns a reference to member sc_component_id.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member sc_component_id

RTPS_DllAPI void equivalence_hash (EquivalenceHash _equivalence_hash)

This function sets a value in member equivalence_hash.

Parameters:

_equivalence_hash – New value for member equivalence_hash

RTPS_DllAPI const octet * equivalence_hash () const

This function returns the value of member equivalence_hash.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member equivalence_hash

RTPS_DllAPI octet * equivalence_hash ()

This function returns a reference to member equivalence_hash.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member equivalence_hash

RTPS_DllAPI void extended_defn (ExtendedTypeDefn _extended_defn)

This function sets a value in member extended_defn.

Parameters:

_extended_defn – New value for member extended_defn

RTPS_DllAPI const ExtendedTypeDefn & extended_defn () const

This function returns the value of member extended_defn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Value of member extended_defn

RTPS_DllAPI ExtendedTypeDefn & extended_defn ()

This function returns a reference to member extended_defn.

Throws:

eprosima::fastcdr::BadParamException – This exception is thrown if the requested union member is not the current selection.

Returns:

Reference to member extended_defn

FASTDDS_SER_METHOD_DEPRECATED (3, "eprosima::fastrtps::types::TypeIdentifier::getCdrSerializedSize()", "In favor of version using eprosima::fastcdr::calculate_serialized_size.") RTPS_DllAPI static size_t getCdrSerializedSize(const TypeIdentifier &data

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

Parameters:

  • data – Data which is calculated its serialized size.

  • current_alignment – Buffer alignment.

Returns:

Serialized size.

FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::TypeIdentifier::serialize()", "In favor of version using eprosima::fastcdr::serialize.") RTPS_DllAPI void serialize(eprosima FASTDDS_SER_METHOD_DEPRECATED(3, "eprosima::fastrtps::types::TypeIdentifier::deserialize()", "In favor of version using eprosima::fastcdr::deserialize.") RTPS_DllAPI void deserialize(eprosima bool operator== (const TypeIdentifier &other) const

This function serializes an object using CDR serialization.

This function deserializes an object using CDR serialization.

Parameters:

  • cdr – CDR serialization object.

  • cdr – CDR serialization object. Equals

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

Returns:

string representation of the equivalence hash

Public Members

size_t current_alignment   = 0)