All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.eou.toolkit.gauge.GaugeModel

public interface GaugeModel

extends BoundedRangeModel

CLIP

Constant used as an argument to setRangeAdjustmentMethod().

CLIP_AND_STORE

Constant used as an argument to setRangeAdjustmentMethod().

CONTINUOUS

Constant used as an argument to setAccumulatorMeasurementMethod() when the accumulator measurement interval should be never ending.

copyright

DISCRETE

Constant used as an argument to setAccumulatorMeasurementMethod() when the accumulator interval is used as the accumulator measurement interval.

EXTEND_EXACT

Constant used as an argument to setRangeAdjustmentMethod().

EXTEND_ROUNDED

Constant used as an argument to setRangeAdjustmentMethod().

ROLLING_AVERAGE

Constant used as an argument to setAccumulatorMeasurementMethod() when the accumulator measurement interval as supplied to setAccumulatorMeasurementInterval() should be used.

WRAP

Constant used as an argument to setRangeAdjustmentMethod().

accumulate()

Increment the accumulator total by one.

accumulate(int)

Increment the accumulator total by the specified increment.

addGaugeModelListener(GaugeModelListener)

Add a gaugeModelListener to the GaugeModel.

getAccumulatorInterval()

Return the accumulator interval.

getAccumulatorMeasurementInterval()

Return the accumulator measurement interval.

getAccumulatorMeasurementMethod()

Return the current accumulator measurement method.

getRangeAdjustmentMethod()

Return the current automatic range adjustment method.

isAccumulatorEnabled()

Return whether or not accumulation is enabled.

removeGaugeModelListener(GaugeModelListener)

Remove a gaugeModelListener from the GaugeModel.

resetAccumulator()

Resets all data members used by the accumulator and starts the timer.

setAccumulatorEnabled(boolean)

Specify whether accumulation is enabled.

setAccumulatorInterval(long)

Specify the accumulator interval in milliseconds.

setAccumulatorMeasurementInterval(long)

Specify the accumulator measurement interval in milliseconds.

setAccumulatorMeasurementMethod(int)

Specify the accumulator measurement method.

setRangeAdjustmentMethod(int)

Specify the required automatic gauge range adjustment method.

 public static final String copyright

 public static final int CLIP

Constant used as an argument to setRangeAdjustmentMethod(). Values outside of the current range are ignored.

See Also:

setRangeAdjustmentMethod

 public static final int EXTEND_EXACT

Constant used as an argument to setRangeAdjustmentMethod(). Values outside of the current range will extend the minimum or maximum to exactly incorporate the new value plus extent.

See Also:

setRangeAdjustmentMethod

 public static final int EXTEND_ROUNDED

Constant used as an argument to setRangeAdjustmentMethod(). Values outside of the current range will extend and round the minimum or maximum to include the new value plus extent.

See Also:

setRangeAdjustmentMethod

 public static final int WRAP

Constant used as an argument to setRangeAdjustmentMethod(). Values outside of the current range will be wrapped to keep the value plus extent within the current range. An extent greater than the model's range will result in the value being pegged at the minimum.

See Also:

setRangeAdjustmentMethod

 public static final int CLIP_AND_STORE

Constant used as an argument to setRangeAdjustmentMethod(). Values outside of the current range will be stored, but the minimum and maximum will not be altered. The gauge will display the minimum or maximum value, according to which is closest to the new value. This is the default range adjustment method.

See Also:

setRangeAdjustmentMethod

 public static final int DISCRETE

Constant used as an argument to setAccumulatorMeasurementMethod() when the accumulator interval is used as the accumulator measurement interval.

See Also:

setAccumulatorMeasurementMethod, setAccumulatorInterval, setAccumulatorEnabled

 public static final int ROLLING_AVERAGE

Constant used as an argument to setAccumulatorMeasurementMethod() when the accumulator measurement interval as supplied to setAccumulatorMeasurementInterval() should be used. By setting an accumulator measurement interval that is different to the accumulator interval, a rolling average of accumulator increments over the accumulator measurement interval is calculated at each accumulator interval.

See Also:

setAccumulatorMeasurementMethod, setAccumulatorMeasurementInterval, setAccumulatorInterval, setAccumulatorEnabled

 public static final int CONTINUOUS

Constant used as an argument to setAccumulatorMeasurementMethod() when the accumulator measurement interval should be never ending. The accumulator total will continue to increment, and will not be reset to zero at the end of each accumulator interval.

See Also:

setAccumulatorMeasurementMethod, setAccumulatorInterval, setAccumulatorEnabled

 public abstract void setRangeAdjustmentMethod(int rangeAdjustmentMethod)

Specify the required automatic gauge range adjustment method.

See Also:

CLIP, CLIP_AND_STORE, EXTEND_EXACT, EXTEND_ROUNDED, WRAP

 public abstract int getRangeAdjustmentMethod()

Return the current automatic range adjustment method.

See Also:

setRangeAdjustmentMethod

 public abstract void setAccumulatorEnabled(boolean accumulatorEnabled)

Specify whether accumulation is enabled. While enabled, an accumulator total is incremented in response to accumulate() method calls. At the end of each accumulator interval, the gauge value is set to the accumulator total, and the accumulator total reset to zero.

See Also:

setAccumulatorInterval, setAccumulatorMeasurementMethod, setAccumulatorMeasurementInterval

 public abstract boolean isAccumulatorEnabled()

Return whether or not accumulation is enabled.

See Also:

setAccumulatorEnabled

 public abstract void setAccumulatorInterval(long accumulatorInterval)

Specify the accumulator interval in milliseconds. Any current accumulator total is reset to zero, and if enabled, accumulation restarted using the new accumulator interval. Values less than 1 are treated as 1.

See Also:

accumulate, setAccumulatorEnabled, setAccumulatorMeasurementMethod, setAccumulatorMeasurementInterval

 public abstract long getAccumulatorInterval()

Return the accumulator interval.

See Also:

setAccumulatorInterval

 public abstract void setAccumulatorMeasurementMethod(int accumulatorMeasurementMethod)

Specify the accumulator measurement method. This determines the way in which accumulator increments are used. Any current accumulator total is reset to zero, and if enabled, accumulation is restarted using the current accumulator interval.

See Also:

DISCRETE, ROLLING_AVERAGE, CONTINUOUS, accumulate, setAccumulatorEnabled, setAccumulatorInterval, setAccumulatorMeasurementInterval

 public abstract int getAccumulatorMeasurementMethod()

Return the current accumulator measurement method.

See Also:

setAccumulatorMeasurementMethod

 public abstract void setAccumulatorMeasurementInterval(long accumulatorMeasurementInterval)

Specify the accumulator measurement interval in milliseconds. Any current accumulator total is reset to zero, and if enabled, accumulation restarted using the new accumulator interval. Values less than 1 are treated as 1.

See Also:

accumulate, setAccumulatorEnabled, setAccumulatorInterval, setAccumulatorMeasurementMethod

 public abstract long getAccumulatorMeasurementInterval()

Return the accumulator measurement interval.

See Also:

setAccumulatorMeasurementInterval

 public abstract void accumulate()

Increment the accumulator total by one. At the next accumulator interval the gauge value will be set to the accumulator total.

See Also:

setAccumulatorInterval, setAccumulatorMeasurementInterval

 public abstract void accumulate(int increment)

Increment the accumulator total by the specified increment. At the next accumulator interval the gauge value will be set to the accumulator total.

See Also:

setAccumulatorInterval, setAccumulatorMeasurementInterval

 public abstract void resetAccumulator()

Resets all data members used by the accumulator and starts the timer.

 public abstract void addGaugeModelListener(GaugeModelListener gaugeModelListener)

Add a gaugeModelListener to the GaugeModel.

See Also:

removeGaugeModelListener

 public abstract void removeGaugeModelListener(GaugeModelListener gaugeModelListener)

Remove a gaugeModelListener from the GaugeModel.

See Also:

addGaugeModelListener

All Packages  Class Hierarchy  This Package  Previous  Next  Index