desmoj.extensions.visualization2d.animation.core.statistic

Class TallyAnimation

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.ValueStatistics

desmoj.core.statistic.Tally

desmoj.extensions.visualization2d.animation.core.statistic.TallyAnimation

All Implemented Interfaces:

java.util.Observer

public class TallyAnimation
extends Tally

Animation of Tally Double values will be collected TypeData: Statistic.ATA_Observations TypeIndex: Statistic.INDEX_Mean_StdDev

Version:

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

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ 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.

Field Summary

Fields inherited from class desmoj.core.statistic.StatisticObject

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
TallyAnimation(ModelAnimation owner, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor with the same parameters as in Tally

Method Summary

Modifier and Type	Method and Description
void	createAnimation(Position pos, Form form, boolean showInAnimation) create standard animation
void	createAnimation(TimeInstant highTime, double valMin, double valMax, int histogramCells, Position pos, Form form, boolean showInAnimation) create animation with full parameterization
void	reset() Resets this Tally object by resetting all variables to 0.0 .
void	update(double value) Add a value to statistical object.

Methods inherited from class desmoj.core.statistic.Tally

createDefaultReporter, getMean, getStdDev, update, update

Methods inherited from class desmoj.core.statistic.ValueStatistics

getLastValue, getMaximum, getMinimum, update

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

TallyAnimation

public TallyAnimation(ModelAnimation owner,
                      java.lang.String name,
                      boolean showInReport,
                      boolean showInTrace)

Constructor with the same parameters as in Tally

Parameters:

owner - used model

name - name of Tally

showInReport - as in Tally

showInTrace - as in Tally

Method Detail

createAnimation

public void createAnimation(Position pos,
                            Form form,
                            boolean showInAnimation)

create standard animation

Parameters:

pos - middle point of animation object

form - form of animation object

showInAnimation - switch animation on or off

createAnimation

public void createAnimation(TimeInstant highTime,
                            double valMin,
                            double valMax,
                            int histogramCells,
                            Position pos,
                            Form form,
                            boolean showInAnimation)

create animation with full parameterization

Parameters:

highTime - initial time line from now until highTime

valMin - initial value line from valMin to valMax

valMax - initial value line from valMin to valMax

histogramCells - no of histogram cells between valMin and valMax 0 means, there is no histogram support.

pos - middle point of animation object

form - form of animation object

showInAnimation - switch animation on or off

update

public void update(double value)

Add a value to statistical object. The simTime is picked up automatically.

Overrides:

update in class Tally

Parameters:

value - add a value

reset

public void reset()

Description copied from class: Tally

Resets this Tally object by resetting all variables to 0.0 .

Overrides:

reset in class Tally