RTI Connext Modern C++ API Version 7.3.0
rti::core::MonitoringDistributionSettings Class Reference

<<extension>> Configures the distribution of telemetry data. More...

#include <rti/core/PolicySettings.hpp>

Public Member Functions

 MonitoringDistributionSettings ()
 Creates an instance with the default settings. More...
 
MonitoringDistributionSettingspublisher_qos_profile_name (const rti::core::optional_value< std::string > &the_publisher_qos_profile_name)
 Sets the fully qualified name of the profile used to configure the Publishers that distribute telemetry data. More...
 
MonitoringDistributionSettingspublisher_qos_profile_name (const char *the_publisher_qos_profile_name)
 Sets the fully qualified name of the profile used to configure the Publishers that distribute telemetry data. More...
 
rti::core::optional_value< std::string > publisher_qos_profile_name () const
 Getter (see setter with the same name). More...
 
MonitoringDistributionSettingsdedicated_participant (const MonitoringDedicatedParticipantSettings &the_dedicated_participant)
 Configures the use of a dedicated dds::domain::DomainParticipant to distribute the RTI Connext application telemetry data. More...
 
const MonitoringDedicatedParticipantSettingsdedicated_participant () const
 Gets the distribution settings by const-reference (see setter). More...
 
MonitoringDedicatedParticipantSettingsdedicated_participant ()
 Gets the distribution settings by reference (see setter). More...
 
MonitoringDistributionSettingsevent_settings (const MonitoringEventDistributionSettings &the_event_settings)
 Configures the distribution of event metrics. More...
 
const MonitoringEventDistributionSettingsevent_settings () const
 Gets the distribution settings by const-reference (see setter). More...
 
MonitoringEventDistributionSettingsevent_settings ()
 Gets the distribution settings by reference (see setter). More...
 
MonitoringDistributionSettingsperiodic_settings (const MonitoringPeriodicDistributionSettings &the_periodic_settings)
 Configures the distribution of periodic metrics. More...
 
const MonitoringPeriodicDistributionSettingsperiodic_settings () const
 Gets the distribution settings by const-reference (see setter). More...
 
MonitoringPeriodicDistributionSettingsperiodic_settings ()
 Gets the distribution settings by reference (see setter). More...
 
MonitoringDistributionSettingslogging_settings (const MonitoringLoggingDistributionSettings &the_logging_settings)
 Configures the distribution of logging messages. More...
 
const MonitoringLoggingDistributionSettingslogging_settings () const
 Gets the distribution settings by const-reference (see setter). More...
 
MonitoringLoggingDistributionSettingslogging_settings ()
 Gets the distribution settings by reference (see setter). More...
 

Detailed Description

<<extension>> Configures the distribution of telemetry data.

Constructor & Destructor Documentation

◆ MonitoringDistributionSettings()

rti::core::MonitoringDistributionSettings::MonitoringDistributionSettings ( )
inline

Creates an instance with the default settings.

Member Function Documentation

◆ publisher_qos_profile_name() [1/3]

MonitoringDistributionSettings & rti::core::MonitoringDistributionSettings::publisher_qos_profile_name ( const rti::core::optional_value< std::string > &  the_publisher_qos_profile_name)

Sets the fully qualified name of the profile used to configure the Publishers that distribute telemetry data.

Parameters
the_publisher_qos_profile_nameAn optional string. An unset value indicates that the RTI Monitoring Library 2.0 uses rti::core::builtin_profiles::qos_lib::generic_monitoring2().

[default] Unset

There is one Publisher for each telemetry data dds::topic::Topic: MONITORING_PERIODIC_TOPIC_NAME, MONITORING_EVENT_TOPIC_NAME, and MONITORING_LOGGING_TOPIC_NAME.

If not set (the default value) then RTI Monitoring Library 2.0 uses rti::core::builtin_profiles::qos_lib::generic_monitoring2().

◆ publisher_qos_profile_name() [2/3]

MonitoringDistributionSettings & rti::core::MonitoringDistributionSettings::publisher_qos_profile_name ( const char *  the_publisher_qos_profile_name)

Sets the fully qualified name of the profile used to configure the Publishers that distribute telemetry data.

Parameters
the_publisher_qos_profile_nameThe profile name. Cannot be NULL.

There is one Publisher for each telemetry data dds::topic::Topic: MONITORING_PERIODIC_TOPIC_NAME, MONITORING_EVENT_TOPIC_NAME, and MONITORING_LOGGING_TOPIC_NAME.

If not set (the default value) then RTI Monitoring Library 2.0 uses rti::core::builtin_profiles::qos_lib::generic_monitoring2().

◆ publisher_qos_profile_name() [3/3]

rti::core::optional_value< std::string > rti::core::MonitoringDistributionSettings::publisher_qos_profile_name ( ) const

Getter (see setter with the same name).

◆ dedicated_participant() [1/3]

MonitoringDistributionSettings & rti::core::MonitoringDistributionSettings::dedicated_participant ( const MonitoringDedicatedParticipantSettings the_dedicated_participant)

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

◆ dedicated_participant() [2/3]

const MonitoringDedicatedParticipantSettings & rti::core::MonitoringDistributionSettings::dedicated_participant ( ) const

Gets the distribution settings by const-reference (see setter).

◆ dedicated_participant() [3/3]

MonitoringDedicatedParticipantSettings & rti::core::MonitoringDistributionSettings::dedicated_participant ( )

Gets the distribution settings by reference (see setter).

◆ event_settings() [1/3]

MonitoringDistributionSettings & rti::core::MonitoringDistributionSettings::event_settings ( const MonitoringEventDistributionSettings the_event_settings)

Configures the distribution of event metrics.

◆ event_settings() [2/3]

const MonitoringEventDistributionSettings & rti::core::MonitoringDistributionSettings::event_settings ( ) const

Gets the distribution settings by const-reference (see setter).

◆ event_settings() [3/3]

MonitoringEventDistributionSettings & rti::core::MonitoringDistributionSettings::event_settings ( )

Gets the distribution settings by reference (see setter).

◆ periodic_settings() [1/3]

MonitoringDistributionSettings & rti::core::MonitoringDistributionSettings::periodic_settings ( const MonitoringPeriodicDistributionSettings the_periodic_settings)

Configures the distribution of periodic metrics.

◆ periodic_settings() [2/3]

const MonitoringPeriodicDistributionSettings & rti::core::MonitoringDistributionSettings::periodic_settings ( ) const

Gets the distribution settings by const-reference (see setter).

◆ periodic_settings() [3/3]

MonitoringPeriodicDistributionSettings & rti::core::MonitoringDistributionSettings::periodic_settings ( )

Gets the distribution settings by reference (see setter).

◆ logging_settings() [1/3]

MonitoringDistributionSettings & rti::core::MonitoringDistributionSettings::logging_settings ( const MonitoringLoggingDistributionSettings the_logging_settings)

Configures the distribution of logging messages.

◆ logging_settings() [2/3]

const MonitoringLoggingDistributionSettings & rti::core::MonitoringDistributionSettings::logging_settings ( ) const

Gets the distribution settings by const-reference (see setter).

◆ logging_settings() [3/3]

MonitoringLoggingDistributionSettings & rti::core::MonitoringDistributionSettings::logging_settings ( )

Gets the distribution settings by reference (see setter).