|
SSJ V. 1.2.5. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Observable
umontreal.iro.lecuyer.stat.StatProbe
public abstract class StatProbe
The objects of this class are statistical probes or
collectors, which are elementary devices for collecting
statistics. Each probe collects statistics on a given variable.
The subclasses Tally
, TallyStore
, and
Accumulate
(from package
simevents
)
implement two
specific types of probes, for the case of successive observations
X1, X2, X3,..., and for the case of a variable whose value
evolves in time, respectively.
StatProbe
extends Observable
from
package java.util
, allowing statistical probes to register
Observer
objects.
When a probe is updated, i.e., receives a new statistical observation,
it broadcasts this new data to all registered observers.
The broadcasting of observations to registered observers can be turned
ON or OFF at any time.
It is initially OFF by default and should stay OFF when there are
no registered observers, to avoid unnecessary overhead.
The data collection by the statistical probe itself can also be turned ON or OFF. By default, it is initially ON. We can turn it OFF, for example, if we want to use the statistical probe only to pass data to the observers, and do not need it to store any information.
Constructor Summary | |
---|---|
StatProbe()
|
Method Summary | |
---|---|
abstract double |
average()
Returns the average for this collector. |
Object |
clone()
|
String |
getName()
Returns the name associated with this probe, or null if no name was specified upon construction. |
abstract void |
init()
Initializes the statistical collector. |
double |
max()
Returns the largest value taken by the variable since the last initialization of this probe. |
double |
min()
Returns the smallest value taken by the variable since the last initialization of this probe. |
abstract String |
report()
Returns a string containing a report for this statistical collector. |
void |
setBroadcasting(boolean b)
Instructs the probe to turn its broadcasting ON or OFF. |
void |
setCollecting(boolean b)
Turns ON or OFF the statistical collection of statistical observations. |
void |
setName(String name)
Sets the name of this statistical collector to name. |
double |
sum()
Returns the sum cumulated so far for this probe. |
Methods inherited from class java.util.Observable |
---|
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StatProbe()
Method Detail |
---|
public abstract void init()
public void setName(String name)
public String getName()
public double min()
public double max()
public double sum()
Tally
or
Accumulate
).
public abstract double average()
public abstract String report()
public void setBroadcasting(boolean b)
Warning: To avoid useless overhead and performance degradation, broadcasting should never be turned ON when there are no registered observers.
b
- true to turn broadcasting ON, false to turn it OFFpublic void setCollecting(boolean b)
b
- true to activate statistical collection,
false to deactivate itpublic Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
|
SSJ V. 1.2.5. |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |