public interface ArmMetricDefinition extends ArmInterface
ArmMetricDefinition
.
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:
METRIC_USE_...
below for
the defined values. Any negative value is also permitted;
the negative range is reserved for application-specific values.
ArmMetricFactory.newArmMetricCounter32Definition(org.opengroup.arm40.transaction.ArmApplicationDefinition, java.lang.String, java.lang.String, short, org.opengroup.arm40.transaction.ArmID)
].
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.
ArmMetricDefinition
are created using the
newArmMetric...Definition()
methods of ArmMetricFactory
.Modifier and Type | Field and Description |
---|---|
static short |
METRIC_USE_GENERAL
No specific usage semantics are declared.
|
static short |
METRIC_USE_TRAN_SIZE
Metric represents the "size" of the transaction
(counter & gauge only).
|
static short |
METRIC_USE_TRAN_STATUS
Metric represents status, like an error code
(numeric ID & string only).
|
Modifier and Type | Method and Description |
---|---|
ArmID |
getID()
Gets the (optional) ID for this definition.
|
java.lang.String |
getName()
Gets the name of this definition.
|
java.lang.String |
getUnits()
Gets the (optional) units description.
|
short |
getUsage()
Gets the usage semantics.
|
getErrorCode, getErrorMessage, setErrorCode
static final short METRIC_USE_GENERAL
static final short METRIC_USE_TRAN_SIZE
static final short METRIC_USE_TRAN_STATUS
ArmID getID()
null
.java.lang.String getName()
java.lang.String getUnits()
null
.short getUsage()
METRIC_USE_GENERAL
,
METRIC_USE_TRAN_SIZE
,
METRIC_USE_TRAN_STATUS
,
or an application-specific negative value.