Simulation.Aivika.GPSS.Queue

Tested with: GHC 8.0.2

This module defines a GPSS queue entity.

Queue Types

data Queue

Represents the queue entity.

Instances

Eq Queue

Methods

(==) :: Queue -> Queue -> Bool

(/=) :: Queue -> Queue -> Bool

Hashable Queue

Methods

hashWithSalt :: Int -> Queue -> Int

hash :: Queue -> Int

data QueueEntry

The information about queue entry.

Constructors

QueueEntry

Fields

• entryQueue :: Queue

  the entry queue

• entryEnqueueTime :: Double

  the time of registering the queue entry

Instances

Eq QueueEntry

Methods

(==) :: QueueEntry -> QueueEntry -> Bool

(/=) :: QueueEntry -> QueueEntry -> Bool

Creating Queue

newQueue :: Event Queue

Create a new queue.

Queue Properties and Activities

queueNull :: Queue -> Event Bool

Test whether the queue is empty.

See also queueNullChanged and queueNullChanged_.

queueContent :: Queue -> Event Int

Return the current queue content.

See also queueContentStats, queueContentChanged and queueContentChanged_.

queueContentStats :: Queue -> Event (TimingStats Int)

Return the queue content statistics.

enqueueCount :: Queue -> Event Int

Return the total number of input items that were enqueued.

See also enqueueCountChanged and enqueueCountChanged_.

enqueueZeroEntryCount :: Queue -> Event Int

Return the total number of zero entry items.

See also enqueueZeroEntryCountChanged and enqueueZeroEntryCountChanged_.

queueWaitTime :: Queue -> Event (SamplingStats Double)

Return the wait (or residence) time.

See also queueWaitTimeChanged and queueWaitTimeChanged_.

queueNonZeroEntryWaitTime :: Queue -> Event (SamplingStats Double)

Return the wait (or residence) time excluding zero entries.

See also queueNonZeroEntryWaitTimeChanged and queueNonZeroEntryWaitTimeChanged_.

queueRate :: Queue -> Event Double

Return a long-term average queue rate calculated as the average queue content divided by the average wait time.

See also queueRateChanged and queueRateChanged_.

Dequeuing and Enqueuing

enqueue

Arguments

:: Queue

the queue

-> Transact a

the item to be enqueued

-> Int

the content increment

-> Event ()

Enqueue the item.

dequeue

Arguments

:: Queue

the queue

-> Transact a

the item to be dequeued

-> Int

the content decrement

-> Event ()

Dequeue the item.

Statistics Reset

resetQueue :: Queue -> Event ()

Reset the statistics.

Derived Signals for Properties

queueNullChanged :: Queue -> Signal Bool

Signal when the queueNull property value has changed.

queueNullChanged_ :: Queue -> Signal ()

Signal when the queueNull property value has changed.

queueContentChanged :: Queue -> Signal Int

Signal when the queueContent property value has changed.

queueContentChanged_ :: Queue -> Signal ()

Signal when the queueContent property value has changed.

enqueueCountChanged :: Queue -> Signal Int

Signal when the enqueueCount property value has changed.

enqueueCountChanged_ :: Queue -> Signal ()

Signal when the enqueueCount property value has changed.

enqueueZeroEntryCountChanged :: Queue -> Signal Int

Signal when the enqueueZeroEntryCount property value has changed.

enqueueZeroEntryCountChanged_ :: Queue -> Signal ()

Signal when the enqueueZeroEntryCount property value has changed.

queueWaitTimeChanged :: Queue -> Signal (SamplingStats Double)

Signal when the queueWaitTime property value has changed.

queueWaitTimeChanged_ :: Queue -> Signal ()

Signal when the queueWaitTime property value has changed.

queueNonZeroEntryWaitTimeChanged :: Queue -> Signal (SamplingStats Double)

Signal when the queueNonZeroEntryWaitTime property value has changed.

queueNonZeroEntryWaitTimeChanged_ :: Queue -> Signal ()

Signal when the queueNonZeroEntryWaitTime property value has changed.

queueRateChanged :: Queue -> Signal Double

Signal when the queueRate property value has changed.

queueRateChanged_ :: Queue -> Signal ()

Signal when the queueRate property value has changed.

Basic Signals

enqueued :: Queue -> Signal ()

Return a signal that notifies when enqueuing an item.

dequeued :: Queue -> Signal ()

Return a signal that notifies when the dequeuing the item.

Overall Signal

queueChanged_ :: Queue -> Signal ()

Signal whenever any property of the queue changes.

The property must have the corresponded signal. There are also characteristics similar to the properties but that have no signals. As a rule, such characteristics already depend on the simulation time and therefore they may change at any time point.