KSLCore/ksl.modeling.entity/BlockingQueue/AmountRequest

AmountRequest

inner class AmountRequest(receiver: ProcessModel.Entity, predicate: (T) -> Boolean, val amountRequested: Int) : BlockingQueue.ChannelRequest<T>

Represents a request by an entity to receive a given amount of items from the channel that meet the criteria (predicate).

Parameters

receiver

the entity that wants the items

predicate

the criteria for selecting the items from the channel

amountRequested

the number of items (meeting the criteria) that are needed

Constructors

constructor(receiver: ProcessModel.Entity, predicate: (T) -> Boolean, amountRequested: Int)

Properties

amountRequested

val amountRequested: Int

var attachedObject: Any?

A reference to an object that can be attached to the QObject when queued

open override val canBeFilled: Boolean

True if the request can be filled at the time the property is accessed

val canNotBeFilled: Boolean

True if the request can not be filled at the time the property is accessed

override val createTime: Double

The time that the QObject was created

currentReceiver

open override var currentReceiver: QObjectReceiverIfc?

The receiver that last received the qObject

override val currentTime: Double

The current simulation time. Attached to the queue object for convenience of checking time outside of model element instances.

override val id: Long

Gets a uniquely assigned identifier for this QObject. This identifier is assigned when the QObject is created. It may vary if the order of creation changes.

override val isNotQueued: Boolean

override val isQueued: Boolean

Checks if the QObject is queued

override val name: String

The name of the QObject

val predicate: (T) -> Boolean

override var priority: Int

Sets the priority to the supplied value If the QObject is queued, the queue's changePriority() method is called (possibly causing a reordering of the queue) which may cause significant reordering overhead otherwise the priority is directly changed Changing this value only changes how the QObjects are compared and may or may not change how they are ordered in the queue, depending on the queue discipline used

open override var qObjectType: Int

A generic attribute to indicate a type for the QObject

var queue: Queue<*>?

The current queue that the QObject is in, null if not in a queue

override val queuedState: StateAccessorIfc

This method can be used to get direct access to the State that represents when the object was queued. This allows access to the total time in the queued state as well as other statistical accumulation of state statistics

val receiver: ProcessModel.Entity

open override var sender: QObjectSenderIfc?

Something that knows how to send qObjects to receivers

timeEnteredQueue

override val timeEnteredQueue: Double

The time that the QObject was LAST enqueued

timeExitedQueue

override val timeExitedQueue: Double

The time that the QObject LAST exited a queue

override val timeInQueue: Double

The time that the QObject spent in the Queue based on the LAST time dequeued

var timeStamp: Double

can be used to time stamp the qObject

open override var valueObject: GetValueIfc?

Allows for a generic value to be held by the QObject

Functions

open operator override fun compareTo(other: ModelElement.QObject): Int

Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

fun sender(sender: QObjectSenderIfc?)

Facilitates SAM setting with a lambda

open override fun toString(): String

fun valueObject(value: GetValueIfc?)

Facilitates SAM setting with a lambda