rti::core::MonitoringDedicatedParticipantSettings Class Reference

<<extension>> Configures the usage of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data. More...

#include <rti/core/PolicySettings.hpp>

Public Member Functions
	MonitoringDedicatedParticipantSettings ()
	Creates an instance with the default settings. More...
MonitoringDedicatedParticipantSettings &	enable (bool the_enable)
	Enables the use of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data. More...
bool	enable () const
	Getter (see setter with the same name). More...
MonitoringDedicatedParticipantSettings &	domain_id (int32_t the_domain_id)
	The domain ID used in the creation of the RTI Observability Library dds::domain::DomainParticipant. More...
int32_t	domain_id () const
	Getter (see setter with the same name). More...
MonitoringDedicatedParticipantSettings &	participant_qos_profile_name (const rti::core::optional_value< std::string > &the_participant_qos_profile_name)
	Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data. More...
MonitoringDedicatedParticipantSettings &	participant_qos_profile_name (const char *the_participant_qos_profile_name)
	Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data. More...
rti::core::optional_value< std::string >	participant_qos_profile_name () const
	Getter (see setter with the same name). More...

Detailed Description

<<extension>> Configures the usage of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data.

Constructor & Destructor Documentation

MonitoringDedicatedParticipantSettings()

rti::core::MonitoringDedicatedParticipantSettings::MonitoringDedicatedParticipantSettings ( )

inline

Creates an instance with the default settings.

Member Function Documentation

enable() [1/2]

MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::enable

(

bool

the_enable

)

Enables the use of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data.

Setting this value to false is not currently supported.

[default] true

enable() [2/2]

bool rti::core::MonitoringDedicatedParticipantSettings::enable

(

)

const

Getter (see setter with the same name).

domain_id() [1/2]

MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::domain_id

(

int32_t

the_domain_id

)

The domain ID used in the creation of the RTI Observability Library dds::domain::DomainParticipant.

[default] 2

domain_id() [2/2]

int32_t rti::core::MonitoringDedicatedParticipantSettings::domain_id

(

)

const

Getter (see setter with the same name).

participant_qos_profile_name() [1/3]

MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name

(

const rti::core::optional_value< std::string > &

the_participant_qos_profile_name

)

Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data.

Parameters

the_participant_qos_profile_name

An optional string. An unset value indicates that the RTI Observability Library uses rti::core::builtin_profiles::qos_lib::generic_observability().

[default] Unset

If not set (the default value) then the RTI Observability Library uses rti::core::builtin_profiles::qos_lib::generic_observability().

participant_qos_profile_name() [2/3]

MonitoringDedicatedParticipantSettings & rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name

(

const char *

the_participant_qos_profile_name

)

Sets the fully qualified name of the profile used to configure the dds::domain::DomainParticipant that will be used to distribute telemetry data.

Parameters

the_participant_qos_profile_name

The profile name. Cannot be NULL.

If not set (the default value) then the RTI Observability Library uses rti::core::builtin_profiles::qos_lib::generic_observability().

participant_qos_profile_name() [3/3]

rti::core::optional_value< std::string > rti::core::MonitoringDedicatedParticipantSettings::participant_qos_profile_name

(

)

const

Getter (see setter with the same name).