org.javades.jqueues.r5.util.loadfactory

Interface LoadFactory_SQ_SV<J extends SimJob,Q extends SimQueue>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Superinterfaces:

LoadFactory<J,Q>

All Known Implementing Classes:

AbstractLoadFactory_SQ_SV, LoadFactory_SQ_SV_0001, LoadFactory_SQ_SV_0002, LoadFactory_SQ_SV_0003, LoadFactory_SQ_SV_0005, LoadFactory_SQ_SV_0010, LoadFactory_SQ_SV_0011, LoadFactory_SQ_SV_0012, LoadFactory_SQ_SV_0013, LoadFactory_SQ_SV_0014, LoadFactory_SQ_SV_0015, LoadFactory_SQ_SV_0100

public interface LoadFactory_SQ_SV<J extends SimJob,Q extends SimQueue>
extends LoadFactory<J,Q>

A LoadFactory that generates a load for a single SimQueue in which each job visits the queue at most once.

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
Set<J>	generate(org.javades.jsimulation.r5.SimEventList eventList, boolean attachSimJobsToEventList, Q queue, SimJobFactory<J,Q> jobFactory, int numberOfJobs, boolean reset, double resetTime, Set<LoadFactoryHint> hints, NavigableMap<Double,Set<SimJQEvent>> queueEvents) Generates job from a factory, schedule arrivals (and/or revocations) for them on an event list, as well as queue vacations (if applicable), and return the generated load in a user-supplied collection of SimJQEvents.
default String	getDescription() Returns a description of this load factory.

Method Detail

generate

Set<J> generate(org.javades.jsimulation.r5.SimEventList eventList,
                boolean attachSimJobsToEventList,
                Q queue,
                SimJobFactory<J,Q> jobFactory,
                int numberOfJobs,
                boolean reset,
                double resetTime,
                Set<LoadFactoryHint> hints,
                NavigableMap<Double,Set<SimJQEvent>> queueEvents)

Generates job from a factory, schedule arrivals (and/or revocations) for them on an event list, as well as queue vacations (if applicable), and return the generated load in a user-supplied collection of SimJQEvents.

Parameters:

eventList - The event list, non-null.

attachSimJobsToEventList - Whether or not to attach the generated SimJobs to the SimEventList; typically set to false (see SimEntity and SimJob for more details on the consequences).

queue - The queue, non-null.

jobFactory - The job factory, non-null.

numberOfJobs - The number of jobs to generate, non-negative.

reset - Whether or not to reset the event list.

resetTime - The time to which to reset the event list.

hints - An optional set of LoadFactoryHints, may be null and unknown hints are silently ignored.

queueEvents - An optional map for storing the generated SimJQEvents indexed by event time and for events at the same time, by order of occurrence. The map is not cleared; generated events in this method are assumed to occur after any existing events at the same time.

Returns:

The set of jobs generated.

Throws:

IllegalArgumentException - If any of the arguments supplied has an illegal value.

getDescription

default String getDescription()

Returns a description of this load factory.

The default implementation returns "None provided!".

Returns:

A description of this load factory.