rti::core::MonitoringPeriodicDistributionSettings Class Reference

<<extension>> Configures the distribution of periodic metrics. More...

#include <rti/core/PolicySettings.hpp>

Public Member Functions
	MonitoringPeriodicDistributionSettings ()
	Creates an instance with the default settings. More...
MonitoringPeriodicDistributionSettings &	datawriter_qos_profile_name (const rti::core::optional_value< std::string > &the_datawriter_qos_profile_name)
	Sets The fully qualified name of the profile used to configure the dds::pub::DataWriter that distributes periodic metrics. More...
MonitoringPeriodicDistributionSettings &	datawriter_qos_profile_name (const char *the_datawriter_qos_profile_name)
	Sets The fully qualified name of the profile used to configure the dds::pub::DataWriter that distributes periodic metrics. More...
rti::core::optional_value< std::string >	datawriter_qos_profile_name () const
	Getter (see setter with the same name). More...
MonitoringPeriodicDistributionSettings &	thread (const rti::core::ThreadSettings &the_thread)
	The settings of the periodic metric thread. More...
const rti::core::ThreadSettings &	thread () const
	Getter (see setter with the same name). More...
rti::core::ThreadSettings &	thread ()
	Getter (see setter with the same name). More...
MonitoringPeriodicDistributionSettings &	polling_period (const dds::core::Duration &the_polling_period)
	Period at which the periodic metric thread polls and publishes the periodic metrics. More...
dds::core::Duration	polling_period () const
	Getter (see setter with the same name) More...

Detailed Description

<<extension>> Configures the distribution of periodic metrics.

Periodic metrics change often, and they are polled and published periodically by a thread created by RTI Monitoring Library 2.0.

RTI Monitoring Library 2.0 obtains periodic metrics by polling the current value of periodic statuses such as rti::core::status::DataWriterProtocolStatus.

The periodic metrics that will be distributed for an observable resource can be configured with rti::core::MonitoringTelemetryData::metrics.

Constructor & Destructor Documentation

MonitoringPeriodicDistributionSettings()

rti::core::MonitoringPeriodicDistributionSettings::MonitoringPeriodicDistributionSettings ( )

inline

Creates an instance with the default settings.

Member Function Documentation

datawriter_qos_profile_name() [1/3]

MonitoringPeriodicDistributionSettings & rti::core::MonitoringPeriodicDistributionSettings::datawriter_qos_profile_name

(

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

the_datawriter_qos_profile_name

)

Sets The fully qualified name of the profile used to configure the dds::pub::DataWriter that distributes periodic metrics.

Parameters

the_datawriter_qos_profile_name

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

[default] Unset

The dds::pub::DataWriter Topic is MONITORING_PERIODIC_TOPIC_NAME.

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

[default] null

datawriter_qos_profile_name() [2/3]

MonitoringPeriodicDistributionSettings & rti::core::MonitoringPeriodicDistributionSettings::datawriter_qos_profile_name

(

const char *

the_datawriter_qos_profile_name

)

Sets The fully qualified name of the profile used to configure the dds::pub::DataWriter that distributes periodic metrics.

Parameters

the_datawriter_qos_profile_name

The profile name. Cannot be NULL.

The dds::pub::DataWriter Topic is MONITORING_PERIODIC_TOPIC_NAME.

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

[default] null

datawriter_qos_profile_name() [3/3]

rti::core::optional_value< std::string > rti::core::MonitoringPeriodicDistributionSettings::datawriter_qos_profile_name

(

)

const

Getter (see setter with the same name).

thread() [1/3]

MonitoringPeriodicDistributionSettings & rti::core::MonitoringPeriodicDistributionSettings::thread

(

const rti::core::ThreadSettings &

the_thread

)

The settings of the periodic metric thread.

The periodic metric thread periodically polls and publishes periodic event metrics.

The thread runs at the period configured using rti::core::MonitoringPeriodicDistributionSettings::polling_period.

[default] DDS_THREAD_SETTINGS_DEFAULT

thread() [2/3]

const rti::core::ThreadSettings & rti::core::MonitoringPeriodicDistributionSettings::thread

(

)

const

Getter (see setter with the same name).

thread() [3/3]

rti::core::ThreadSettings & rti::core::MonitoringPeriodicDistributionSettings::thread

(

)

Getter (see setter with the same name).

polling_period() [1/2]

MonitoringPeriodicDistributionSettings & rti::core::MonitoringPeriodicDistributionSettings::polling_period

(

const dds::core::Duration &

the_polling_period

)

Period at which the periodic metric thread polls and publishes the periodic metrics.

[default] 5 seconds

[range] > 0 seconds

polling_period() [2/2]

dds::core::Duration rti::core::MonitoringPeriodicDistributionSettings::polling_period

(

)

const

Getter (see setter with the same name)