|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--edu.cmu.cs.able.gaugeInfrastructure.Siena.SienaGaugeHandle
The proxy implementation of a Siena gauge. Objects of this class are held by gauge consumers who interact directly with the gauge through this control interface. Note, however, that gauge consumers get event-based reports by implementing the GaugeConsumer interface and registering with the gauge bus.
Constructor Summary | |
SienaGaugeHandle(GaugeID gid)
Creates new SienaGaugeHandle |
Method Summary | |
boolean |
configure(StringPairVector configParams)
The method called when configuring a gauge. |
GaugeID |
getGaugeID()
Returns the ID of the gauge that this is a handle for. |
boolean |
queryAllValues(GaugeValueVector values)
Queries the gauge for all values that the gauge reports. |
boolean |
queryState(StringPairVector setupParams,
StringPairVector configParams,
StringPairVector mappings)
Returns the state of the gauge. |
java.lang.String |
queryValue(java.lang.String valueName)
Called when a gauge is queried for a value. |
void |
registerGaugeConsumer(GaugeConsumer consumer)
|
void |
setGaugeID(GaugeID gaugeID)
Sets the ID of the gauge handle. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SienaGaugeHandle(GaugeID gid)
gid
- This ID of the gauge that will be managed by this
gauge manager.Method Detail |
public GaugeID getGaugeID()
getGaugeID
in interface GaugeControl
public void setGaugeID(GaugeID gaugeID)
gaugeID
- The Gauge IDpublic boolean queryAllValues(GaugeValueVector values)
queryAllValues
in interface GaugeControl
values
- Will be filled with a (name, property, value) tuple for
each value the gauge reports.public boolean queryState(StringPairVector setupParams, StringPairVector configParams, StringPairVector mappings)
queryState
in interface GaugeControl
setupParams
- The (name, value) pairs that the gauge was setup with.configParams
- The (name, value) pairs of the configuration of the gauge.mappings
- The (value, property) pairs for each gauge value mapping.public java.lang.String queryValue(java.lang.String valueName)
GaugeControl
queryValue
in interface GaugeControl
edu.cmu.cs.able.gaugeInfrastructure.GaugeControl
valueName
- The name of the value to be queried.public boolean configure(StringPairVector configParams)
GaugeControl
configure
in interface GaugeControl
edu.cmu.cs.able.gaugeInfrastructure.GaugeControl
configParams
- The configuration parameters for the gauge as (name, value) pairs.public void registerGaugeConsumer(GaugeConsumer consumer)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |