IBM Rational Performance Tester TES

com.ibm.rational.test.lt.kernel.statistics
Interface IScalar

All Superinterfaces:
IStatTree

public interface IScalar
extends IStatTree

The IScalar interface is used for simple integer statistical counters.

This interface provides methods that are used for counters of type SCALAR and STATIC.

See Also:
StatType

Method Summary
 void decrement()
          Decrement the counter by 1.
 void decrement(long value)
          Decrement the counter by the given value.
 void increment()
          Increment the counter by 1.
 void increment(long value)
          Increment the counter by the given value.
 void reset()
          Mark the counter unmodified.
 void setValue(long v)
          Set the value of the counter.
 long value()
          Return the current value of the counter.
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.statistics.IStatTree
getAverage, getAverage, getDistribution, getDistribution, getRange, getRange, getRate, getRate, getScalar, getScalar, getStat, getStatic, getStatic, getStructure, getStructure, getText, getText, getVerificationPoint, getVerificationPoint, makeDefinition, makeObservation, setDescription
 

Method Detail

increment

void increment()
Increment the counter by 1.


increment

void increment(long value)
Increment the counter by the given value.

Parameters:
value - the number to add to the counter.

decrement

void decrement()
Decrement the counter by 1.


decrement

void decrement(long value)
Decrement the counter by the given value.

Parameters:
value - the number to subtract from the counter.

reset

void reset()
Mark the counter unmodified.

If a counter is not modified in a particular interval it will not be reported to the RPT workbench.

Used for internal testing purposes only.


setValue

void setValue(long v)
Set the value of the counter.

Parameters:
v - the new value for the counter.

value

long value()
Return the current value of the counter.

Returns:
the current value of the counter.

IBM Rational Performance Tester TES

© Copyright IBM Corp. 2012. All rights reserved.