Fast DDS  Version 3.0.1
Fast DDS
Loading...
Searching...
No Matches
DynamicPubSubType Class Reference

#include <DynamicPubSubType.hpp>

Inheritance diagram for DynamicPubSubType:

Public Member Functions

FASTDDS_EXPORTED_API DynamicPubSubType ()=default
 
FASTDDS_EXPORTED_API DynamicPubSubType (traits< DynamicType >::ref_type type)
 Constructs a DynamicPubSubType from a DynamicType.
 
FASTDDS_EXPORTED_API DynamicPubSubType (traits< DynamicType >::ref_type type, const xtypes::TypeInformation &type_information)
 Constructs a DynamicPubSubType from a DynamicType and a xtypes::TypeInformation.
 
virtual FASTDDS_EXPORTED_API ~DynamicPubSubType ()
 
FASTDDS_EXPORTED_API void * create_data () override
 Create a new data object of the specified type.
 
FASTDDS_EXPORTED_API void delete_data (void *data) override
 Deletes an object previously allocated via create_data.
 
FASTDDS_EXPORTED_API bool deserialize (eprosima::fastdds::rtps::SerializedPayload_t &payload, void *data) override
 Deserialize an object from the given payload.
 
FASTDDS_EXPORTED_API traits< DynamicType >::ref_type get_dynamic_type () const noexcept
 Returns a copy of the internal DynamicType object.
 
FASTDDS_EXPORTED_API bool compute_key (eprosima::fastdds::rtps::SerializedPayload_t &payload, eprosima::fastdds::rtps::InstanceHandle_t &ihandle, bool force_md5=false) override
 Calculate the key associated to a given object.
 
FASTDDS_EXPORTED_API bool compute_key (const void *const data, eprosima::fastdds::rtps::InstanceHandle_t &ihandle, bool force_md5=false) override
 Calculate the key associated to a given object.
 
FASTDDS_EXPORTED_API uint32_t calculate_serialized_size (const void *const data, DataRepresentationId_t data_representation) override
 Provide a functor that calculates a specified object serialized size.
 
FASTDDS_EXPORTED_API bool serialize (const void *const data, eprosima::fastdds::rtps::SerializedPayload_t &payload, fastdds::dds::DataRepresentationId_t data_representation) override
 Serialize an object into a given payload.
 
FASTDDS_EXPORTED_API ReturnCode_t set_dynamic_type (traits< DynamicType >::ref_type type)
 Sets up the internal DynamicType object.
 
FASTDDS_EXPORTED_API void register_type_object_representation () override
 Register TypeObject representation in Fast DDS TypeObjectRegistry.
 
- Public Member Functions inherited from TopicDataType
FASTDDS_EXPORTED_API TopicDataType ()=default
 Constructor.
 
virtual FASTDDS_EXPORTED_API ~TopicDataType ()=default
 Destructor.
 
FASTDDS_EXPORTED_API void set_name (const std::string &nam)
 Set topic data type name.
 
FASTDDS_EXPORTED_API void set_name (std::string &&nam)
 Set topic data type name.
 
FASTDDS_EXPORTED_API const std::string & get_name () const
 Get topic data type name.
 
FASTDDS_EXPORTED_API const xtypes::TypeIdentifierPairtype_identifiers () const
 Get the type identifiers.
 
virtual FASTDDS_EXPORTED_API bool is_bounded () const
 Checks if the type is bounded.
 
virtual FASTDDS_EXPORTED_API bool is_plain (DataRepresentationId_t) const
 Checks if the type is plain when using a specific encoding.
 
virtual FASTDDS_EXPORTED_API bool construct_sample (void *memory) const
 Construct a sample on a memory location.
 

Additional Inherited Members

- Public Attributes inherited from TopicDataType
uint32_t max_serialized_type_size {0}
 Maximum serialized size of the type in bytes.
 
bool is_compute_key_provided {false}
 Indicates whether the method to obtain the key has been implemented.
 
- Protected Attributes inherited from TopicDataType
xtypes::TypeIdentifierPair type_identifiers_
 

Constructor & Destructor Documentation

◆ DynamicPubSubType() [1/3]

FASTDDS_EXPORTED_API DynamicPubSubType ( )
default

◆ DynamicPubSubType() [2/3]

FASTDDS_EXPORTED_API DynamicPubSubType ( traits< DynamicType >::ref_type  type)

Constructs a DynamicPubSubType from a DynamicType.

Parameters
typeDynamicType object associated to the data
Remarks
Ownership is not transferred.

◆ DynamicPubSubType() [3/3]

FASTDDS_EXPORTED_API DynamicPubSubType ( traits< DynamicType >::ref_type  type,
const xtypes::TypeInformation type_information 
)

Constructs a DynamicPubSubType from a DynamicType and a xtypes::TypeInformation.

This constructor is only meant to be used when the registration of the corresponding TypeSupport in the participant is meant to avoid registering the xtypes::TypeObject in the xtypes::TypeObjectRegistry; that is, when the xtypes::TypeObject registration has already been performed. This is for instance the case when the DynamicType is created from a xtypes::TypeObject obtained from a remote xtypes::TypeInformation that only has the minimal type identifiers but not the complete ones.

Parameters
typeDynamicType object associated to the data
type_informationxtypes::TypeInformation object associated to the data
Remarks
Ownership is not transferred.

◆ ~DynamicPubSubType()

virtual FASTDDS_EXPORTED_API ~DynamicPubSubType ( )
virtual

Member Function Documentation

◆ calculate_serialized_size()

FASTDDS_EXPORTED_API uint32_t calculate_serialized_size ( const void *const  data,
DataRepresentationId_t  data_representation 
)
overridevirtual

Provide a functor that calculates a specified object serialized size.

Parameters
[in]dataobject whose payload footprint to calculate
[in]data_representationRepresentation that should be used for calculating the serialized size.
Returns
functor that calculates the size

Implements TopicDataType.

◆ compute_key() [1/2]

FASTDDS_EXPORTED_API bool compute_key ( const void *const  data,
eprosima::fastdds::rtps::InstanceHandle_t ihandle,
bool  force_md5 = false 
)
overridevirtual

Calculate the key associated to a given object.

Parameters
dataobject which key is calculated
ihandlertps::InstanceHandle_t to fill in
force_md5use always md5 even if key payload footprint is smaller than the hash
Returns
bool specifying success

Implements TopicDataType.

◆ compute_key() [2/2]

FASTDDS_EXPORTED_API bool compute_key ( eprosima::fastdds::rtps::SerializedPayload_t payload,
eprosima::fastdds::rtps::InstanceHandle_t ihandle,
bool  force_md5 = false 
)
overridevirtual

Calculate the key associated to a given object.

Parameters
payloadrtps::SerializedPayload_t containing the serialized object which key is calculated
ihandlertps::InstanceHandle_t to fill in
force_md5use always md5 even if key payload footprint is smaller than the hash
Returns
bool specifying success

Implements TopicDataType.

◆ create_data()

FASTDDS_EXPORTED_API void * create_data ( )
overridevirtual

Create a new data object of the specified type.

Returns
pointer to the new object
Remarks
Ownership is transferred. This object must be removed using delete_data

Implements TopicDataType.

◆ delete_data()

FASTDDS_EXPORTED_API void delete_data ( void *  data)
overridevirtual

Deletes an object previously allocated via create_data.

Parameters
datapointer to the object to be deleted
Remarks
Ownership is transferred. This object must be allocated using create_data

Implements TopicDataType.

◆ deserialize()

FASTDDS_EXPORTED_API bool deserialize ( eprosima::fastdds::rtps::SerializedPayload_t payload,
void *  data 
)
overridevirtual

Deserialize an object from the given payload.

Parameters
payloadrtps::SerializedPayload_t to parse
dataobject to fill in with payload data
Returns
bool specifying success

Implements TopicDataType.

◆ get_dynamic_type()

FASTDDS_EXPORTED_API traits< DynamicType >::ref_type get_dynamic_type ( ) const
noexcept

Returns a copy of the internal DynamicType object.

Returns
pointer to the new object

◆ register_type_object_representation()

FASTDDS_EXPORTED_API void register_type_object_representation ( )
overridevirtual

Register TypeObject representation in Fast DDS TypeObjectRegistry.

Reimplemented from TopicDataType.

◆ serialize()

FASTDDS_EXPORTED_API bool serialize ( const void *const  data,
eprosima::fastdds::rtps::SerializedPayload_t payload,
fastdds::dds::DataRepresentationId_t  data_representation 
)
overridevirtual

Serialize an object into a given payload.

Parameters
[in]dataobject to serialize
[out]payloadrtps::SerializedPayload_t to fill in
[in]data_representationRepresentation that should be used to encode the data into the payload.
Returns
bool specifying success

Implements TopicDataType.

◆ set_dynamic_type()

FASTDDS_EXPORTED_API ReturnCode_t set_dynamic_type ( traits< DynamicType >::ref_type  type)

Sets up the internal DynamicType object.

Parameters
typeDynamicType to copy
Returns
ReturnCode_t with operation status
Remarks
Ownership is not transferred.

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