desmoj.extensions.visualization2d.animation.core.simulator

Class ModelAnimation

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.simulator.Model

desmoj.extensions.visualization2d.animation.core.simulator.ModelAnimation

public abstract class ModelAnimation
extends Model

Animated version of model. ModelAnimation extends Model about a CmdGeneration instance and a showInAnimation switch. A animated model must extend form ModelAnimation.

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.

Constructor Summary

Constructors

Constructor and Description
ModelAnimation(ModelAnimation owner, java.lang.String name, CmdGeneration cmdGen, boolean showInReport, boolean showInTrace, boolean showInAnimation) ModelAnimation extends Model about a CmdGeneration instance and a showInAnimation switch.

Method Summary

Modifier and Type	Method and Description
boolean	animationIsOn() gives showInAnimation switch
CmdGeneration	getCmdGen() gives CmdGeneration Object
void	init() overwrites init from Model with: initCmds(), initEntityTypes(), and initAnimation()
abstract void	initAnimation() place to init black-box components and there createAnimation Statements
TimeInstant	presentTime() overwrite presentTime from Model.

Methods inherited from class desmoj.core.simulator.Model

connectToExperiment, createDefaultReporter, description, doInitialSchedules, getEntities, getEntity, getExperiment, getParameterManager, getReportables, hasSubModels, init, isConnected, isMainModel, isSubModel, register, reset

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, 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

ModelAnimation

public ModelAnimation(ModelAnimation owner,
                      java.lang.String name,
                      CmdGeneration cmdGen,
                      boolean showInReport,
                      boolean showInTrace,
                      boolean showInAnimation)

ModelAnimation extends Model about a CmdGeneration instance and a showInAnimation switch. In constructor you must define: setModelAuthor(..), setModelDate(), addRemark(), addIcon() and setGeneratedBy()

Parameters:

owner - supermodel, may be null

name - name of model

cmdGen - CmdGeneration object

showInReport - switch for report generation

showInTrace - switch for trace generation

showInAnimation - switch for cmds-file generation

Method Detail

initAnimation

public abstract void initAnimation()

place to init black-box components and there createAnimation Statements

presentTime

public TimeInstant presentTime()

overwrite presentTime from Model. Originally, before experiment start presentTime is 0. Now, in initPhase presentTime is initTime (from cmdGeneration object)

Overrides:

presentTime in class ModelComponent

Returns:

TimeInstant : The current point of simulation time

init

public void init()

overwrites init from Model with: initCmds(), initEntityTypes(), and initAnimation()

Specified by:

init in class Model

getCmdGen

public CmdGeneration getCmdGen()

gives CmdGeneration Object

Returns:

animationIsOn

public boolean animationIsOn()

gives showInAnimation switch

Returns: