org.javades.jqueues.r5.extensions.gate

Class SimQueueWithGateWorkloadScheduleHandler

java.lang.Object

org.javades.jqueues.r5.extensions.gate.SimQueueWithGateWorkloadScheduleHandler

All Implemented Interfaces:

WorkloadScheduleHandler

public final class SimQueueWithGateWorkloadScheduleHandler
extends Object
implements WorkloadScheduleHandler

A WorkloadScheduleHandler for a SimQueueWithGate.

Scans for and takes responsibility for (all) SimQueueGateEvent type(s) at registration, and registers the SimQueueWithGateSimpleEventType simple event type(s).

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

Constructor Summary

Constructors

Constructor and Description
SimQueueWithGateWorkloadScheduleHandler()

Method Summary

Modifier and Type	Method and Description
Map<Class<? extends SimJQEvent>,SimEntitySimpleEventType.Member>	getEventMap() Gets the set of SimJQEvents of this handler, and the SimEntitySimpleEventType members onto which they map.
NavigableMap<Double,List<Integer>>	getGatePassageCreditsMap(SimQueue queue) Returns the gate-passage-credits settings in time for a specific queue.
String	getHandlerName() Returns "SimQueueWithGateHandler".
boolean	needsScan() Returns true.
Set<SimJQEvent>	scan(DefaultWorkloadSchedule workloadSchedule) Scans the host DefaultWorkloadSchedule and builds internal data structures.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimQueueWithGateWorkloadScheduleHandler

public SimQueueWithGateWorkloadScheduleHandler()

Method Detail

getHandlerName

public final String getHandlerName()

Returns "SimQueueWithGateHandler".

Specified by:

getHandlerName in interface WorkloadScheduleHandler

Returns:

"SimQueueWithGateHandler".

getEventMap

public final Map<Class<? extends SimJQEvent>,SimEntitySimpleEventType.Member> getEventMap()

Description copied from interface: WorkloadScheduleHandler

Gets the set of SimJQEvents of this handler, and the SimEntitySimpleEventType members onto which they map.

The key-set should contains unique SimJQEvents within the realm of the DefaultWorkloadSchedule at which this handler registers. Likewise, the values should be unique.

Specified by:

getEventMap in interface WorkloadScheduleHandler

Returns:

The set of SimJQEvents of this handler, and the SimEntitySimpleEventType members onto which they map.

See Also:

SimQueueGateEvent, SimQueueWithGateSimpleEventType

needsScan

public final boolean needsScan()

Returns true.

Specified by:

needsScan in interface WorkloadScheduleHandler

Returns:

true.

See Also:

DefaultWorkloadSchedule.registerHandler(org.javades.jqueues.r5.util.predictor.workload.WorkloadScheduleHandler), WorkloadScheduleHandler.scan(org.javades.jqueues.r5.util.predictor.workload.DefaultWorkloadSchedule)

scan

public final Set<SimJQEvent> scan(DefaultWorkloadSchedule workloadSchedule)
                           throws WorkloadScheduleException

Description copied from interface: WorkloadScheduleHandler

Scans the host DefaultWorkloadSchedule and builds internal data structures.

Called by our host DefaultWorkloadSchedule only upon registration, and if we ask for it WorkloadScheduleHandler.needsScan().

Specified by:

scan in interface WorkloadScheduleHandler

Parameters:

workloadSchedule - The host at which we registered.

Returns:

The SimJQEvents processed by this handler, in a set with no particular member ordering; may be null or empty.

Throws:

WorkloadScheduleException - If the workload is invalid or ambiguous.

See Also:

DefaultWorkloadSchedule.registerHandler(org.javades.jqueues.r5.util.predictor.workload.WorkloadScheduleHandler), WorkloadScheduleHandler.scan(org.javades.jqueues.r5.util.predictor.workload.DefaultWorkloadSchedule)

getGatePassageCreditsMap

public final NavigableMap<Double,List<Integer>> getGatePassageCreditsMap(SimQueue queue)

Returns the gate-passage-credits settings in time for a specific queue.

A unmodifiable view must be returned.

Parameters:

queue - The queue, may be null, unknown or or not in DefaultWorkloadSchedule.getQueues() on the schedule we registered at, in which case an empty map is returned.

Returns:

The gate-passage-credits settings in time for the queue, indexed by time and subsequently ordered according to appearance in the source event list upon construction.

Throws:

IllegalStateException - If we are not registered at a DefaultWorkloadSchedule.