Class DomainParticipant

Inheritance Relationships

Base Type

Class Documentation

class DomainParticipant : public eprosima::fastdds::dds::DomainParticipant

Class DomainParticipant: extends standard DDS DomainParticipant class to include specific methods for the Statistics module

Public Functions

RTPS_DllAPI ReturnCode_t enable_statistics_datawriter (const std::string &topic_name, const eprosima::fastdds::dds::DataWriterQos &dwqos)

This operation enables a Statistics DataWriter.

Parameters

  • topic_name – [in] Name of the topic associated to the Statistics DataWriter

  • dwqos – [in] DataWriterQos to be set

Returns

RETCODE_UNSUPPORTED if the FASTDDS_STATISTICS CMake option has not been set, RETCODE_BAD_PARAMETER if the topic name provided does not correspond to any Statistics DataWriter, RETCODE_INCONSISTENT_POLICY if the DataWriterQos provided are inconsistent, RETCODE_OK if the DataWriter has been created or if it has been created previously, and RETCODE_ERROR otherwise

RTPS_DllAPI ReturnCode_t enable_statistics_datawriter_with_profile (const std::string &profile_name, const std::string &topic_name)

This operation enables a Statistics DataWriter from a given profile.

Parameters

  • profile_name – [in] DataWriter QoS profile name

  • topic_name – [in] Name of the statistics topic to be enabled.

Returns

RETCODE_UNSUPPORTED if the FASTDDS_STATISTICS CMake option has not been set, RETCODE_BAD_PARAMETER if the topic name provided does not correspond to any Statistics DataWriter, RETCODE_INCONSISTENT_POLICY if the DataWriterQos provided in profile are inconsistent, RETCODE_OK if the DataWriter has been created or if it has been created previously, and RETCODE_ERROR otherwise

RTPS_DllAPI ReturnCode_t disable_statistics_datawriter (const std::string &topic_name)

This operation disables a Statistics DataWriter.

Parameters

topic_name – Name of the topic associated to the Statistics DataWriter

Returns

RETCODE_UNSUPPORTED if the FASTDDS_STATISTICS CMake option has not been set, RETCODE_BAD_PARAMETER if the topic name provided does not correspond to any Statistics DataWriter, RETCODE_OK if the DataWriter has been correctly deleted or does not exist, and RETCODE_ERROR otherwise

Public Static Functions

static RTPS_DllAPI DomainParticipant * narrow (eprosima::fastdds::dds::DomainParticipant *domain_participant)

This operation narrows the DDS DomainParticipant to the Statistics DomainParticipant.

Parameters

domain_participant – Reference to the DDS DomainParticipant

Returns

Reference to the Statistics DomainParticipant if successful. nullptr otherwise.

static RTPS_DllAPI const DomainParticipant * narrow (const eprosima::fastdds::dds::DomainParticipant *domain_participant)

This operation narrows the DDS DomainParticipant to the Statistics DomainParticipant.

Parameters

domain_participant – Constant reference to the DDS DomainParticipant

Returns

Constant reference to the Statistics DomainParticipant if successful. nullptr otherwise.