org.javades.jqueues.r5.extensions.gate

Class SimQueuePredictor_GATE

java.lang.Object

org.javades.jqueues.r5.util.predictor.AbstractSimQueuePredictor<GATE>

org.javades.jqueues.r5.extensions.gate.SimQueuePredictor_GATE

All Implemented Interfaces:

SimQueueEventPredictor<GATE>, SimQueuePredictor<GATE>, SimQueueStatePredictor<GATE>

public class SimQueuePredictor_GATE
extends AbstractSimQueuePredictor<GATE>

A SimQueuePredictor for GATE.

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
SimQueuePredictor_GATE()

Method Summary

Modifier and Type	Method and Description
SimQueueState<SimJob,GATE>	createQueueState(GATE queue, boolean isROEL) Registers a new SimQueueWithGateStateHandler at the object created by super method.
WorkloadSchedule_SQ_SV_ROEL_U	createWorkloadSchedule_SQ_SV_ROEL_U(GATE queue, Set<SimJQEvent> workloadEvents) Registers a new SimQueueWithGateWorkloadScheduleHandler at the object created by super method.
void	doQueueEvents_SQ_SV_ROEL_U(GATE queue, SimQueueState<SimJob,GATE> queueState, Set<SimEntitySimpleEventType.Member> queueEventTypes, Set<JobQueueVisitLog<SimJob,GATE>> visitLogsSet) Process the next event(s) at a queue with given state.
void	doWorkloadEvents_SQ_SV_ROEL_U(GATE queue, WorkloadSchedule_SQ_SV_ROEL_U workloadSchedule, SimQueueState<SimJob,GATE> queueState, Set<SimEntitySimpleEventType.Member> workloadEventTypes, Set<JobQueueVisitLog<SimJob,GATE>> visitLogsSet) Process the next event(s) from given WorkloadSchedule at a queue with given state.
double	getNextQueueEventTimeBeyond(GATE queue, SimQueueState<SimJob,GATE> queueState, Set<SimEntitySimpleEventType.Member> queueEventTypes) Returns the time and types of the next event(s) scheduled strictly beyond the time at (the state object of) a specific queue.
boolean	isStartArmed(GATE queue, SimQueueState<SimJob,GATE> queueState) Checks whether a given state represents StartArmed on given queue.
String	toString()
void	updateToTime(GATE queue, SimQueueState queueState, double newTime) Updates the queue state to a new time, without processing any events.

Methods inherited from class org.javades.jqueues.r5.util.predictor.AbstractSimQueuePredictor

is_ROEL_U_UnderWorkloadQueueEventClashes, is_U_UnderWorkloadQueueEventClashes, predict_SQ_SV_IOEL_U, predict_SQ_SV_ROEL_U

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javades.jqueues.r5.util.predictor.SimQueuePredictor

matchVisitLogs_SQ_SV

Methods inherited from interface org.javades.jqueues.r5.util.predictor.SimQueueEventPredictor

createWorkloadSchedule_SQ_SV, doWorkloadEvents_SQ_SV

Methods inherited from interface org.javades.jqueues.r5.util.predictor.SimQueueStatePredictor

hasServerAccessCredits, isQueueAccessVacation

Constructor Detail

SimQueuePredictor_GATE

public SimQueuePredictor_GATE()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isStartArmed

public boolean isStartArmed(GATE queue,
                            SimQueueState<SimJob,GATE> queueState)

Description copied from interface: SimQueueStatePredictor

Checks whether a given state represents StartArmed on given queue.

Parameters:

queue - The queue.

queueState - The queue state, non-null.

Returns:

True if the state represents StartArmed at given queue.

createWorkloadSchedule_SQ_SV_ROEL_U

public WorkloadSchedule_SQ_SV_ROEL_U createWorkloadSchedule_SQ_SV_ROEL_U(GATE queue,
                                                                         Set<SimJQEvent> workloadEvents)
                                                                  throws WorkloadScheduleException

Registers a new SimQueueWithGateWorkloadScheduleHandler at the object created by super method.

Parameters:

queue - The queue, non-null.

workloadEvents - The workload events, may be null or empty.

Returns:

A new suitable WorkloadSchedule_SQ_SV_ROEL_U object for this predictor and given queue.

Throws:

WorkloadScheduleException - If the workload is invalid or ambiguous (for instance).

createQueueState

public SimQueueState<SimJob,GATE> createQueueState(GATE queue,
                                                   boolean isROEL)

Registers a new SimQueueWithGateStateHandler at the object created by super method.

Parameters:

queue - The queue, non-null.

isROEL - Whether or not the event list used is a Random-Order Event List.

Returns:

A new suitable SimQueueState object for this predictor and given queue.

getNextQueueEventTimeBeyond

public double getNextQueueEventTimeBeyond(GATE queue,
                                          SimQueueState<SimJob,GATE> queueState,
                                          Set<SimEntitySimpleEventType.Member> queueEventTypes)

Description copied from interface: SimQueueEventPredictor

Returns the time and types of the next event(s) scheduled strictly beyond the time at (the state object of) a specific queue.

The time from which to search must be taken from SimQueueState.getTime(), and equals Double.NaN after initialization.

Parameters:

queue - The queue, non-null.

queueState - The queue-state, non-null.

queueEventTypes - A non-null set to store the (possible multiple) event types; it must be cleared upon entry.

Returns:

The time of the next event, or Double.NaN if no such event exists.

See Also:

SimJQSimpleEventType.START, SimJQSimpleEventType.DEPARTURE

doWorkloadEvents_SQ_SV_ROEL_U

public void doWorkloadEvents_SQ_SV_ROEL_U(GATE queue,
                                          WorkloadSchedule_SQ_SV_ROEL_U workloadSchedule,
                                          SimQueueState<SimJob,GATE> queueState,
                                          Set<SimEntitySimpleEventType.Member> workloadEventTypes,
                                          Set<JobQueueVisitLog<SimJob,GATE>> visitLogsSet)
                                   throws SimQueuePredictionException,
                                          WorkloadScheduleException

Description copied from interface: SimQueueEventPredictor

Process the next event(s) from given WorkloadSchedule at a queue with given state.

The scheduled time and the types of the next events must be known beforehand, e.g., through WorkloadSchedule.getNextEventTimeBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>). The scheduled time has already been set on the SimQueueState object, and the object has been updated upto that time. The time on the queue state must not be changed.

Implementations must update the queue state and (if applicable) add suitable entries to the visit logs.

Implementations must not modify the workload schedule.

Parameters:

queue - The queue, non-null.

workloadSchedule - The workload schedule, non-null.

queueState - The queue-state, non-null.

workloadEventTypes - The (pre-calculated) types of the next workload event(s).

visitLogsSet - The visit logs, non-null.

Throws:

SimQueuePredictionException - If the result cannot be computed, e.g., due to invalid input or schedule ambiguities.

WorkloadScheduleException - If the workload is invalid (e.g., containing ambiguities).

See Also:

WorkloadSchedule.getNextEventTimeBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>), SimQueueEventPredictor.updateToTime(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState, double), SimQueueState.setTime(double)

doQueueEvents_SQ_SV_ROEL_U

public void doQueueEvents_SQ_SV_ROEL_U(GATE queue,
                                       SimQueueState<SimJob,GATE> queueState,
                                       Set<SimEntitySimpleEventType.Member> queueEventTypes,
                                       Set<JobQueueVisitLog<SimJob,GATE>> visitLogsSet)
                                throws SimQueuePredictionException

Description copied from interface: SimQueueEventPredictor

Process the next event(s) at a queue with given state.

The scheduled time and the types of the next events must be known beforehand, e.g., through SimQueueEventPredictor.getNextQueueEventTimeBeyond(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState<org.javades.jqueues.r5.entity.jq.job.SimJob, Q>, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>). The scheduled time has already been set on the SimQueueState object, and the object has been updated upto that time. The time on the queue state must not be changed.

Implementations must update the queue state and (if applicable) add suitable entries to the visit logs.

Parameters:

queue - The queue, non-null.

queueState - The queue-state, non-null

queueEventTypes - The (pre-calculated) types of the next workload event(s).

visitLogsSet - The visit logs, non-null.

Throws:

SimQueuePredictionException - If the result cannot be computed, e.g., due to invalid input or schedule ambiguities.

See Also:

SimQueueEventPredictor.getNextQueueEventTimeBeyond(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState<org.javades.jqueues.r5.entity.jq.job.SimJob, Q>, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>), SimQueueEventPredictor.updateToTime(Q, org.javades.jqueues.r5.util.predictor.state.SimQueueState, double), SimQueueState.setTime(double)

updateToTime

public void updateToTime(GATE queue,
                         SimQueueState queueState,
                         double newTime)

Description copied from interface: SimQueueEventPredictor

Updates the queue state to a new time, without processing any events.

Implementations must at least set the time on the queue state. Beware that the old time on the queue state may equal its initial value Double.NaN.

Parameters:

queue - The queue, non-null.

queueState - The queue-state, non-null.

newTime - The new time.

See Also:

SimQueueState.setTime(double)