desmoj.core.statistic

Class TimeSeries

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.StatisticObject

desmoj.core.statistic.StatisticObjectSupportingTimeSpans

desmoj.core.statistic.TimeSeries

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

TimeSeriesAnimation

public class TimeSeries
extends StatisticObjectSupportingTimeSpans

The TimeSeries class is recording data from a ValueSupplier object and saving it to a file, making data available to a TimeSeriesPlotter or doing both. Either every time the ValueSupplier object has changed or at every tick of the SimClock. See the automatic parameter in the constructor. If writing to a file is claimed, the first line of the file contains the name of the file. Then each line of the file contains a SimTime value and the value of the ValueSupplier object at that point of time in the simulation, separated by a ";".
One can choose when the recording of the values will start and stop. See the constructor for further information.
Reseting the TimeSeries object will delete the contents of the file.
This TimeSeries object will be the observer of the ValueSupplier object given in the constructor. When constructing a new TimeSeries object it will be added to the list of observers of the ValueSupplier. That means this TimeSeries object will be updated automatically every time the observed ValueSupplier has changed and has called its notifyStatistics() method. As separator between different values (e.g. SimTime and value of the Valuesupplier) ";" is used. See also FileOutput.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Soenke Claassen, modified by Philip Joschko, based on DESMO-C from Thomas Schniewind, 1998 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also:

FileOutput

Field Summary

Fields inherited from class desmoj.core.statistic.StatisticObject

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
TimeSeries(Model ownerModel, java.lang.String name, java.lang.String fileName, TimeInstant start, TimeInstant end, boolean showInReport, boolean showInTrace) Constructor for a TimeSeries object that has NO connection to a ValueSupplier but will write data to the given file.
TimeSeries(Model ownerModel, java.lang.String name, java.lang.String fileName, ValueSupplier valSup, TimeInstant start, TimeInstant end, boolean automatic, boolean showInReport, boolean showInTrace) Constructor for a TimeSeries object that will observe a ValueSupplier and write data to the given file.
TimeSeries(Model ownerModel, java.lang.String name, TimeInstant start, TimeInstant end, boolean showInReport, boolean showInTrace) Constructor for a TimeSeries object that has NO connection to a ValueSupplier and will NOT write data into a file.
TimeSeries(Model ownerModel, java.lang.String name, ValueSupplier valSup, TimeInstant start, TimeInstant end, boolean automatic, boolean showInReport, boolean showInTrace) Constructor for a TimeSeries object that will observe a ValueSupplier but will NOT write data into a file.

Method Summary

Modifier and Type	Method and Description
void	connectToPlotter(java.util.Observer plotter) Connects this statistic object with its GraphicalObserver.
Reporter	createDefaultReporter() Returns a default Reporter!
TimeInstant	get_end() Gets the end instant of this TimeSeries.
TimeInstant	get_start() Gets the start instant of this TimeSeries.
java.util.List<java.lang.Double>	getDataValues() Gets the list of data values.
java.lang.String	getGroup() Gets the group ID used for HTML report clustering.
java.util.List<java.lang.Double>	getTimeValues() Gets the list of time values.
double	getValue() Returns the actual value of the ValueSupplier which values are recorded from this TimeSeries object.
void	reset() Resets this TimeSeries object by deleting the contents of the file to which all the data is saved to.
void	setGroup(java.lang.String groupID) Sets the group ID used for HTML report clustering.
void	update() Updates this TimeSeries object by fetching the actual value of the ValueSupplier and processing it.
void	update(double val) Updates this TimeSeries object with the double value given as parameter.
void	update(java.util.Observable o, java.lang.Object arg) Implementation of the virtual update(Observable, Object) method of the Observer interface.
void	update(TimeSpan t) Updates this data collector object with a specific TimeSpan.

Methods inherited from class desmoj.core.statistic.StatisticObjectSupportingTimeSpans

getShowTimeSpansInReport, getUnit, setShowTimeSpansInReport

Methods inherited from class desmoj.core.statistic.StatisticObject

getUnitText, round, setUnit

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, 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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeries

public TimeSeries(Model ownerModel,
                  java.lang.String name,
                  java.lang.String fileName,
                  TimeInstant start,
                  TimeInstant end,
                  boolean showInReport,
                  boolean showInTrace)

Constructor for a TimeSeries object that has NO connection to a ValueSupplier but will write data to the given file.

Parameters:

ownerModel - Model : The model this TimeSeries object is associated to

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

fileName - java.lang.String : The name of the file the values will be saved to. Must comply to the naming rules of the underlying Operating System. This name will be saved in the first line of the file.

start - TimeInstant : The instant at which this TimeSeries will start to save the values to the file.

end - TimeInstant : The instant at which this TimeSeries will stop to save the values to the file. Choose an end time that lies before the start time to record the values for all the time.

showInReport - boolean : Flag for showing this TimeSeries in report files. Set it to true if TimeSeries should show up in report. Set it to false if TimeSeries should not be shown in report.

showInTrace - boolean : Flag for showing this TimeSeries in trace files. Set it to true if TimeSeries should show up in trace. Set it to false if TimeSeries should not be shown in trace.

TimeSeries

public TimeSeries(Model ownerModel,
                  java.lang.String name,
                  java.lang.String fileName,
                  ValueSupplier valSup,
                  TimeInstant start,
                  TimeInstant end,
                  boolean automatic,
                  boolean showInReport,
                  boolean showInTrace)

Constructor for a TimeSeries object that will observe a ValueSupplier and write data to the given file.

Parameters:

ownerModel - Model : The model this TimeSeries object is associated to

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

fileName - java.lang.String : The name of the file the values will be saved to. Must comply to the naming rules of the underlying Operating System. This name will be saved in the first line of the file.

valSup - ValueSupplier : The values from this ValueSupplier will be recorded and saved in the file. The given ValueSupplier will be observed by this TimeSeries object.

start - TimeInstant : The instant at which this TimeSeries will start to save the values to the file.

end - TimeInstant : The instant at which this TimeSeries will stop to save the values to the file. Choose an end time that lies before the start time to record the values for all the time.

automatic - boolean : Shall the values be recorded automatically at every tick of the SimClock?

showInReport - boolean : Flag for showing this TimeSeries in report files. Set it to true if TimeSeries should show up in report. Set it to false if TimeSeries should not be shown in report.

showInTrace - boolean : Flag for showing this TimeSeries in trace files. Set it to true if TimeSeries should show up in trace. Set it to false if TimeSeries should not be shown in trace.

TimeSeries

public TimeSeries(Model ownerModel,
                  java.lang.String name,
                  TimeInstant start,
                  TimeInstant end,
                  boolean showInReport,
                  boolean showInTrace)

Constructor for a TimeSeries object that has NO connection to a ValueSupplier and will NOT write data into a file. If you will not connect this object to a TimeSeriesPlotter after using this constructor, it will be useless. Choose another constructor for writing data to file.

Parameters:

ownerModel - Model : The model this TimeSeries object is associated to

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

start - TimeInstant : The instant at which this TimeSeries will start to save the values to the file.

end - TimeInstant : The instant at which this TimeSeries will stop to save the values to the file. Choose an end time that lies before the start time to record the values for all the time.

showInReport - boolean : Flag for showing this TimeSeries in report files. Set it to true if TimeSeries should show up in report. Set it to false if TimeSeries should not be shown in report.

showInTrace - boolean : Flag for showing this TimeSeries in trace files. Set it to true if TimeSeries should show up in trace. Set it to false if TimeSeries should not be shown in trace.

TimeSeries

public TimeSeries(Model ownerModel,
                  java.lang.String name,
                  ValueSupplier valSup,
                  TimeInstant start,
                  TimeInstant end,
                  boolean automatic,
                  boolean showInReport,
                  boolean showInTrace)

Constructor for a TimeSeries object that will observe a ValueSupplier but will NOT write data into a file. If you will not connect this object to a TimeSeriesPlotter after using this constructor, it will be useless! Choose another constructor for writing data to file.

Parameters:

ownerModel - Model : The model this TimeSeries object is associated to

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

valSup - ValueSupplier : The values from this ValueSupplier will be recorded and saved in the file. The given ValueSupplier will be observed by this TimeSeries object.

start - TimeInstant : The point of SimTime this TimeSeries will start to save the values to the file.

end - TimeInstant : The point of SimTime this TimeSeries will stop to save the values to the file. Choose an end time that lies before the start time to record the values for all the time.

automatic - boolean : Shall the values be recorded automatically at every tick of the SimClock?

showInReport - boolean : Flag for showing this TimeSeries in report files. Set it to true if TimeSeries should show up in report. Set it to false if TimeSeries should not be shown in report.

showInTrace - boolean : Flag for showing this TimeSeries in trace files. Set it to true if TimeSeries should show up in trace. Set it to false if TimeSeries should not be shown in trace.

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a default Reporter! In addition, all data (values) can be saved in a file or displayed in the GraphicalObserver.
Overrides the method: createDefaultReporter() from desmoj.core.simulator.Reportable.

Returns:

desmoj.report.Reporter :null will be returned

getValue

public double getValue()

Returns the actual value of the ValueSupplier which values are recorded from this TimeSeries object.

Returns:

double : The actual value of the observed ValueSupplier object.

reset

public void reset()

Resets this TimeSeries object by deleting the contents of the file to which all the data is saved to. The name of the file will remain the same. This is done by closing and opening the existing file.

Overrides:

reset in class Reportable

update

public void update(TimeSpan t)

Description copied from class: StatisticObjectSupportingTimeSpans

Updates this data collector object with a specific TimeSpan.

Specified by:

update in class StatisticObjectSupportingTimeSpans

Parameters:

t - TimeSpan : The time span to update this data collector.

update

public void update()

Updates this TimeSeries object by fetching the actual value of the ValueSupplier and processing it. The ValueSupplier is passed in the constructor of this TimeSeries object. This update() method complies with the one described in DESMO, see [Page91].

update

public void update(double val)

Updates this TimeSeries object with the double value given as parameter. In some cases it might be more convenient to pass the value this ValueStatistics will be updated with directly within the update(double val) method instead of going via the ValueSupplier.

Parameters:

val - double : The value with which this TimeSeries will be updated.

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Implementation of the virtual update(Observable, Object) method of the Observer interface. This method will be called automatically from an Observable object within its notifyObservers() method.

Parameters:

o - java.util.Observable : The Observable calling this method within its own notifyObservers() method.

arg - Object : The Object with which this TimeSeries is updated.

connectToPlotter

public void connectToPlotter(java.util.Observer plotter)

Connects this statistic object with its GraphicalObserver. Advises this object to keep the values in the memory, because the TimeSeriesPlotter requires this.

Parameters:

plotter - The TimeSeriesPlotter which will display this TimeSeries object.

getDataValues

public java.util.List<java.lang.Double> getDataValues()

Gets the list of data values.

Returns:

The list with all the data values.

getTimeValues

public java.util.List<java.lang.Double> getTimeValues()

Gets the list of time values.

Returns:

The list of all the time values.

get_start

public TimeInstant get_start()

Gets the start instant of this TimeSeries.

Returns:

The start instant of this TimeSeries.

get_end

public TimeInstant get_end()

Gets the end instant of this TimeSeries.

Returns:

The endinstant of this TimeSeries.

getGroup

public java.lang.String getGroup()

Gets the group ID used for HTML report clustering.

Returns:

The group ID used for HTML report clustering.

setGroup

public void setGroup(java.lang.String groupID)

Sets the group ID used for HTML report clustering.

Parameters:

groupID - The group ID used for HTML report clustering.