desmoj.core.dist

Class SeriesEntities<E extends Entity>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.Series<E>

desmoj.core.dist.SeriesEntities<E>

public class SeriesEntities<E extends Entity>
extends Series<E>

A series is a special distribution returning preset, user-defined entries from a list. This subclass of Series serves to sample entities. Series may be used to simulate certain non-random scenarios within the simulation or to include external sources of (preudo) random distributions

The internal list can be set to be traversed backwards and/or to repeat once its end has been reached.

Version:

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

Author:

Broder Fredrich 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
SeriesEntities(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Creates a new SeriesEntities.

Method Summary

Methods inherited from class desmoj.core.dist.Series

add, addAll, clearList, createDefaultReporter, getNumberOfAvailableElements, isforward, remove, sample, sampleObject, set, setRepeating, setReverse

Methods inherited from class desmoj.core.dist.Distribution

changeRandomGenerator, getInitialSeed, getNonNegative, getNumSamples, isAntithetic, reset, reset, setAntithetic, setNonNegative, setSeed

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

SeriesEntities

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

Creates a new SeriesEntities. Default behaviour when returning samples is - starting at first element - reading forward - non-repeating

Parameters:

owner - Model : The distribution's owner

name - java.lang.String : The distribution's name

showInReport - boolean : Flag for producing reports

showInTrace - boolean : Flag for producing trace output