desmoj.core.statistic

Class DataListTally.DataList

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.DataListTally.DataList

Enclosing class:

DataListTally

public class DataListTally.DataList
extends Reportable

A simple List for storing values passed to a Tally. This list is created to produce low overhead while simulating.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataListTally.DataList.Element A List's Element.

Constructor Summary

Constructors

Constructor and Description
DataList(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a new DataList

Method Summary

Modifier and Type	Method and Description
void	add(double value) Adds an Element to the end of the DataList.
void	clear() Removes all Elements from this List.
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this DataList.
DataListTally.DataList.Element	getFirst() Returns the list's first Element.
DataListTally.DataList.Element	getLast() Returns the list's last Element.
int	getLength() Returns the list's length.
java.lang.String	getTallyName() Returns the name of the Tally, this list belongs to.
DataListTally.DataList	sort(DataListTally.DataList list) Sorts the given list using a merge-sort algorithm
java.lang.String	toString() Creates a String containing all Elements of the list and its length.

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, reset, resetAt, setCorrespondingSchedulable, setDescription, setReporter

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataList

public DataList(Model owner,
                java.lang.String name,
                boolean showInReport,
                boolean showInTrace)

Constructor for a new DataList

Parameters:

owner - Model : The model this DataList is associated to

name - java.lang.String : The name of this DataList object

showInReport - boolean : Flag for showing the report about this DataList.

showInTrace - boolean : Flag for showing the trace output of this DataList.

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this DataList.

Returns:

desmoj.report.Reporter : The Reporter for this DataList.

getLength

public int getLength()

Returns the list's length.

Returns:

the length of this DataList.

add

public void add(double value)

Adds an Element to the end of the DataList.

Parameters:

value - double : The value of the new Element in the list.

clear

public void clear()

Removes all Elements from this List.

sort

public DataListTally.DataList sort(DataListTally.DataList list)

Sorts the given list using a merge-sort algorithm

Parameters:

list - DataList : the list to be sorted.

Returns:

The sorted list.

toString

public java.lang.String toString()

Creates a String containing all Elements of the list and its length.

Overrides:

toString in class NamedObject

Returns:

the list as String.

getFirst

public DataListTally.DataList.Element getFirst()

Returns the list's first Element.

Returns:

the first Element or null if the list is empty.

getLast

public DataListTally.DataList.Element getLast()

Returns the list's last Element.

Returns:

the last Element of null if the list is empty.

getTallyName

public java.lang.String getTallyName()

Returns the name of the Tally, this list belongs to.

Returns:

the Tally's name.