aivika-gpss-0.7.1: GPSS-like DSL for Aivika

Copyright	Copyright (c) 2017 David Sorokin <david.sorokin@gmail.com>
License	BSD3
Maintainer	David Sorokin <david.sorokin@gmail.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Simulation.Aivika.GPSS.Storage

Contents

Storage Type
Creating Storage
Storage Properties
Entering-Leaving Storage
Statistics Reset
Signals

Description

Tested with: GHC 8.0.1

This module defines the GPSS Storage entity.

Synopsis

data Storage
newStorage :: Int -> Event Storage
storageCapacity :: Storage -> Int
storageEmpty :: Storage -> Event Bool
storageFull :: Storage -> Event Bool
storageContent :: Storage -> Event Int
storageContentStats :: Storage -> Event (TimingStats Int)
storageUseCount :: Storage -> Event Int
storageUsedContent :: Storage -> Event Int
storageUtilisationCount :: Storage -> Event Int
storageUtilisationCountStats :: Storage -> Event (TimingStats Int)
storageQueueCount :: Storage -> Event Int
storageQueueCountStats :: Storage -> Event (TimingStats Int)
storageTotalWaitTime :: Storage -> Event Double
storageWaitTime :: Storage -> Event (SamplingStats Double)
storageAverageHoldingTime :: Storage -> Event Double
enterStorage :: Storage -> Transact a -> Int -> Process ()
leaveStorage :: Storage -> Int -> Process ()
leaveStorageWithinEvent :: Storage -> Int -> Event ()
resetStorage :: Storage -> Event ()
storageContentChanged :: Storage -> Signal Int
storageContentChanged_ :: Storage -> Signal ()
storageUseCountChanged :: Storage -> Signal Int
storageUseCountChanged_ :: Storage -> Signal ()
storageUsedContentChanged :: Storage -> Signal Int
storageUsedContentChanged_ :: Storage -> Signal ()
storageUtilisationCountChanged :: Storage -> Signal Int
storageUtilisationCountChanged_ :: Storage -> Signal ()
storageQueueCountChanged :: Storage -> Signal Int
storageQueueCountChanged_ :: Storage -> Signal ()
storageWaitTimeChanged :: Storage -> Signal (SamplingStats Double)
storageWaitTimeChanged_ :: Storage -> Signal ()
storageChanged_ :: Storage -> Signal ()

Storage Type

data Storage Source #

Represents a GPSS Storage entity.

Instances

Instances details

ResultProvider Storage Source #
Instance details Defined in Simulation.Aivika.GPSS.Results Methods resultSource :: ResultName -> ResultDescription -> Storage -> ResultSource # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Storage -> ResultSource # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Storage -> ResultSource #
Eq Storage Source #
Instance details Defined in Simulation.Aivika.GPSS.Storage Methods (==) :: Storage -> Storage -> Bool # (/=) :: Storage -> Storage -> Bool #

Creating Storage

newStorage :: Int -> Event Storage Source #

Create a new storage by the specified capacity.

Storage Properties

storageCapacity :: Storage -> Int Source #

Return the storage capacity.

storageEmpty :: Storage -> Event Bool Source #

Whether the storage is empty, i.e. completely unused.

storageFull :: Storage -> Event Bool Source #

Whether the storage is full, i.e. completely used.

storageContent :: Storage -> Event Int Source #

Return the current storage content available for use.

storageContentStats :: Storage -> Event (TimingStats Int) Source #

Return the statistics of the storage content available for use.

storageUseCount :: Storage -> Event Int Source #

Return the total use count of the storage.

storageUsedContent :: Storage -> Event Int Source #

Return the total used content of the storage.

storageUtilisationCount :: Storage -> Event Int Source #

Return the current utilisation count of the storage.

storageUtilisationCountStats :: Storage -> Event (TimingStats Int) Source #

Return the statistics for the utilisation count of the storage.

storageQueueCount :: Storage -> Event Int Source #

Return the current queue length of the storage.

storageQueueCountStats :: Storage -> Event (TimingStats Int) Source #

Return the statistics for the queue length of the storage.

storageTotalWaitTime :: Storage -> Event Double Source #

Return the total wait time of the storage.

storageWaitTime :: Storage -> Event (SamplingStats Double) Source #

Return the statistics for the wait time of the storage.

storageAverageHoldingTime :: Storage -> Event Double Source #

Return the average holding time per unit.

Entering-Leaving Storage

enterStorage Source #

Arguments

:: Storage	the requested storage
-> Transact a	a transact that makes the request
-> Int	the content decrement
-> Process ()

Enter the storage.

leaveStorage Source #

Arguments

:: Storage	the storage to leave
-> Int	the content increment
-> Process ()

Leave the storage.

leaveStorageWithinEvent Source #

Arguments

:: Storage	the storage to leave
-> Int	the content increment
-> Event ()

Leave the storage.

Statistics Reset

resetStorage :: Storage -> Event () Source #

Reset the statistics.

Signals

storageContentChanged :: Storage -> Signal Int Source #

Signal triggered when the storageContent property changes.

storageContentChanged_ :: Storage -> Signal () Source #

Signal triggered when the storageContent property changes.

storageUseCountChanged :: Storage -> Signal Int Source #

Signal triggered when the storageUseCount property changes.

storageUseCountChanged_ :: Storage -> Signal () Source #

Signal triggered when the storageUseCount property changes.

storageUsedContentChanged :: Storage -> Signal Int Source #

Signal triggered when the storageUsedContent property changes.

storageUsedContentChanged_ :: Storage -> Signal () Source #

Signal triggered when the storageUsedContent property changes.

storageUtilisationCountChanged :: Storage -> Signal Int Source #

Signal triggered when the storageUtilisationCount property changes.

storageUtilisationCountChanged_ :: Storage -> Signal () Source #

Signal triggered when the storageUtilisationCount property changes.

storageQueueCountChanged :: Storage -> Signal Int Source #

Signal triggered when the storageQueueCount property changes.

storageQueueCountChanged_ :: Storage -> Signal () Source #

Signal triggered when the storageQueueCount property changes.

storageWaitTimeChanged :: Storage -> Signal (SamplingStats Double) Source #

Signal triggered when the storageTotalWaitTime and storageWaitTime properties change.

storageWaitTimeChanged_ :: Storage -> Signal () Source #

Signal triggered when the storageTotalWaitTime and storageWaitTime properties change.

storageChanged_ :: Storage -> Signal () Source #

Signal triggered when one of the storage counters changes.