desmoj.core.simulator

Class ExternalEvent

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.EventAbstract

desmoj.core.simulator.ExternalEvent

Direct Known Subclasses:

ExternalEventDebugOff, ExternalEventDebugOn, ExternalEventReset, ExternalEventStop, ExternalEventTimedTrace, ExternalEventTraceOff, ExternalEventTraceOn, MovingDoneEvent, RotatingDoneEvent

public abstract class ExternalEvent
extends EventAbstract

Provides the class for user defined events to change the model's state at a distinct point in simulation time.

For events specifically changing the state of up to three entities, refer to Event, EventOf2Entities and EventOf3Entities. Events not associated to a specific entity are called external events as they are are typically used for external influences, e.g. arrivals from outside or incidents. Derive from this class to design special external events for a model. To use external events, always create a new object of this class.

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:

Event, EventOf2Entities, EventOf3Entities, TimeInstant, TimeSpan

Constructor Summary

Constructors

Constructor and Description
ExternalEvent(Model owner, java.lang.String name, boolean showInTrace) Creates an external event for the given model with the given name and the specified tracemode.

Method Summary

Modifier and Type	Method and Description
abstract void	eventRoutine() Implement this method to express the semantics of this external event.
void	schedule() Schedules this external event to make the desired changes to the experiment or model now.
void	schedule(NumericalDist<?> dist) Schedules this external event to make the desired changes to the experiment or model.
void	schedule(TimeInstant when) Schedules this external event to make the desired changes to the experiment or model at the specified point in simulation time.
void	schedule(TimeSpan dt) Schedules this external event to make the desired changes to the experiment or model at the current point of time plus the given span of time.
void	scheduleAfter(Schedulable after) Schedules this external event to act on the experiment or model state directly after the given Schedulable is already set to be activated.
void	scheduleBefore(Schedulable before) Schedules this external event to act on the experiment or model state directly before the given Schedulable is already set to be activated.
void	schedulePreempt() Schedules this event to be executed immediately, preempting the process lifecycle executed at the moment.

Methods inherited from class desmoj.core.simulator.EventAbstract

getNumberOfEntities, getRealTimeConstraint, getSchedulingPriority, isExternal, setRealTimeConstraint, setSchedulingPriority

Methods inherited from class desmoj.core.simulator.Schedulable

assignReporter, cancel, getCorrespondingReportable, isCurrent, isScheduled, rename, reSchedule, reSchedule, reSchedulePreempt, scheduledNext, setCorrespondingReportable

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

ExternalEvent

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

Creates an external event for the given model with the given name and the specified tracemode.

Parameters:

owner - Model : The external event's model

name - java.lang.String : The external event's name

showInTrace - boolean : Flag for showing this external event in tracemessages

Method Detail

eventRoutine

public abstract void eventRoutine()
                           throws SuspendExecution

Implement this method to express the semantics of this external event. External events are supposed to act on the model or experiment in general. They are not related to a special Entity (unlike method eventRoutine(Entity who) of class Event). Override this method to implement this Externalevent's behaviour.

Throws:

SuspendExecution

schedule

public void schedule(TimeSpan dt)

Schedules this external event to make the desired changes to the experiment or model at the current point of time plus the given span of time. No preemption, i.e. a process calling this method will continue until passivated or hold.

Parameters:

dt - TimeSpan : The offset to the current simulation time at which this external event is to be scheduled

See Also:

SimClock

schedule

public void schedule()

Schedules this external event to make the desired changes to the experiment or model now. No preemption, i.e. a process calling this method will continue until passivated or hold.

See Also:

SimClock

schedulePreempt

public void schedulePreempt()
                     throws SuspendExecution

Schedules this event to be executed immediately, preempting the process lifecycle executed at the moment.

Throws:

SuspendExecution

schedule

public void schedule(NumericalDist<?> dist)

Schedules this external event to make the desired changes to the experiment or model. The time instant for which the event is scheduled is determined by a sample from the distribution provided to the method. The sample is interpreted as offset from the the present time in the reference time unit.

Parameters:

dist - NumericalDist : Numerical distribution to sample the offset to the current simulation time from

See Also:

SimClock

schedule

public void schedule(TimeInstant when)

Schedules this external event to make the desired changes to the experiment or model at the specified point in simulation time. No preemption, i.e. a process calling this method will continue until passivated or hold.

Parameters:

when - TimeInstant : The point in simulation time this external event is scheduled to happen.

See Also:

SimClock

scheduleAfter

public void scheduleAfter(Schedulable after)

Schedules this external event to act on the experiment or model state directly after the given Schedulable is already set to be activated. Note that this external event's point of simulation time will be set to be the same as the Schedulable's time. Thus this external event will occur directly after the given Schedulable but the simulation clock will not change. Make sure that the Schedulable given as parameter is actually scheduled.

Parameters:

after - Schedulable : The Schedulable this external event should be scheduled after

scheduleBefore

public void scheduleBefore(Schedulable before)

Schedules this external event to act on the experiment or model state directly before the given Schedulable is already set to be activated. Note that this external event's point of simulation time will be set to be the same as the Schedulable's time. Thus this external event will occur directly before the given Schedulable but the simulation clock will not change. Make sure that the Schedulable given as parameter is actually scheduled.

Parameters:

before - Schedulable : The Schedulable this external event should be scheduled before