Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricContainer< out out T > Interface Template Reference

A container interface visible to the user to create and access metric of particular type. More...

Public Member Functions
T	Create (string name, string desc)
	Creates metric of type T from name and description. More...
bool	Delete (string name)
	Deletes a metric with given name and description. More...

Properties
T	this[string name] [get]
	Indexer to access metric by name. More...

Detailed Description

A container interface visible to the user to create and access metric of particular type.

Template Parameters

T	Type of mutable metric.

Type Constraints

T

:

IMutableMetric

Member Function Documentation

Create()

T Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricContainer< out out T >.Create	(	string	name,
		string	desc
	)

Creates metric of type T from name and description.

Exceptions

MetricsException

thrown if metric with the name already exists.

Parameters

name	Name of the metric.
desc	Description of the metric.

Returns

Newly created Metric.

Delete()

bool Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricContainer< out out T >.Delete

(

string

name

)

Deletes a metric with given name and description.

Parameters

name	Name of the metric.

Returns

True if the metric is deleted, false if it does not exist

Property Documentation

this[string name]

T Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricContainer< out out T >.this[string name]

get

Indexer to access metric by name.

Exceptions

MetricsException

thrown if metric with that name does not exist.

Parameters

name	Name of the metric.

Returns

Metric with given name.

---

The documentation for this interface was generated from the following file:

• lang/cs/Org.Apache.REEF.Common/metrics/MutableMetricsLayer/IMetricContainer.cs