IDebug
© 1997-2001 Joseph Kiniry
© 2000-2001 KindSoftware
© 1997-1999 Caltech
All Rights Reserved

idebug
Class Statistic

java.lang.Object
  |
  +--idebug.Statistic
All Implemented Interfaces:
java.io.Serializable

public class Statistic
extends java.lang.Object
implements java.io.Serializable

This class represents a statistic that can be monitored in the monitoring system. Each statistic has its own unique ID (node-unique, not necessarily globally unique), a description, units, and other useful information that is represented in this class.

Version:
$Revision: 2146 $ $Date: 2005-02-13 16:54:27 +0000 (Sun, 13 Feb 2005) $
Author:
Joseph R. Kiniry
See Also:
Serialized Form

Constructor Summary
Statistic(java.lang.String units, double scale, float start, float inc, float dec)
           This the standard constructor for Statistic.
 
Method Summary
 double getDecrement()
           What is its default decrement?
 int getID()
           What is the unique ID of this statistic?
 double getIncrement()
           What is its default increment?
 double getScale()
           What is its default scaling factor?
 double getStart()
           What is its default start value?
 java.lang.String getUnits()
           What are its units?
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Statistic

public Statistic(java.lang.String units,
                 double scale,
                 float start,
                 float inc,
                 float dec)

This the standard constructor for Statistic. No other constructor can be legally used.

Parameters:
units - Statistic's units.
scale - Statistic's scaling factor.
start - Statistic's default starting value.
inc - Statistic's default increment value.
dec - Statistic's default decrement value.
Method Detail

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
Returns:
the (unique) hash code for this object.

getID

public int getID()

What is the unique ID of this statistic?

Returns:
the unique ID for this statistic.

getUnits

public java.lang.String getUnits()

What are its units?

Returns:
the units that this statistic represents.

getScale

public double getScale()

What is its default scaling factor?

Returns:
the scaling factor of this statistic.

getStart

public double getStart()

What is its default start value?

Returns:
the default starting value for this statistic.

getIncrement

public double getIncrement()

What is its default increment?

Returns:
the default increment for this statistic.

getDecrement

public double getDecrement()

What is its default decrement?

Returns:
the default decrement for this statistic.

IDebug
© 1997-2001 Joseph Kiniry
© 2000-2001 KindSoftware
© 1997-1999 Caltech
All Rights Reserved