desmoj.core.simulator

Class ModelCondition

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.ModelCondition

public abstract class ModelCondition
extends ModelComponent

Derive from this class to create a conditional which the model as whole may fulfill or not, e.g. for the purpose of conditionally stopping an experiment. Override method check(E e) such that it returns true whenever the model complies to the condition.

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
ModelCondition(Model owner, java.lang.String name, boolean showInTrace, java.lang.Object... args) Constructs a ModelCondition with the given name and parameters for trace files.

Method Summary

Modifier and Type	Method and Description
abstract boolean	check() Returns a boolean showing whether the model complies to the condition tested by this method or not.
java.lang.Object[]	getConstructArguments()
boolean	hasPrimitiveArguments()

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

ModelCondition

public ModelCondition(Model owner,
                      java.lang.String name,
                      boolean showInTrace,
                      java.lang.Object... args)

Constructs a ModelCondition with the given name and parameters for trace files.

Parameters:

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

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

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

args - Object... : Arguments to pass to the condition (can be omitted)

Method Detail

hasPrimitiveArguments

public boolean hasPrimitiveArguments()

getConstructArguments

public java.lang.Object[] getConstructArguments()

check

public abstract boolean check()

Returns a boolean showing whether the model complies to the condition tested by this method or not. Inherit from this class and implement this abstract method to return true if the model conforms to your special condition.

Returns:

boolean : Is true, if the model conforms to the condition, false otherwise.