org.javades.jqueues.r5.extensions.ratelimit

Class SimQueueRateLimitStateHandler

java.lang.Object

org.javades.jqueues.r5.extensions.ratelimit.SimQueueRateLimitStateHandler

All Implemented Interfaces:

SimQueueStateHandler

public final class SimQueueRateLimitStateHandler
extends Object
implements SimQueueStateHandler

A SimQueueStateHandler for simple (arrival/departure) rate limitation.

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:

DLIMIT, ALIMIT, SimQueuePredictor_LeakyBucket

Constructor Summary

Constructors

Constructor and Description
SimQueueRateLimitStateHandler()

Method Summary

Modifier and Type	Method and Description
String	getHandlerName() Returns "SimQueueRateLimitStateHandler".
double	getLastArrTime() Gets the last arrival time.
double	getLastDepTime() Gets the last departure time.
void	initHandler(DefaultSimQueueState queueState) Initializes the handler, and passes the DefaultSimQueueState object.
boolean	isLastArrTimeSet() Returns whether the last arrival time was set since construction or last reset.
boolean	isLastDepTimeSet() Returns whether the last departure time was set since construction or last reset.
boolean	isRateLimited() Returns whether the (arrival/departure) rate is currently limited.
void	resetHandler(DefaultSimQueueState queueState) Resets the (state represented by) this handler.
void	setLastArrTime(double lastArrTime) Sets the last arrival time (without error checking) and flags the value has been set.
void	setLastDepTime(double lastDepTime) Sets the last departure time (without error checking) and flags the value has been set.
void	setRateLimited(boolean isRateLimited) Sets whether the (arrival/departure) rate is currently limited.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimQueueRateLimitStateHandler

public SimQueueRateLimitStateHandler()

Method Detail

getHandlerName

public final String getHandlerName()

Returns "SimQueueRateLimitStateHandler".

Specified by:

getHandlerName in interface SimQueueStateHandler

Returns:

"SimQueueRateLimitStateHandler".

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

isLastArrTimeSet

public final boolean isLastArrTimeSet()

Returns whether the last arrival time was set since construction or last reset.

Returns:

Whether the last arrival time was set since construction or last reset.

See Also:

resetHandler(org.javades.jqueues.r5.util.predictor.state.DefaultSimQueueState), getLastArrTime()

getLastArrTime

public final double getLastArrTime()

Gets the last arrival time.

Does not check whether the time was set since construction or last reset. If not, the default Double.NEGATIVE_INFINITY is returned.

Returns:

The last arrival time (set), or Double.NEGATIVE_INFINITY if no arrival time was set since construction or last reset.

See Also:

resetHandler(org.javades.jqueues.r5.util.predictor.state.DefaultSimQueueState), setLastArrTime(double)

setLastArrTime

public final void setLastArrTime(double lastArrTime)

Sets the last arrival time (without error checking) and flags the value has been set.

Parameters:

lastArrTime - The (new) last arrival time (unchecked).

See Also:

resetHandler(org.javades.jqueues.r5.util.predictor.state.DefaultSimQueueState), getLastArrTime(), isLastArrTimeSet()

isLastDepTimeSet

public final boolean isLastDepTimeSet()

Returns whether the last departure time was set since construction or last reset.

Returns:

Whether the last departure time was set since construction or last reset.

See Also:

resetHandler(org.javades.jqueues.r5.util.predictor.state.DefaultSimQueueState), getLastDepTime()

getLastDepTime

public final double getLastDepTime()

Gets the last departure time.

Does not check whether the time was set since construction or last reset. If not, the default Double.NEGATIVE_INFINITY is returned.

Returns:

The last departure time (set), or Double.NEGATIVE_INFINITY if no departure time was set since construction or last reset.

See Also:

resetHandler(org.javades.jqueues.r5.util.predictor.state.DefaultSimQueueState), setLastDepTime(double)

setLastDepTime

public final void setLastDepTime(double lastDepTime)

Sets the last departure time (without error checking) and flags the value has been set.

Parameters:

lastDepTime - The (new) last departure time (unchecked).

See Also:

resetHandler(org.javades.jqueues.r5.util.predictor.state.DefaultSimQueueState), getLastDepTime(), isLastDepTimeSet()

isRateLimited

public final boolean isRateLimited()

Returns whether the (arrival/departure) rate is currently limited.

Returns:

Whether the (arrival/departure) rate is currently limited.

See Also:

setRateLimited(boolean)

setRateLimited

public final void setRateLimited(boolean isRateLimited)

Sets whether the (arrival/departure) rate is currently limited.

Parameters:

isRateLimited - The new value whether the (arrival/departure) rate is currently limited.

See Also:

isRateLimited