Leave.hs

-- |
-- Module     : Simulation.Aivika.Trans.GPSS.Block.Leave
-- Copyright  : Copyright (c) 2017, David Sorokin <david.sorokin@gmail.com>
-- License    : BSD3
-- Maintainer : David Sorokin <david.sorokin@gmail.com>
-- Stability  : experimental
-- Tested with: GHC 8.0.2
--
-- This module defines the GPSS block LEAVE.
--
module Simulation.Aivika.Trans.GPSS.Block.Leave
       (leaveBlock) where

import Simulation.Aivika.Trans
import Simulation.Aivika.Trans.GPSS.Transact
import Simulation.Aivika.Trans.GPSS.Block
import Simulation.Aivika.Trans.GPSS.Storage

-- | This is the GPSS construct
--
-- @LEAVE A,B@
leaveBlock :: MonadDES m
              => Storage m
              -- ^ the storage
              -> Int
              -- ^ the content increment
              -> Block m (Transact m a) (Transact m a)
{-# INLINABLE leaveBlock #-}
leaveBlock r increment =
  Block { blockProcess = \a -> leaveStorage r increment >> return a }