org.javades.jqueues.r5.entity.jq.queue.composite.enc

Class DelegatedSimQueueOperation

java.lang.Object

org.javades.jqueues.r5.entity.jq.queue.composite.enc.DelegatedSimQueueOperation

All Implemented Interfaces:

SimEntityOperation<SimEntityOperation,SimEntityOperation.Request,SimEntityOperation.Reply>

public class DelegatedSimQueueOperation
extends Object
implements SimEntityOperation<SimEntityOperation,SimEntityOperation.Request,SimEntityOperation.Reply>

A SimEntityOperation for composite queues that delegates the execution of a specific operation on a (specific) composite queue to another operation on a (specific) sub-queue.

In theory, the use of this class is not restricted to composite queues. For instance, the queue and sub-queue could be the same object. This use, however, has not been tested.

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.

See Also:

SimEntity.doOperation(double, Req), AbstractSimEntity.registerDelegatedOperation(org.javades.jqueues.r5.entity.SimEntityOperation, org.javades.jqueues.r5.entity.SimEntityOperation), Enc, EncHS

Nested Class Summary

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.SimEntityOperation

SimEntityOperation.Reply<O extends SimEntityOperation,Req extends SimEntityOperation.Request,Rep extends SimEntityOperation.Reply>, SimEntityOperation.Request<O extends SimEntityOperation,Req extends SimEntityOperation.Request>, SimEntityOperation.RequestE<O extends SimEntityOperation,Req extends SimEntityOperation.Request>, SimEntityOperation.Reset, SimEntityOperation.ResetReply, SimEntityOperation.ResetRequest, SimEntityOperation.Update, SimEntityOperation.UpdateReply, SimEntityOperation.UpdateRequest

Constructor Summary

Constructors

Constructor and Description
DelegatedSimQueueOperation(SimQueue queue, SimQueue subQueue, SimEntityOperation oDQueue, AbstractSimQueueComposite.RealDelegateJobMapper jobMapper) Creates a delegated SimEntityOperation.

Method Summary

Modifier and Type	Method and Description
SimEntityOperation.Reply	doOperation(double time, SimEntityOperation.Request request) Performs the operation on the sub-queue.
String	getName() Returns "DelegatedOperation[operation on sub-queue]".
Class	getOperationReplyClass() Returns the class of the reply for the operation on the sub-queue.
Class	getOperationRequestClass() Returns the class of the request for the operation on the sub-queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatedSimQueueOperation

public DelegatedSimQueueOperation(SimQueue queue,
                                  SimQueue subQueue,
                                  SimEntityOperation oDQueue,
                                  AbstractSimQueueComposite.RealDelegateJobMapper jobMapper)

Creates a delegated SimEntityOperation.

Parameters:

queue - The queue for which to delegate the given operation.

subQueue - The delegate sub-queue (that will eventually execute the operation).

oDQueue - The delegate operation on the sub-queue.

jobMapper - An optional mapper between real and delegate jobs.

Method Detail

getName

public final String getName()

Returns "DelegatedOperation[operation on sub-queue]".

Specified by:

getName in interface SimEntityOperation<SimEntityOperation,SimEntityOperation.Request,SimEntityOperation.Reply>

Returns:

"DelegatedOperation[operation on sub-queue]".

getOperationRequestClass

public final Class getOperationRequestClass()

Returns the class of the request for the operation on the sub-queue.

Specified by:

getOperationRequestClass in interface SimEntityOperation<SimEntityOperation,SimEntityOperation.Request,SimEntityOperation.Reply>

Returns:

The class of the request for the operation on the sub-queue.

getOperationReplyClass

public final Class getOperationReplyClass()

Returns the class of the reply for the operation on the sub-queue.

Specified by:

getOperationReplyClass in interface SimEntityOperation<SimEntityOperation,SimEntityOperation.Request,SimEntityOperation.Reply>

Returns:

The class of the reply for the operation on the sub-queue.

doOperation

public SimEntityOperation.Reply doOperation(double time,
                                            SimEntityOperation.Request request)

Performs the operation on the sub-queue.

A copy of the operation request is requested with sub-queue and delegate job as request parameters. This, however, is not fully supported for all request types.

Specified by:

doOperation in interface SimEntityOperation<SimEntityOperation,SimEntityOperation.Request,SimEntityOperation.Reply>

Parameters:

time - The time at which to perform the request.

request - The request, non-null.

Returns:

The result (reply) of the operation, non-null.

Throws:

IllegalArgumentException - If the request is null or requires a job mapper that is absent.

UnsupportedOperationException - If the request's parameters could not be changed into those required for the sub-queue.

See Also:

AbstractSimQueueComposite.RealDelegateJobMapper