desmoj.core.dist

Class EntityDist<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.EntityDist<E>

Type Parameters:

E - the element type

Direct Known Subclasses:

EntityDistEmpirical, EntityDistUniform

public abstract class EntityDist<E extends Entity>
extends Distribution

Superclass for all distributions returning samples in terms of different entities. Use this class instead of a specific distribution if the special distribution function is supposed to be specified in subclasses or changed dynamically. Extend this abstract class to define all your special entity-based distributions.

Version:

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

Author:

Tim Lechler, Johannes Göbel 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
EntityDist(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Constructs a distribution returning entity samples.

Method Summary

Modifier and Type	Method and Description
abstract E	sample() Abstract method should return the specific sample (type Entity) when implemented in subclasses.
java.lang.Object	sampleObject() Convenience method to return the distribution's sample as Object.

Methods inherited from class desmoj.core.dist.Distribution

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

EntityDist

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

Constructs a distribution returning entity samples. Note that the method returning the entity samples has to be implemented in subclasses.

Parameters:

owner - Model : The distribution's owner

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

showInReport - the show in report

showInTrace - boolean : Flag to show distribution in trace

Method Detail

sample

public abstract E sample()

Abstract method should return the specific sample (type Entity) when implemented in subclasses.

Returns:

E : The entity sample to be drawn from this distribution

sampleObject

public java.lang.Object sampleObject()

Convenience method to return the distribution's sample as Object. For type safety, method sample() should be preferred. However, this method is useful for environments requiring a non-genetic access point to obtain samples from any distribution.

Specified by:

sampleObject in class Distribution

Returns:

Object : A sample from this this distribution wrapped as Object.