desmoj.extensions.scheduling

Class EntitySchedule<E extends SimProcess>

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Schedulable

desmoj.core.simulator.Entity

desmoj.core.simulator.SimProcess

desmoj.extensions.scheduling.EntitySchedule<E>

public class EntitySchedule<E extends SimProcess>
extends SimProcess

EntitySchedule is a list of EntityScheduleEntry's. A EntityScheduleEntry is a time region (e.g. every workingday from 8:00 until 16:00) All EntityScheduleEntry's have the same timezone, stored in EntitySchedule. EntitySchedule is a SimProcess. With setProcess is a process specified. The lifecycle of EntitySchedule will activate the with setProcess specified process at begin and end of each schedule entry.

Version:

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

Author:

christian.mueller@th-wildau.de 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.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean[]	allDays
static boolean[]	weekend
static boolean[]	workingDays

Constructor Summary

Constructors

Constructor and Description
EntitySchedule(Model owner) Erzeugt leeren EntitySchedule mit default Zeitzone
EntitySchedule(Model owner, java.lang.String name, E process) Erzeugt leeren EntitySchedule mit default Zeitzone Zu begin jedes ScheduleEntry wird process aktiviert
EntitySchedule(Model owner, TimeSpan fromBeginOfDay, TimeSpan untilBeginOfDay) Default Schedule ohne Zeitbeschraenkung, werktags mit default Zeitzone

Method Summary

Modifier and Type	Method and Description
void	add(EntityScheduleEntry entry) fuegt dem Schedule ein EntityScheduleEntry hinzu
void	addProcess(E process)
boolean	checkAvailability(Entity e) Wie oben, jedoch mit index = 0 als Default Wert.
boolean	checkAvailability(Entity e, int index) Das values-array der schedule entries beschreiben Eigenschaften eines entries.
void	clearProcessList()
TimeInstant	getBeginOfNextEntry(TimeInstant now) compute begin of next valid scheduleEntry.
TimeInstant	getEndOfActualEntry(TimeInstant now)
java.lang.Object[]	isInSchedule() prueft ob currentTime in dem Schedule enthalten ist.
java.lang.Object[]	isInSchedule(TimeInstant time) prueft ob date in dem Schedule enthalten ist.
void	lifeCycle() Override this method in a subclass of SimProcess to implement the specific behaviour of this SimProcess.
void	removeProcess(E process)
void	setProcessManagement(boolean activate, boolean passiviate)
void	setTimeZone(java.util.TimeZone timezone)
java.lang.String	toString() Overrides the java.lang.Object's toString method to return the named object's name when given as parameter to a method that expects a string to be passed.

Methods inherited from class desmoj.core.simulator.SimProcess

activate, activate, activate, activateAfter, activateBefore, activatePreempt, cancelInterruptDelayed, canCooperate, clearInterruptCode, cooperate, getActivatedBy, getInterruptCode, getInterruptException, getMaster, getRealTimeConstraint, getSchedulingPriority, getSlaveWaitQueue, getSupervisor, hold, hold, hold, interrupt, interrupt, interruptDelayed, interruptDelayed, isBlocked, isComponent, isDelayedInterruptScheduled, isInterrupted, isRepeating, isTerminated, obtainResources, passivate, prepareTransport, reActivate, reActivate, resetMaster, returnAllResources, returnResources, setBlocked, setRealTimeConstraint, setRepeating, setSchedulingPriority, setSlaveWaitQueue

Methods inherited from class desmoj.core.simulator.Entity

getIdentNumber, getQueueingPriority, getQueues, getScheduledEvents, isEqual, isLarger, isLargerOrEqual, isNotEqual, isQueued, isSimProcess, isSmaller, isSmallerOrEqual, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, schedule, scheduleAfter, scheduleAfter, scheduleAfter, scheduleBefore, scheduleBefore, scheduleBefore, schedulePreempt, schedulePreempt, schedulePreempt, setQueueingPriority

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

workingDays

public static boolean[] workingDays

weekend

public static boolean[] weekend

allDays

public static boolean[] allDays

Constructor Detail

EntitySchedule

public EntitySchedule(Model owner,
                      java.lang.String name,
                      E process)

Erzeugt leeren EntitySchedule mit default Zeitzone Zu begin jedes ScheduleEntry wird process aktiviert

Parameters:

owner -

process -

EntitySchedule

public EntitySchedule(Model owner)

Erzeugt leeren EntitySchedule mit default Zeitzone

Parameters:

owner -

EntitySchedule

public EntitySchedule(Model owner,
                      TimeSpan fromBeginOfDay,
                      TimeSpan untilBeginOfDay)

Default Schedule ohne Zeitbeschraenkung, werktags mit default Zeitzone

Parameters:

fromHourOfDay -

untilHourOfDay -

Method Detail

setProcessManagement

public void setProcessManagement(boolean activate,
                                 boolean passiviate)

setTimeZone

public void setTimeZone(java.util.TimeZone timezone)

clearProcessList

public void clearProcessList()

addProcess

public void addProcess(E process)

removeProcess

public void removeProcess(E process)

add

public void add(EntityScheduleEntry entry)

fuegt dem Schedule ein EntityScheduleEntry hinzu

Parameters:

entry -

isInSchedule

public java.lang.Object[] isInSchedule(TimeInstant time)

prueft ob date in dem Schedule enthalten ist.

Parameters:

date -

Returns:

Values des ersten Entry, der date enthaelt. null wenn kein Entry gefunden

isInSchedule

public java.lang.Object[] isInSchedule()

prueft ob currentTime in dem Schedule enthalten ist. Die Endzeit gehoert nicht zum ScheduleEntry

Returns:

Capacity des ersten Entry, der date enthaelt. null wenn kein Entry gefunden

getEndOfActualEntry

public TimeInstant getEndOfActualEntry(TimeInstant now)

getBeginOfNextEntry

public TimeInstant getBeginOfNextEntry(TimeInstant now)

compute begin of next valid scheduleEntry.

Parameters:

now - actual simulation time

Returns:

null when no next entry exist.

toString

public java.lang.String toString()

Description copied from class: NamedObject

Overrides the java.lang.Object's toString method to return the named object's name when given as parameter to a method that expects a string to be passed.

Overrides:

toString in class NamedObject

Returns:

java.lang.String : The named object's name

checkAvailability

public boolean checkAvailability(Entity e,
                                 int index)

Das values-array der schedule entries beschreiben Eigenschaften eines entries. Angenommen in jedem schedule entity steht eine unterschiedliche Anzahl der Resource e zur Verfuegung und diese Anzahl ist in der Komponente indes des values-array abgespeichert. Die Namen der Resourcen Entities enthalten am Ende eine laufende Nr. Diese Methode prueft, ob diese Nr <= der in dem aktuellen Schedule zulaessigen Anzahl ist.

Parameters:

e -

index -

Returns:

checkAvailability

public boolean checkAvailability(Entity e)

Wie oben, jedoch mit index = 0 als Default Wert.

Parameters:

e -

Returns:

lifeCycle

public void lifeCycle()
               throws SuspendExecution

Description copied from class: SimProcess

Override this method in a subclass of SimProcess to implement the specific behaviour of this SimProcess. This method starts after a SimProcess has been created and activated. Note that this method will be executed once or repeatedly, depending on the repeating status of the SimProcess.

Specified by:

lifeCycle in class SimProcess

Throws:

SuspendExecution