desmoj.core.simulator

Class ExternalEventStop

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.EventAbstract

desmoj.core.simulator.ExternalEvent

desmoj.core.simulator.ExternalEventStop

public class ExternalEventStop
extends ExternalEvent

The external event to stop a running experiment.

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
ExternalEventStop(Model owner, java.lang.String name, boolean showInTrace) Constructs an external event to abort the experiment.

Method Summary

Modifier and Type	Method and Description
void	eventRoutine() The eventRoutine to abort an experiment.
void	eventRoutine(Entity who) Do not use this method to implement the external event's eventRoutine!
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.

Methods inherited from class desmoj.core.simulator.ExternalEvent

schedule, schedule, schedulePreempt

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

ExternalEventStop

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

Constructs an external event to abort the experiment.

Parameters:

owner - desmoj.Model : The model this external event is associated to

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

showInTrace - boolean : Flag indicating if the external event is shown in the report

Method Detail

eventRoutine

public void eventRoutine()

The eventRoutine to abort an experiment.

Specified by:

eventRoutine in class ExternalEvent

eventRoutine

public void eventRoutine(Entity who)

Do not use this method to implement the external event's eventRoutine! This method can not be hidden due to the inheritance relationship to the class Event. Since external events are designed to act on the model or experiment in general and are not associated to an individual Entity, you should use the parameterless method void eventRoutine() instead. Calling this method will result in a warning message and the parameterless method will be called. The given Entity will not be changed. Do not override this method in your special external events!

See Also:

ExternalEvent.eventRoutine()

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

Overrides:

schedule in class ExternalEvent

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(TimeInstant when)

Schedules this external event to make the desired changes to the experiment or model at the specified point in simulation time.

Overrides:

schedule in class ExternalEvent

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.

Overrides:

scheduleAfter in class ExternalEvent

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.

Overrides:

scheduleBefore in class ExternalEvent

Parameters:

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