KSLCore/ksl.modeling.entity/HoldQueue

HoldQueue

class HoldQueue @JvmOverloads constructor(parent: ModelElement, name: String? = null, discipline: Queue.Discipline = Discipline.FIFO) : Queue<ProcessModel.Entity> (source)

This class is designed to hold entities that are waiting within a process.

Constructors

HoldQueue

@JvmOverloads

constructor(parent: ModelElement, name: String? = null, discipline: Queue.Discipline = Discipline.FIFO)

Functions

removeAllAndResume

fun removeAllAndResume(resumePriority: Int = ProcessModel.RESUME_PRIORITY, waitStats: Boolean = true)

Removes and resumes all the entities waiting in the queue

removeAllAndTerminate

fun removeAllAndTerminate(waitStats: Boolean = false)

Removes and terminates all the entities waiting in the queue

removeAllWithImmediateResume

fun removeAllWithImmediateResume(waitStats: Boolean = true)

Removes the entities from the queue and tells it to resume its process immediately, without being scheduled through the event loop. This may be useful to coordinate processes that occur at the same time.

removeAndImmediateResume

fun removeAndImmediateResume(entity: ProcessModel.Entity, waitStats: Boolean = true)

Removes the entity from the queue and tells it to resume its process immediately, without being scheduled through the event loop. This may be useful to coordinate processes that occur at the same time.

removeAndResume

fun removeAndResume(entity: ProcessModel.Entity, resumePriority: Int = ProcessModel.RESUME_PRIORITY, waitStats: Boolean = true)

Removes the entity from the queue and tells it to resume its process

removeAndTerminate

fun removeAndTerminate(entity: ProcessModel.Entity, waitStats: Boolean = false)

Removes the entity from the queue and tells it to terminate its process. The process that was suspended because the entity was placed in the queue is immediately terminated.