desmoj.core.simulator

Class Model

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.simulator.Model

Direct Known Subclasses:

ModelAnimation

public abstract class Model
extends Reportable

The model is supposed to carry references to all static modelcomponents associated to a model. These are modelcomponents like distributions and statistic counters. Note that placing all essential components inside the model class allows you to use object orientation to reuse this model to implement different versions of it using subclassing for changes necessary for using other modelling paradigms. This way models can be easily reimplemented following the process-, event-, transaction- or activity- oriented paradigm. Note that transaction- and activity-oriented modelling requires the higher process synchronization mechanisms (Res, Bin, WaitQueue, CondQueue) by Soenke Claassen.

The modelcomponents belonging to a model have to be instantiated in the init() method. They must not be instantiated in the model's constructor since most components need access to a valid experiment object. This can only be accessed after a model has been connected to an experiment using method connectToExperiment(Experiment exp) which implicitly calls the init() method after receiving the valid reference to an experiment.

Version:

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

Author:

Tim Lechler 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
Model(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Constructs a model, with the given name and parameters for report and trace files.

Method Summary

Modifier and Type	Method and Description
void	connectToExperiment(Experiment exp) Connects this model to an experiment.
ModelReporter	createDefaultReporter() Creates the default reporter associated with this model.
abstract java.lang.String	description() Should return the description of the model.
abstract void	doInitialSchedules() Implement this method to schedule the entities and/or events needed for your model to start in a defined setting.
java.util.List<Entity>	getEntities(boolean includeSubmodels) Returns a list of this model's entities.
Entity	getEntity(long ident) Returns the entity to the belonging identifier.
Experiment	getExperiment() Returns the experiment that is connected to this model or null if the model is not yet connected to an experiment.
ModelParameterManager	getParameterManager() Returns the Model's viewpoint of the ParameterManager
java.util.List<Reportable>	getReportables() Returns a copy of the dynamic list containing all reportable components of this model.
boolean	hasSubModels() Shows, if there are submodels registered with this model.
abstract void	init() Implement this method to do initialization work for your model.
void	init(ModelOptions options) Initializes the model by calling method init() to set up all model related components as specified in that method.
boolean	isConnected() Shows if this model has already been connected to an experiment.
boolean	isMainModel() Shows if this model is a main model and thus is not submodel of other models.
boolean	isSubModel() Shows if this model is submodel to another model and thus is not the main models.
void	register(Reportable r) Registers a reportable at this model.
void	reset() Resets the statistic counters of this model and of all its registered reportables.

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

Model

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

Constructs a model, with the given name and parameters for report and trace files.

Parameters:

name - java.lang.String : The name of this model

owner - Model : The main model this model is associated to

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

Method Detail

connectToExperiment

public void connectToExperiment(Experiment exp)

Connects this model to an experiment. The given experiment must not already be connected to some other model. Otherwise an errormessage will be given and the experiment will be stopped. Since a model that is not yet connected has no access to the experiment's messaging subsystem,

createDefaultReporter

public ModelReporter createDefaultReporter()

Creates the default reporter associated with this model. The default reporter returned by this method just prints the model's description as implemented in method description() and appends the simulation time of the last reset. If the user's model offers more information, create a special class derived from class desmoj.report.ModelReporter to extract and present that extra information.

Returns:

Reportable : The reporter associated with this model

description

public abstract java.lang.String description()

Should return the description of the model. Implement this method to document the model's intent, creator, date and all other information that needs to be published about this model in a report. Please use it generously, other people interested in your model will thank you.

Returns:

java.lang.String : The description of the model as a text String

doInitialSchedules

public abstract void doInitialSchedules()

Implement this method to schedule the entities and/or events needed for your model to start in a defined setting. If a model is connected to an experiment and started without any initial schedules, it will not run since no events to process are on the scheduler's event-list. This method is called automatically by the framework when the experiment's start() method is called.

getEntity

public Entity getEntity(long ident)

Returns the entity to the belonging identifier.

Returns:

Entity : The class will return the Entity or null if no such exists.

getEntities

public java.util.List<Entity> getEntities(boolean includeSubmodels)

Returns a list of this model's entities. The order of the list is unspecified.

Parameters:

includeSubmodels - boolean : Do include (true) or exclude (false) submodels' entities in the list.

Returns:

List : The class will return a list of all existing objects of Entity.

getExperiment

public Experiment getExperiment()

Returns the experiment that is connected to this model or null if the model is not yet connected to an experiment.

Returns:

Experiment : The experiment that this model is connected to or null if no connection is established

getReportables

public java.util.List<Reportable> getReportables()

Returns a copy of the dynamic list containing all reportable components of this model.

Returns:

reportables : A list containing all reportable components of this model.

getParameterManager

public ModelParameterManager getParameterManager()

Returns the Model's viewpoint of the ParameterManager

Returns:

ModelParameterManager : The ParameterManager

hasSubModels

public boolean hasSubModels()

Shows, if there are submodels registered with this model.

Returns:

boolean : True, if there is at least one submodel registered at this Model, flase if there are no submodels

init

public abstract void init()

Implement this method to do initialization work for your model. All ModelComponents associated with this model are supposed to be instantiated in this method.

Caution! Do not use the Model's constructor method to instantiate your modelcomponents!
This prevents the modelcomponents to get contact to the associated Experiment since a Model can only be connected to an Experiment after itself has been instantiated correctly. Thus it is necessary to put all initialization and instantiation work into this method. Do not use this method to do the initial schedules needed for the scheduler to start with. Use method doInitialSchedules() instead. If there are no events scheduled in the event-list, the scheduler will stop the simulation immediately because there is nothing for him to do. If you are using submodels, take care that each of the submodels has its own init method properly set up.

init

public void init(ModelOptions options)

Initializes the model by calling method init() to set up all model related components as specified in that method. After initializing the model, the given ModelOption's setOption() method is called with this model as parameter. This enables the user to specify different model parameter settings for different experiments. It even allows automated parameter variation to give a small but handy aid for model optimization. Implement the ModelOptions to set the parameters for your model. Make sure to react properly on the ModelOptions given. Note that specifiying ModelOptions is up to the user.

Parameters:

options - ModelOptions : The parameter settings for this model

isConnected

public boolean isConnected()

Shows if this model has already been connected to an experiment.

Returns:

boolean : Is true, if model is connected to an experiment, false otherwise

isMainModel

public boolean isMainModel()

Shows if this model is a main model and thus is not submodel of other models.

Returns:

boolean : Returns true if the model is a main model, false if it is a submodel of other models

isSubModel

public boolean isSubModel()

Shows if this model is submodel to another model and thus is not the main models.

Returns:

boolean : Returns true if the model is a submodel of other models, false if it is a main model

register

public void register(Reportable r)

Registers a reportable at this model. Reports can only be drawn, if the reportbale is registered at his model.

Parameters:

r - desmoj.core.simulator.Reportable : The reportable to be registered

reset

public void reset()

Resets the statistic counters of this model and of all its registered reportables. Also calls all submodels's reset() methods.

Overrides:

reset in class Reportable