desmoj.core.simulator

Class Schedulable

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

Direct Known Subclasses:

Entity, EventAbstract

public class Schedulable
extends ModelComponent

All objects that want to be handled by the scheduler must extend this class. These are events (including external events), entities and SimProcesses. All functionality common to Schedulable objects are encapsulated here.

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
Schedulable(Model owner, java.lang.String name, boolean showInTrace) Constructs a Schedulable object with the given name.

Method Summary

Modifier and Type	Method and Description
void	assignReporter(java.lang.Class<? extends Reporter> reporterClass, boolean showInReport, boolean showInTrace) Allows to allocate a Reporter to this Schedulable.
void	cancel() Removes all events scheduled for this entity from the event-list.
Reportable	getCorrespondingReportable() Gets the Reportable corresponding to this Schedulable; may be null if no Reportable corresponds to this Schedulable.
boolean	isCurrent() Shows if this Schedulable is the currently active object.
boolean	isScheduled() Tests if this entity has already been scheduled.
void	rename(java.lang.String newName) Allows to rename a Schedulable object while keeping its internally added serial number to keep track of the individual object.
void	reSchedule(TimeInstant time) Re-schedules the Schedulable to some other point in simulation time (which should be different form the instant at which is a scheduled at the moment).
void	reSchedule(TimeSpan dt) Re-schedules the Schedulable by shifting all EventNote by a specified TimeSpan.
void	reSchedulePreempt() Re-schedules the Schedulable to happen immediately, preempting the current process.
TimeInstant	scheduledNext() Returns the next point of time this entity is scheduled.
void	setCorrespondingReportable(Reportable correspondingReportable) Sets the Reportable (e.g. entity) corresponding to this Schedulable.

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

Schedulable

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

Constructs a Schedulable object with the given name. Note that to identify the multiple objects that can be created of one type of Schedulable, each has a unique number added to its name as a suffix. The numbers represent the amount of objects being created with the same name.

Parameters:

name - java.lang.String : The name of the new Schedulable object

owner - Model : The owner of this Schedulable object

Method Detail

cancel

public void cancel()

Removes all events scheduled for this entity from the event-list. The Entity will not become active until scheduled again.

isCurrent

public boolean isCurrent()

Shows if this Schedulable is the currently active object.

Returns:

boolean :true if this Schedulable is the currently active, false otherwise

isScheduled

public boolean isScheduled()

Tests if this entity has already been scheduled.

Returns:

boolean :true if already scheduled, false otherwise

rename

public void rename(java.lang.String newName)

Allows to rename a Schedulable object while keeping its internally added serial number to keep track of the individual object. Note that invalid string parameters will result in renaming the Schedulable to 'unnamed'.

Parameters:

newName - java.lang.String : The Schedulable's new name

reSchedule

public void reSchedule(TimeSpan dt)

Re-schedules the Schedulable by shifting all EventNote by a specified TimeSpan.

Parameters:

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

reSchedule

public void reSchedule(TimeInstant time)
                throws SuspendExecution

Re-schedules the Schedulable to some other point in simulation time (which should be different form the instant at which is a scheduled at the moment). Requires the Schedulable to be scheduled exactly once.

Parameters:

time - TimeInstant : The simulation time at which this entity is to be re-scheduled

Throws:

SuspendExecution

reSchedulePreempt

public void reSchedulePreempt()
                       throws SuspendExecution

Re-schedules the Schedulable to happen immediately, preempting the current process.

Throws:

SuspendExecution

scheduledNext

public TimeInstant scheduledNext()

Returns the next point of time this entity is scheduled.

Returns:

TimeInstant : The point of simulation time the next Entity is schedule or null otherwise

assignReporter

public void assignReporter(java.lang.Class<? extends Reporter> reporterClass,
                           boolean showInReport,
                           boolean showInTrace)

Allows to allocate a Reporter to this Schedulable. Bypassing the usual approach of each ModelComponent either being a Schedulable or a Reportable, this allocation permits generating report output about a ModelComponent that is also used for scheduling. Internally, a dummy Reportable is generated, strictly speaking (hidden from the user) is the true Reportable to report about.

Parameters:

r - Reporter : The offset to the current simulation time at which this Schedulable is to be re-scheduled. Must have a constructor accepting a Schedulable as only (!) parameter.

showInReport - boolean : Flag for showing the report. Set it to true if reportable should show up in report. Set it to false if reportable should not be shown in report.

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

getCorrespondingReportable

public Reportable getCorrespondingReportable()

Gets the Reportable corresponding to this Schedulable; may be null if no Reportable corresponds to this Schedulable.

Returns:

Reportable : The Reportable corresponding to this Schedulable (may be null if no Reportable corresponds to this Schedulable!)

setCorrespondingReportable

public void setCorrespondingReportable(Reportable correspondingReportable)

Sets the Reportable (e.g. entity) corresponding to this Schedulable. May be null if no Reportable corresponds to this Schedulable. If set, the Reportable must have the same model as this Schedulable! A Schedulable needs not have a corresponding Reportable.

Parameters:

correspondingReportable - Reportable : The Reportable corresponding to this Schedulable.