|
SSJ V. labo. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectumontreal.iro.lecuyer.stat.list.ListOfStatProbes<E>
public class ListOfStatProbes<E extends StatProbe>
Represents a list of statistical probes that
can be managed simultaneously.
Each element of this list is a StatProbe
instance which can be obtained and manipulated.
When constructing a list of statistical probes, one specifies the
concrete subclass of the StatProbe objects in it.
One then creates an empty list of probes, and fills
it with statistical probes.
If the list is not intended to be modified, one can then use the
setUnmodifiable to prevent any change in the contents of
the list.
Each list of statistical probes can have a global name describing the contents of its elements, and local names associated with each individual probe. For example, a list of statistical probes for the waiting times can have the global name Waiting times while the individual probes have local names type 1, type 2, etc. These names are used for formatting reports.
Facilities are provided to fill arrays with sums, averages, etc. obtained from the individual statistical probes. Methods are also provided to manipulate the contents of the list. However, one should always call init immediately after adding or removing statistical probes in the list.
| Constructor Summary | |
|---|---|
ListOfStatProbes()
Constructs an empty list of statistical probes. |
|
ListOfStatProbes(String name)
Constructs an empty list of statistical probes with name name. |
|
| Method Summary | ||
|---|---|---|
boolean |
add(E o)
|
|
void |
add(int index,
E o)
|
|
boolean |
addAll(Collection<? extends E> c)
|
|
boolean |
addAll(int index,
Collection<? extends E> c)
|
|
void |
addArrayOfObservationListener(ArrayOfObservationListener l)
Adds the observation listener l to the list of observers of this list of statistical probes. |
|
void |
average(double[] a)
For each probe in this list, computes the average by calling average, and stores
the results into the array a. |
|
void |
clear()
|
|
void |
clearArrayOfObservationListeners()
Removes all observation listeners from the list of observers of this list of statistical probes. |
|
ListOfStatProbes<E> |
clone()
Clones this object. |
|
boolean |
contains(Object o)
|
|
boolean |
containsAll(Collection<?> c)
|
|
boolean |
equals(Object o)
|
|
E |
get(int index)
|
|
String |
getName()
Returns the global name of this list of statistical probes. |
|
int |
hashCode()
|
|
int |
indexOf(Object o)
|
|
void |
init()
Initializes this list of statistical probes by calling init on each element. |
|
boolean |
isBroadcasting()
Determines if this list of statistical probes is broadcasting observations to registered observers. |
|
boolean |
isCollecting()
Determines if this list of statistical probes is collecting values. |
|
boolean |
isEmpty()
|
|
boolean |
isModifiable()
Determines if this list of statistical probes is modifiable, i.e., if probes can be added or removed. |
|
Iterator<E> |
iterator()
|
|
int |
lastIndexOf(Object o)
|
|
ListIterator<E> |
listIterator()
|
|
ListIterator<E> |
listIterator(int index)
|
|
void |
notifyListeners(double[] x)
Notifies the observation x to all registered observers if broadcasting is ON. |
|
E |
remove(int index)
|
|
boolean |
remove(Object o)
|
|
boolean |
removeAll(Collection<?> c)
|
|
void |
removeArrayOfObservationListener(ArrayOfObservationListener l)
Removes the observation listener l from the list of observers of this list of statistical probes. |
|
String |
report()
Formats a report for each probe in the list of statistical probes. |
|
boolean |
retainAll(Collection<?> c)
|
|
E |
set(int index,
E element)
|
|
void |
setBroadcasting(boolean b)
Sets the status of the observation broadcasting mechanism to b. |
|
void |
setCollecting(boolean c)
Sets the status of the statistical collecting mechanism to c. |
|
void |
setName(String name)
Sets the global name of this list to name. |
|
void |
setUnmodifiable()
Forbids any future modification to this list of statistical probes. |
|
int |
size()
|
|
List<E> |
subList(int fromIndex,
int toIndex)
|
|
void |
sum(double[] s)
For each probe in the list, computes the sum by calling sum, and stores
the results into the array s. |
|
Object[] |
toArray()
|
|
|
toArray(T[] a)
|
|
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ListOfStatProbes()
public ListOfStatProbes(String name)
name - the name of the new list.| Method Detail |
|---|
public String getName()
public void setName(String name)
name - the new global name of the list.public boolean isModifiable()
setUnmodifiable method.
public void setUnmodifiable()
public void init()
init on each element.
public void sum(double[] s)
sum, and stores
the results into the array s. This method throws an exception if the size of s
mismatches with the size of the list.
s - the array to be filled with sums.
NullPointerException - if s is null.
IllegalArgumentException - if s.length
does not correspond to size.public void average(double[] a)
average, and stores
the results into the array a. This method throws an exception if the size of s
mismatches with the size of the list.
a - the array to be filled with averages.
NullPointerException - if a is null.
IllegalArgumentException - if a.length
does not correspond to size.public boolean isCollecting()
public void setCollecting(boolean c)
c - the status of statistical collecting.public boolean isBroadcasting()
public void setBroadcasting(boolean b)
b - the status of broadcasting.public void addArrayOfObservationListener(ArrayOfObservationListener l)
l - the new observation listener.
NullPointerException - if l is null.public void removeArrayOfObservationListener(ArrayOfObservationListener l)
l - the observation listener to be deleted.public void clearArrayOfObservationListeners()
public void notifyListeners(double[] x)
public String report()
public ListOfStatProbes<E> clone()
clone in class Objectpublic boolean add(E o)
add in interface Collection<E extends StatProbe>add in interface List<E extends StatProbe>
public void add(int index,
E o)
add in interface List<E extends StatProbe>public boolean addAll(Collection<? extends E> c)
addAll in interface Collection<E extends StatProbe>addAll in interface List<E extends StatProbe>
public boolean addAll(int index,
Collection<? extends E> c)
addAll in interface List<E extends StatProbe>public void clear()
clear in interface Collection<E extends StatProbe>clear in interface List<E extends StatProbe>public boolean contains(Object o)
contains in interface Collection<E extends StatProbe>contains in interface List<E extends StatProbe>public boolean containsAll(Collection<?> c)
containsAll in interface Collection<E extends StatProbe>containsAll in interface List<E extends StatProbe>public boolean equals(Object o)
equals in interface Collection<E extends StatProbe>equals in interface List<E extends StatProbe>equals in class Objectpublic E get(int index)
get in interface List<E extends StatProbe>public int hashCode()
hashCode in interface Collection<E extends StatProbe>hashCode in interface List<E extends StatProbe>hashCode in class Objectpublic int indexOf(Object o)
indexOf in interface List<E extends StatProbe>public boolean isEmpty()
isEmpty in interface Collection<E extends StatProbe>isEmpty in interface List<E extends StatProbe>public Iterator<E> iterator()
iterator in interface Iterable<E extends StatProbe>iterator in interface Collection<E extends StatProbe>iterator in interface List<E extends StatProbe>public int lastIndexOf(Object o)
lastIndexOf in interface List<E extends StatProbe>public ListIterator<E> listIterator()
listIterator in interface List<E extends StatProbe>public ListIterator<E> listIterator(int index)
listIterator in interface List<E extends StatProbe>public E remove(int index)
remove in interface List<E extends StatProbe>public boolean remove(Object o)
remove in interface Collection<E extends StatProbe>remove in interface List<E extends StatProbe>public boolean removeAll(Collection<?> c)
removeAll in interface Collection<E extends StatProbe>removeAll in interface List<E extends StatProbe>public boolean retainAll(Collection<?> c)
retainAll in interface Collection<E extends StatProbe>retainAll in interface List<E extends StatProbe>
public E set(int index,
E element)
set in interface List<E extends StatProbe>public int size()
size in interface Collection<E extends StatProbe>size in interface List<E extends StatProbe>
public List<E> subList(int fromIndex,
int toIndex)
subList in interface List<E extends StatProbe>public Object[] toArray()
toArray in interface Collection<E extends StatProbe>toArray in interface List<E extends StatProbe>public <T> T[] toArray(T[] a)
toArray in interface Collection<E extends StatProbe>toArray in interface List<E extends StatProbe>
|
SSJ V. labo. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||