desmoj.core.dist

Class Series<O>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.Series<O>

Direct Known Subclasses:

SeriesEntities, SeriesNumerical

public abstract class Series<O>
extends Distribution

A series is a special distribution returning preset, user-defined entries from a list. 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
Series(Model owner, java.lang.String name, boolean showInReport, boolean showInTrace) Creates a new Series.

Method Summary

Modifier and Type	Method and Description
void	add(O element) Adds a new sample entry at the end of the entry list.
void	addAll(java.util.Collection<O> collection) Adds all elements of a given Collection to the entry list.
void	clearList() Removes all entries from the sample list.
Reporter	createDefaultReporter() Creates the default reporter for the series.
int	getNumberOfAvailableElements() Returns the amount of samples this series can still return, given the current reading direction and repeating property.
boolean	isforward() Returns whether this series is getting read forward.
void	remove(int position) Removes am entry at a certain position out of the sample list, lowering the index of all following entries by one.
O	sample() Returns the next sample from the entry list.
java.lang.Object	sampleObject() Convenience method to return the series' sample as Object.
void	set(O element, int position) Replaces the entry at a certain position with a given entry.
void	setRepeating(boolean repeat) Sets whether reading samples from the list is continued from start once the last sample has been returned.
void	setReverse(boolean direc) Sets the reading direction for the sample list of this series.

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

Series

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

Creates a new Series. Default behaviour when returning samples is - starting at 1st 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

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Creates the default reporter for the series.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the Series

See Also:

DistributionReporter

setReverse

public void setReverse(boolean direc)

Sets the reading direction for the sample list of this series.

Parameters:

direc - boolean : true - forward; false - backwards

isforward

public boolean isforward()

Returns whether this series is getting read forward.

setRepeating

public void setRepeating(boolean repeat)

Sets whether reading samples from the list is continued from start once the last sample has been returned. If the list is getting read backwards, enabling this will cause the series to start over from the end of the list once the first value has been read.

Parameters:

repeat - boolean : Whether this series repeats its value list once the last value has been returned.

remove

public void remove(int position)

Removes am entry at a certain position out of the sample list, lowering the index of all following entries by one.

Parameters:

position - int : The position to remove the value from.

clearList

public void clearList()

Removes all entries from the sample list.

add

public void add(O element)

Adds a new sample entry at the end of the entry list.

Parameters:

element - E : entry to be added

addAll

public void addAll(java.util.Collection<O> collection)

Adds all elements of a given Collection to the entry list.

Parameters:

collection - Collection : The collection whose entries will be added.

set

public void set(O element,
                int position)

Replaces the entry at a certain position with a given entry.

Parameters:

element - E : The new entry to replace the old one.

position - int : The position at which the entry should be replaced.

getNumberOfAvailableElements

public int getNumberOfAvailableElements()

Returns the amount of samples this series can still return, given the current reading direction and repeating property.

Returns:

int : Amount of samples that can be returned before the series reaches its end.

sample

public O sample()

Returns the next sample from the entry list.

Returns:

E : The sample to be returned.

sampleObject

public java.lang.Object sampleObject()

Convenience method to return the series' 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.