Rti.Dds.Core.Policy.MonitoringMetricSelection Class Reference

Configures event and periodic metrics collection and distribution for a specific set of observable resources. More...

Inherits IEquatable< MonitoringMetricSelection >.

Public Member Functions
MonitoringMetricSelection	With (Action< MonitoringMetricSelectionBuilder > build)
	Creates a new MonitoringMetricSelection with a set of changes specified in an Action More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (MonitoringMetricSelection other)
	Compares for equality More...
override int	GetHashCode ()
	Gets the hash code More...

Properties
string	ResourceSelection [get]
	An expression pattern used to match the resource names of observable resources to which the configured metrics through MonitoringMetricSelection.EnabledMetricsSelection and MonitoringMetricSelection.DisabledMetricsSelection apply. More...
ImmutableList< string >	EnabledMetricsSelection [get]
	A sequence of POSIX fnmatch patterns that match the names of the metrics that should be collected and distributed for the observable resources selected by MonitoringMetricSelection.ResourceSelection. More...
ImmutableList< string >	DisabledMetricsSelection [get]
	A sequence of POSIX fnmatch patterns that match the names of the metrics that should not be collected and distributed for the observable resources selected by MonitoringMetricSelection.ResourceSelection. More...
static MonitoringMetricSelection	Default = CreateDefault() [get]
	Singleton containing the default value of a MonitoringMetricSelection More...

Detailed Description

Configures event and periodic metrics collection and distribution for a specific set of observable resources.

The full documentation is available in the C API: DDS_MonitoringMetricSelection

Member Function Documentation

With()

MonitoringMetricSelection Rti.Dds.Core.Policy.MonitoringMetricSelection.With ( Action< MonitoringMetricSelectionBuilder >  build )

inline

Creates a new MonitoringMetricSelection with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the values of this MonitoringMetricSelection

Returns

A new MonitoringMetricSelection with the changes applied by the Action

Equals() [1/2]

override bool Rti.Dds.Core.Policy.MonitoringMetricSelection.Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Rti.Dds.Core.Policy.MonitoringMetricSelection.Equals ( MonitoringMetricSelection  other )

inline

Compares for equality

GetHashCode()

override int Rti.Dds.Core.Policy.MonitoringMetricSelection.GetHashCode ( )

inline

Gets the hash code

Property Documentation

ResourceSelection

string Rti.Dds.Core.Policy.MonitoringMetricSelection.ResourceSelection

get

An expression pattern used to match the resource names of observable resources to which the configured metrics through MonitoringMetricSelection.EnabledMetricsSelection and MonitoringMetricSelection.DisabledMetricsSelection apply.

The full documentation is available in the C API: DDS_MonitoringMetricSelection_resource_selection

EnabledMetricsSelection

ImmutableList<string> Rti.Dds.Core.Policy.MonitoringMetricSelection.EnabledMetricsSelection

get

A sequence of POSIX fnmatch patterns that match the names of the metrics that should be collected and distributed for the observable resources selected by MonitoringMetricSelection.ResourceSelection.

The full documentation is available in the C API: DDS_MonitoringMetricSelection_enabled_metrics_selection

DisabledMetricsSelection

ImmutableList<string> Rti.Dds.Core.Policy.MonitoringMetricSelection.DisabledMetricsSelection

get

A sequence of POSIX fnmatch patterns that match the names of the metrics that should not be collected and distributed for the observable resources selected by MonitoringMetricSelection.ResourceSelection.

The full documentation is available in the C API: DDS_MonitoringMetricSelection_disabled_metrics_selection

Default

MonitoringMetricSelection Rti.Dds.Core.Policy.MonitoringMetricSelection.Default = CreateDefault()

staticget

Singleton containing the default value of a MonitoringMetricSelection