|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.arm4.arm40.transaction.ArmInterface
org.arm4.arm40.metric.ArmMetricDefinition
public class ArmMetricDefinition
The superclass for all the metric definition interfaces.
All the methods are defined in ArmMetricDefinition
.
The subclasses serve as markers for the data types.
All the publicly accessible attributes are immutable and have a getter
method for them.
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
.
Field Summary | |
---|---|
protected static short |
ARM_METRIC_FORMAT_CNTRDIVR32
|
protected static short |
ARM_METRIC_FORMAT_COUNTER32
|
protected static short |
ARM_METRIC_FORMAT_COUNTER64
|
protected static short |
ARM_METRIC_FORMAT_GAUGE32
|
protected static short |
ARM_METRIC_FORMAT_GAUGE64
|
protected static short |
ARM_METRIC_FORMAT_GAUGEDIVR32
|
protected static short |
ARM_METRIC_FORMAT_NUMERICID32
|
protected static short |
ARM_METRIC_FORMAT_NUMERICID64
|
protected static short |
ARM_METRIC_FORMAT_STRING32
|
protected ArmApplicationDefinition |
m_appDefinition
|
protected short |
m_format
|
protected ArmID |
m_metricId
|
protected java.lang.String |
m_name
|
protected java.lang.String |
m_units
|
protected short |
m_usage
|
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). |
Fields inherited from class org.arm4.arm40.transaction.ArmInterface |
---|
m_errorCode, m_factory |
Constructor Summary | |
---|---|
ArmMetricDefinition(ArmApplicationDefinition definition,
java.lang.String name,
java.lang.String units,
short usage,
short format,
ArmID id)
Create the Arm Metric Definition. |
Method Summary | |
---|---|
ArmApplicationDefinition |
getApplicationDefinition()
|
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. |
Methods inherited from class org.arm4.arm40.transaction.ArmInterface |
---|
getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface |
---|
getErrorCode, getErrorMessage, setErrorCode |
Field Detail |
---|
public static final short METRIC_USE_GENERAL
public static final short METRIC_USE_TRAN_SIZE
public static final short METRIC_USE_TRAN_STATUS
protected static final short ARM_METRIC_FORMAT_COUNTER32
protected static final short ARM_METRIC_FORMAT_COUNTER64
protected static final short ARM_METRIC_FORMAT_CNTRDIVR32
protected static final short ARM_METRIC_FORMAT_GAUGE32
protected static final short ARM_METRIC_FORMAT_GAUGE64
protected static final short ARM_METRIC_FORMAT_GAUGEDIVR32
protected static final short ARM_METRIC_FORMAT_NUMERICID32
protected static final short ARM_METRIC_FORMAT_NUMERICID64
protected static final short ARM_METRIC_FORMAT_STRING32
protected ArmApplicationDefinition m_appDefinition
protected java.lang.String m_name
protected java.lang.String m_units
protected short m_usage
protected short m_format
protected ArmID m_metricId
Constructor Detail |
---|
public ArmMetricDefinition(ArmApplicationDefinition definition, java.lang.String name, java.lang.String units, short usage, short format, ArmID id)
definition
- name
- units
- usage
- format
- id
- Method Detail |
---|
public java.lang.String getName()
ArmMetricDefinition
getName
in interface ArmMetricDefinition
public java.lang.String getUnits()
ArmMetricDefinition
getUnits
in interface ArmMetricDefinition
null
.public short getUsage()
ArmMetricDefinition
getUsage
in interface ArmMetricDefinition
ArmMetricDefinition.METRIC_USE_GENERAL
,
ArmMetricDefinition.METRIC_USE_TRAN_SIZE
,
ArmMetricDefinition.METRIC_USE_TRAN_STATUS
,
or an application-specific negative value.public ArmID getID()
ArmMetricDefinition
getID
in interface ArmMetricDefinition
null
.public ArmApplicationDefinition getApplicationDefinition()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |