KSLCore/ksl.simulation/ModelElement/QObject

QObject

open inner class QObject(aName: String? = null) : Comparable<ModelElement.QObject> , ModelElement.QObjectIfc

QObject can be used as a base class for objects that need to be placed in queues on a regular basis. A QObject can be in one and only one Queue at a time. An arbitrary object can be associated with the QObject. The user is responsible for managing the type of the attached object.

Creates an QObject with the given name and the creation time set to the supplied value

Parameters

aName

The name of the QObject

Inheritors

Constructors

QObject

constructor(aName: String? = null)

Properties

attachedObject

var attachedObject: Any?

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

createTime

override val createTime: Double

The time that the QObject was created

currentReceiver

open override var currentReceiver: QObjectReceiverIfc?

The receiver that last received the qObject

currentTime

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.

isNotQueued

override val isNotQueued: Boolean

isQueued

override val isQueued: Boolean

Checks if the QObject is queued

name

override val name: String

The name of the QObject

priority

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

qObjectType

open override var qObjectType: Int

A generic attribute to indicate a type for the QObject

queue

var queue: Queue<*>?

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

queuedState

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

sender

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

timeInQueue

override val timeInQueue: Double

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