org.javades.jqueues.r5.util.predictor.workload

Interface WorkloadSchedule

All Superinterfaces:

SimEntityEventMap

All Known Subinterfaces:

WorkloadSchedule_SQ, WorkloadSchedule_SQ_SV, WorkloadSchedule_SQ_SV_ROEL_U

All Known Implementing Classes:

DefaultWorkloadSchedule, DefaultWorkloadSchedule_SQ_SV, DefaultWorkloadSchedule_SQ_SV_ROEL_U

public interface WorkloadSchedule
extends SimEntityEventMap

A representation of a schedule of workload and state-setting events for a set of SimQueues.

The set of SimQueues to which the workload applies must be fixed upon construction.

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.

Method Summary

Modifier and Type	Method and Description
Map<SimJob,List<Double>>	getArrivalTimesMap(SimQueue queue) Gets the arrival times indexed by job at given queue.
NavigableMap<Double,List<SimJob>>	getJobArrivalsMap(SimQueue queue) Gets the job arrivals indexed by time at given queue.
NavigableMap<Double,List<Map<SimJob,Boolean>>>	getJobRevocationsMap(SimQueue queue) Gets the job revocations indexed by time at given queue.
Set<SimJob>	getJobs() Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at any of the queues.
Set<SimJob>	getJobs(SimQueue queue) Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at given queue.
double	getNextEventTimeBeyond(SimQueue queue, double time, Set<SimEntitySimpleEventType.Member> eventTypes) Returns the time of the next event(s), and optionally their types, scheduled strictly beyond a given time at a specific queue.
Set<SimJQEvent>	getProcessedQueueEvents() Gets the underlying queue events that were processed for this workload representation.
NavigableMap<Double,List<Boolean>>	getQueueAccessVacationMap(SimQueue queue) Returns the queue-access vacation settings in time for a specific queue.
Set<SimJQEvent>	getQueueEvents() Gets the underlying queue events (all) of this workload representation.
Set<SimQueue>	getQueues() Gets the queues (in no particular order) to which this workload representation applies.
Map<SimJob,List<Map<Double,Boolean>>>	getRevocationTimesMap(SimQueue queue) Gets the revocation times indexed by job at given queue.
NavigableMap<Double,List<Integer>>	getServerAccessCreditsMap(SimQueue queue) Returns the server-access-credits settings in time for a specific queue.
default boolean	hasEventsBeyond(SimQueue queue, double time) Returns whether there exist event(s) scheduled strictly beyond a given time at a specific queue.
default boolean	isSingleQueue() Returns whether of not this workload describes a single queue only.
default boolean	isSingleVisit() Return whether jobs arrive at most once at each queue.
default boolean	isSingleVisit(SimQueue queue) Return whether jobs arrive at most once at given queue.
default boolean	isUnambiguous_ROEL() Determines whether the workload is unambiguous under a ROEL (Random-Order Event List).

Methods inherited from interface org.javades.jqueues.r5.event.map.SimEntityEventMap

getEntityEvents, getSimJobTimeSimEntityEventMap, getSimQueueTimeSimEntityEventMap, getTimeSimJobSimEntityEventMap, getTimeSimQueueSimEntityEventMap

Method Detail

getQueueEvents

Set<SimJQEvent> getQueueEvents()

Gets the underlying queue events (all) of this workload representation.

A unmodifiable view must be returned.

Returns:

The underlying queue events (all) of this workload representation, ordered as found in the source upon construction.

getNextEventTimeBeyond

double getNextEventTimeBeyond(SimQueue queue,
                              double time,
                              Set<SimEntitySimpleEventType.Member> eventTypes)
                       throws WorkloadScheduleException

Returns the time of the next event(s), and optionally their types, scheduled strictly beyond a given time at a specific queue.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case Double.NaN is returned.

time - The time from which to search, use Double.NaN to retrieve the first-event time (which may be Double.NEGATIVE_INFINITY).

eventTypes - An optional set to store the (possible multiple) event types; a non-null set is cleared upon entry.

Returns:

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

Throws:

WorkloadScheduleException - If the workload is invalid, or this schedule is incapable of parsing it (completely).

See Also:

hasEventsBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double)

hasEventsBeyond

default boolean hasEventsBeyond(SimQueue queue,
                                double time)
                         throws WorkloadScheduleException

Returns whether there exist event(s) scheduled strictly beyond a given time at a specific queue.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case false is returned.

time - The time from which to search, use Double.NaN to retrieve the first-event time (which may be Double.NEGATIVE_INFINITY).

Returns:

True if there exist event(s) strictly beyond a given time.

Throws:

WorkloadScheduleException - If the workload is invalid, or this schedule is incapable of parsing it (completely).

See Also:

getNextEventTimeBeyond(org.javades.jqueues.r5.entity.jq.queue.SimQueue, double, java.util.Set<org.javades.jqueues.r5.entity.SimEntitySimpleEventType.Member>)

getProcessedQueueEvents

Set<SimJQEvent> getProcessedQueueEvents()

Gets the underlying queue events that were processed for this workload representation.

The set returned must always be a subset of getQueueEvents().

A unmodifiable view must be returned.

Returns:

The underlying queue events that were processed for this workload representation, in no particular specified order.

getQueues

Set<SimQueue> getQueues()

Gets the queues (in no particular order) to which this workload representation applies.

The set must be fixed upon construction.

A unmodifiable view must be returned.

Returns:

The queue (in no particular order) to which this workload representation applies.

isSingleQueue

default boolean isSingleQueue()

Returns whether of not this workload describes a single queue only.

Returns:

Whether this workload describes a single queue only.

getQueueAccessVacationMap

NavigableMap<Double,List<Boolean>> getQueueAccessVacationMap(SimQueue queue)

Returns the queue-access vacation settings in time for a specific queue.

A unmodifiable view must be returned.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case an empty map is returned.

Returns:

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

getJobs

Set<SimJob> getJobs()

Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at any of the queues.

Note that this set may include jobs that did not arrive at any queue.

A unmodifiable view must be returned.

Returns:

The jobs (in no particular order) in a non-null set operating (arriving, revoking, ...) at least once at any of the queues.

getJobs

Set<SimJob> getJobs(SimQueue queue)

Gets the jobs (in no particular order) operating (arriving, revoking, ...) at least once at given queue.

The set returned must always be a subset of getJobs(SimQueue).

Note that this set may include jobs that did not arrive at the queue.

A unmodifiable view must be returned.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case an empty set is returned.

Returns:

The jobs (in no particular order) in a non-null set operating (arriving, revoking, ...) at least once at given queue.

getArrivalTimesMap

Map<SimJob,List<Double>> getArrivalTimesMap(SimQueue queue)

Gets the arrival times indexed by job at given queue.

A unmodifiable view must be returned.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case an empty map is returned.

Returns:

The job arrival times indexed by job and subsequently ordered according to appearance in the source event list upon construction.

getJobArrivalsMap

NavigableMap<Double,List<SimJob>> getJobArrivalsMap(SimQueue queue)

Gets the job arrivals indexed by time at given queue.

A unmodifiable view must be returned.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case an empty map is returned.

Returns:

The job arrivals in time for the queue, indexed by time and subsequently ordered according to appearance in the source event list upon construction.

isSingleVisit

default boolean isSingleVisit(SimQueue queue)

Return whether jobs arrive at most once at given queue.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case false is returned.

Returns:

Whether jobs arrive at most once at given queue.

isSingleVisit

default boolean isSingleVisit()

Return whether jobs arrive at most once at each queue.

Note that if there are no queue, true is returned. Also note that if true is returned, jobs may still visit multiple, albeit different, queues.

Returns:

Whether jobs arrive at most once at each queue.

getRevocationTimesMap

Map<SimJob,List<Map<Double,Boolean>>> getRevocationTimesMap(SimQueue queue)

Gets the revocation times indexed by job at given queue.

A unmodifiable view must be returned.

The inner map yields the 'interruptService' argument for the event time. It has only one entry.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case an empty map is returned.

Returns:

The job revocation times indexed by job and subsequently ordered according to appearance in the source event list upon construction.

getJobRevocationsMap

NavigableMap<Double,List<Map<SimJob,Boolean>>> getJobRevocationsMap(SimQueue queue)

Gets the job revocations indexed by time at given queue.

A unmodifiable view must be returned.

The inner map yields the 'interruptService' argument for the job. It has only one entry.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case an empty map is returned.

Returns:

The job revocations in time for the queue, indexed by time and subsequently ordered according to appearance in the source event list upon construction.

getServerAccessCreditsMap

NavigableMap<Double,List<Integer>> getServerAccessCreditsMap(SimQueue queue)

Returns the server-access-credits settings in time for a specific queue.

A unmodifiable view must be returned.

Parameters:

queue - The queue, may be null or not in getQueues(), in which case an empty map is returned.

Returns:

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

isUnambiguous_ROEL

default boolean isUnambiguous_ROEL()
                            throws WorkloadScheduleInvalidException

Determines whether the workload is unambiguous under a ROEL (Random-Order Event List).

This implementation checks that for each queue in getQueues(), there are no simultaneous queue events. It ignores job-only events, events related to queues not in getQueues(), and allows simultaneous events to distinct queues.

The criterion for unambiguity is rather strong, but is believed to be applicable to any queue type.

Returns:

Whether the workload is unambiguous under a ROEL.

Throws:

WorkloadScheduleInvalidException - If the workload is invalid.