OpenGroup::arm40::Provisional::metric::IArmMetricDefinition Interface Reference
[ARM 4.0 MetricsARM 4.0 Definitions]

The superclass for all the metric definition interfaces. More...

Inheritance diagram for OpenGroup::arm40::Provisional::metric::IArmMetricDefinition:
OpenGroup::arm40::Provisional::transaction::IArmInterface OpenGroup::arm40::Provisional::metric::IArmMetricCounter32Definition OpenGroup::arm40::Provisional::metric::IArmMetricCounter64Definition OpenGroup::arm40::Provisional::metric::IArmMetricCounterFloat32Definition OpenGroup::arm40::Provisional::metric::IArmMetricGauge32Definition OpenGroup::arm40::Provisional::metric::IArmMetricGauge64Definition OpenGroup::arm40::Provisional::metric::IArmMetricGaugeFloat32Definition OpenGroup::arm40::Provisional::metric::IArmMetricNumericId32Definition OpenGroup::arm40::Provisional::metric::IArmMetricNumericId64Definition OpenGroup::arm40::Provisional::metric::IArmMetricString32Definition

List of all members.

Public Member Functions

string getName ()
 Gets the name of this definition.
string getUnits ()
 Gets the (optional) units description.
short getUsage ()
 Gets the usage semantics.
IArmID getID ()
 Gets the (optional) ID for this definition.

Detailed Description

All the methods are defined in IArmMetricDefinition. The subclasses serve as markers for the data types. All the publicly accessible attributes are immutable and have a getter method for them.

The attributes are:

  • The definition of the application that contains the transaction. It must not be null.
  • Name. The maximum length is 127 characters. The name must not be null or zero-length.
  • Units. An optional string describing the units of measurement, such as "files" or "jobs in queue". It may be null.
  • Usage. Describes any additional information about the semantics of the metric. Most metrics will be classified as "general", indicating that there is no specific semantic declared. The two specific semantics are the size of the transaction, such as the number of files that were backed up, and a status that could contain data, such as an error code that describes why a transaction failed. See the field descriptions of METRIC_USE_... below for the defined values. Any negative value is also permitted; the negative range is reserved for application-specific values.
  • Optional ID. An optional 16-byte ID may be associated with the identity of a metric definition. The returned value, which could be null, is the same value passed to the factory method [e.g., IArmMetricFactory.newArmMetricCounter32Definition]. The ID value is bound to a unique combination of the metric format (e.g., Counter32), name, usage, and unit properties. When provided, the ID may be used as a concise alias for the unique combination. It may be null.

This class cannot be instantiated. Objects that implement a subclass of IArmMetricDefinition are created using the newArmMetric...Definition() methods of IArmMetricFactory

Member Function Documentation

IArmID OpenGroup::arm40::Provisional::metric::IArmMetricDefinition::getID (  ) 
the ID or null.
string OpenGroup::arm40::Provisional::metric::IArmMetricDefinition::getName (  ) 
the definition name.
string OpenGroup::arm40::Provisional::metric::IArmMetricDefinition::getUnits (  ) 
the units desciption or null.
short OpenGroup::arm40::Provisional::metric::IArmMetricDefinition::getUsage (  ) 

The documentation for this interface was generated from the following file:
  • opengroup/arm40/provisional/metric/IArmMetricDefinition.cs