desmoj.core.dist

Class BoolDistConstant

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.dist.Distribution

desmoj.core.dist.BoolDist

desmoj.core.dist.BoolDistConstant

public class BoolDistConstant
extends BoolDist

Boolean constant "pseudo"-distribution returns a single constant predefined boolean value. This "distribution" is most useful for testing purposes. The value to be returned can be specified at construction time.

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.

See Also:

Distribution

Constructor Summary

Constructors

Constructor and Description
BoolDistConstant(Model owner, java.lang.String name, boolean constantValue, boolean showInReport, boolean showInTrace) Creates a constant boolean "pseudo" distribution with the constant value given as parameter.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates the default reporter for the BoolDistConstant distribution.
boolean	getConstantValue() Returns the constant boolean value associated with this BoolDistConstant distribution
boolean	sample() Returns the next constant boolean sample of this distribution.
void	setConstant(boolean newValue) Changes the constant value to the new one specified.

Methods inherited from class desmoj.core.dist.BoolDist

sampleObject

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

BoolDistConstant

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

Creates a constant boolean "pseudo" distribution with the constant value given as parameter.

Parameters:

owner - Model : The distribution's owner

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

constantValue - long : The constant boolean value produced by this distribution

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 BoolDistConstant distribution.

Overrides:

createDefaultReporter in class Distribution

Returns:

Reporter : The reporter for the BoolDistConstant distribution

See Also:

DistributionReporter

getConstantValue

public boolean getConstantValue()

Returns the constant boolean value associated with this BoolDistConstant distribution

Returns:

boolean : The constant boolean value returned by this BoolDistConstant distribution

sample

public boolean sample()

Returns the next constant boolean sample of this distribution. For this "pseudo"-distribution it is always is the default value specified through the constructor or via the setConstant method.

Specified by:

sample in class BoolDist

Returns:

boolean : The constant sample

setConstant

public void setConstant(boolean newValue)

Changes the constant value to the new one specified.

Parameters:

newValue - boolean : the new constant value to be returned by this pseudo distribution