org.javades.jqueues.r5.entity

Interface SimEntityOperation<O extends SimEntityOperation,Req extends SimEntityOperation.Request,Rep extends SimEntityOperation.Reply>

Type Parameters:

O - The operation type.

Req - The request type (corresponding to the operation type).

Rep - The reply type (corresponding to the operation type).

All Known Subinterfaces:

SimJobOperation<J,Q,O,Req,Rep>, SimJQOperation<J,Q,O,Req,Rep>, SimQueueOperation<J,Q,O,Req,Rep>

All Known Implementing Classes:

DelegatedSimQueueOperation, SimEntityOperation.Reset, SimEntityOperation.Update, SimJQOperation.Arrival, SimJQOperation.Revocation, SimQueueOperation.QueueAccessVacation, SimQueueOperation.ServerAccessCredits, SimQueueWithGateOperationUtils.GatePassageCreditsOperation

public interface SimEntityOperation<O extends SimEntityOperation,Req extends SimEntityOperation.Request,Rep extends SimEntityOperation.Reply>

The definition of an operation on a SimEntity (or on multiple ones).

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.getRegisteredOperations(), SimEntity.doOperation(double, Req)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SimEntityOperation.Reply<O extends SimEntityOperation,Req extends SimEntityOperation.Request,Rep extends SimEntityOperation.Reply> A reply from a SimEntityOperation.
static interface	SimEntityOperation.Request<O extends SimEntityOperation,Req extends SimEntityOperation.Request> A request for a SimEntityOperation.
static class	SimEntityOperation.RequestE<O extends SimEntityOperation,Req extends SimEntityOperation.Request> A request for an operation that requires an entity argument.
static class	SimEntityOperation.Reset The (default) reset operation on a SimEntity.
static class	SimEntityOperation.ResetReply A reply for the reset operation SimEntityOperation.Reset.
static class	SimEntityOperation.ResetRequest A request for the reset operation SimEntityOperation.Reset.
static class	SimEntityOperation.Update The (default) update operation on a SimEntity.
static class	SimEntityOperation.UpdateReply A reply for the update operation SimEntityOperation.Update.
static class	SimEntityOperation.UpdateRequest A request for the update operation SimEntityOperation.Update.

Method Summary

Modifier and Type	Method and Description
Rep	doOperation(double time, Req request) Performs the operation at given time with given request.
String	getName() Gets the name of this operation.
Class<Rep>	getOperationReplyClass() Gets the type of replies for this operation.
Class<Req>	getOperationRequestClass() Gets the type of requests for this operation.

Method Detail

getName

String getName()

Gets the name of this operation.

Returns:

The name of this operation, non-null and non-empty.

getOperationRequestClass

Class<Req> getOperationRequestClass()

Gets the type of requests for this operation.

Returns:

The type of requests for this operation, non-null.

getOperationReplyClass

Class<Rep> getOperationReplyClass()

Gets the type of replies for this operation.

Returns:

The type of replies for this operation, non-null.

doOperation

Rep doOperation(double time,
                Req request)

Performs the operation at given time with given request.

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 entity or request is null, time is in the past, the request is of illegal type, or its parameter values are illegal.