desmoj.core.simulator

Class EventOf2Entities<E extends Entity,F extends Entity>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.EventAbstract

desmoj.core.simulator.EventOf2Entities<E,F>

public abstract class EventOf2Entities<E extends Entity,F extends Entity>
extends EventAbstract

Provides the class for user defined events to change two entities' internal states. The state of a discrete model is changed by events that occur at distinct points of simulation time.

For events changing the state of one or three entities, refer to Event and EventOf3Entities. Events not associated to a specific entity are based on ExternalEvent.

For type safety it is recommended to generically assign the entity types an EventOf2Entities operates on by using the generic type EventOf2Entities<E,F> where E and F are derived from Entity.

All event object should be used only once. Implement the changes of state for the specific entities associated with this event by overriding the abstract method eventRoutine(E who1, F who2).

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Tim Lechler, modified by Justin Neumann 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:

Entity, ExternalEvent, Event, EventOf3Entities, TimeInstant, TimeSpan

Constructor Summary

Constructors

Constructor and Description
EventOf2Entities(Model owner, java.lang.String name, boolean showInTrace) Creates a new Event of the given model, with the given name and trace option.

Method Summary

Modifier and Type	Method and Description
abstract void	eventRoutine(E who1, F who2) Implement this abstract method to express the changes of state this event does to two entities (as SimProcess is a subclass of Entity, processes can be passed as well).
void	schedule(E who1, F who2) Schedules this event to act the given entities now.
void	schedule(E who1, F who2, NumericalDist<?> dist) Schedules this event to act the given entities at the specified point in simulation time determined by a sample from the distribution provided to the method.
void	schedule(E who1, F who2, TimeInstant instant) Schedules this event to act on the given entities at a certain point in simulation time.
void	schedule(E who1, F who2, TimeSpan dt) Schedules this event to act the given entities at the specified point in simulation time.
void	scheduleAfter(Schedulable after, E who1, F who2) Schedules this event to act on the given Entity directly after the given Schedulable is already set to be activated.
void	scheduleBefore(Schedulable before, E who1, F who2) Schedules this event to act on the given Entity directly before the given Schedulable is already set to be activated.
void	schedulePreempt(E who1, F who2) 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

EventOf2Entities

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

Creates a new Event of the given model, with the given name and trace option.

Parameters:

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

owner - Model : The model this event is associated to

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

Method Detail

eventRoutine

public abstract void eventRoutine(E who1,
                                  F who2)

Implement this abstract method to express the changes of state this event does to two entities (as SimProcess is a subclass of Entity, processes can be passed as well).

For type safety, it is recommended to derive your events from the generic type EventOf2Entities<EntityType1,EntityType2> where EntityType1 and EntityType2 (which are derived from class Entity) represent the entity types your event is supposed to operate on.

Should you decide to derive your event from the raw type EventOf2Entities (which is not recommended), please take extra care in checking the given Entity parameters to your special eventRoutine since any subtype of Entity will be accepted! If your model uses several different entity types, chances are that while developing the model, wrong entity types might be passed.

Parameters:

who1 - E : The first entity associated to this event.

who2 - F : The second entity associated to this event.

schedule

public void schedule(E who1,
                     F who2,
                     TimeInstant instant)

Schedules this event to act on the given entities at a certain point in simulation time. No preemption, i.e. a process calling this method will continue until passivated or hold.

Parameters:

who1 - E : The first entity to be manipulated by this event

who2 - F : The second entity to be manipulated by this event

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

schedule

public void schedule(E who1,
                     F who2,
                     TimeSpan dt)

Schedules this event to act the given entities at the specified point in simulation time. The point of time is given as an offset to the current simulation time as displayed by the simulation clock. No preemption, i.e. a process calling this method will continue until passivated or hold.

Parameters:

who1 - E : The first entity this event happens to

who2 - F : The second entity this event happens to

dt - TimeSpan : The offset to the current simulation time this Event is to happen

See Also:

SimClock

schedule

public void schedule(E who1,
                     F who2)

Schedules this event to act the given entities now. No preemption, i.e. a process calling this method will continue until passivated or hold.

Parameters:

who1 - E : The first entity this event happens to

who2 - F : The second entity this event happens to

See Also:

SimClock

schedulePreempt

public void schedulePreempt(E who1,
                            F who2)
                     throws SuspendExecution

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

Parameters:

who1 - E : The first entity this event happens to

who2 - F : The second entity this event happens to

Throws:

SuspendExecution

schedule

public void schedule(E who1,
                     F who2,
                     NumericalDist<?> dist)

Schedules this event to act the given entities at the specified point in simulation time 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:

who1 - E : The first entity this event happens to

who2 - F : The second entity this event happens to

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

See Also:

SimClock

scheduleAfter

public void scheduleAfter(Schedulable after,
                          E who1,
                          F who2)

Schedules this event to act on the given Entity directly after the given Schedulable is already set to be activated. Note that this event's point of simulation time will be set to be the same as the Schedulable's time. Thus this 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 entity should be scheduled after

who1 - E : The first entity to be manipulated by this event

who2 - F : The second entity to be manipulated by this event

scheduleBefore

public void scheduleBefore(Schedulable before,
                           E who1,
                           F who2)

Schedules this event to act on the given Entity directly before the given Schedulable is already set to be activated. Note that this event's point of simulation time will be set to be the same as the Schedulable's time. Thus this 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 entity should be scheduled before

who1 - E : The first entity to be manipulated by this event

who2 - F : The second entity to be manipulated by this event