org.javades.jqueues.r5.extensions.gate

Class SimQueueWithGateStateHandler

java.lang.Object

org.javades.jqueues.r5.extensions.gate.SimQueueWithGateStateHandler

All Implemented Interfaces:

SimQueueStateHandler

public final class SimQueueWithGateStateHandler
extends Object
implements SimQueueStateHandler

A SimQueueStateHandler for SimQueueWithGate.

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

Method Summary

Modifier and Type	Method and Description
int	getGatePassageCredits() Gets the remaining number of passage credits for the gate.
String	getHandlerName() Returns "SimQueueWithGateHandler".
void	initHandler(DefaultSimQueueState queueState) Initializes the handler, and passes the DefaultSimQueueState object.
void	resetHandler(DefaultSimQueueState queueState) Resets the (state represented by) this handler.
void	setGatePassageCredits(double time, int gatePassageCredits) Sets the remaining number of passage credits for the gate.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimQueueWithGateStateHandler

public SimQueueWithGateStateHandler()

Method Detail

getHandlerName

public final String getHandlerName()

Returns "SimQueueWithGateHandler".

Specified by:

getHandlerName in interface SimQueueStateHandler

Returns:

"SimQueueWithGateHandler".

initHandler

public final void initHandler(DefaultSimQueueState queueState)

Description copied from interface: SimQueueStateHandler

Initializes the handler, and passes the DefaultSimQueueState object.

This method is called only once during registration at the DefaultSimQueueState object.

Specified by:

initHandler in interface SimQueueStateHandler

Parameters:

queueState - The DefaultSimQueueState at which we register, non-null.

See Also:

DefaultSimQueueState.registerHandler(org.javades.jqueues.r5.util.predictor.state.SimQueueStateHandler)

resetHandler

public void resetHandler(DefaultSimQueueState queueState)

Description copied from interface: SimQueueStateHandler

Resets the (state represented by) this handler.

Specified by:

resetHandler in interface SimQueueStateHandler

Parameters:

queueState - The DefaultSimQueueState at which we are registered, non-null.

See Also:

SimQueueState.reset(), DefaultSimQueueState.reset()

getGatePassageCredits

public int getGatePassageCredits()

Gets the remaining number of passage credits for the gate.

Mimics SimQueueWithGate.getGatePassageCredits().

Returns:

The remaining number of passage credits for the gate; non-negative with Integer.MAX_VALUE treated as infinity.

Throws:

IllegalStateException - If we are not registered at a DefaultSimQueueState.

setGatePassageCredits

public void setGatePassageCredits(double time,
                                  int gatePassageCredits)

Sets the remaining number of passage credits for the gate.

Mimics SimQueueWithGate.getGatePassageCredits().

The time cannot be in the past.

Parameters:

time - The time to set the remaining number of passages.

gatePassageCredits - The new remaining number of passage credits for the gate, non-negative, with Integer.MAX_VALUE treated as infinity.

Throws:

IllegalStateException - If we are not registered at a DefaultSimQueueState.

IllegalArgumentException - If time is in the past, or the number of passage credits is (strictly) negative.

See Also:

DefaultSimQueueState.setTime(double)