Simulation.Aivika.Trans.Composite

Tested with: GHC 8.0.1

It defines the Composite monad transformer that allows constructing components which can be then destroyed in case of need.

Composite Monad

data Composite m a

It represents a composite which can be then destroyed in case of need.

Instances

MonadTrans Composite

Methods

lift :: Monad m => m a -> Composite m a

Monad m => MonadCompTrans Composite m

Methods

liftComp :: m a -> Composite m a

Monad m => ParameterLift Composite m

Methods

liftParameter :: Parameter m a -> Composite m a

Monad m => SimulationLift Composite m

Methods

liftSimulation :: Simulation m a -> Composite m a

Monad m => DynamicsLift Composite m

Methods

liftDynamics :: Dynamics m a -> Composite m a

Monad m => EventLift Composite m

Methods

liftEvent :: Event m a -> Composite m a

Monad m => CompositeLift Composite m

Methods

liftComposite :: Composite m a -> Composite m a

Monad m => Monad (Composite m)

Methods

(>>=) :: Composite m a -> (a -> Composite m b) -> Composite m b

(>>) :: Composite m a -> Composite m b -> Composite m b

return :: a -> Composite m a

fail :: String -> Composite m a

Monad m => Functor (Composite m)

Methods

fmap :: (a -> b) -> Composite m a -> Composite m b

(<$) :: a -> Composite m b -> Composite m a

(Monad m, MonadFix (Event m)) => MonadFix (Composite m)

Methods

mfix :: (a -> Composite m a) -> Composite m a

Monad m => Applicative (Composite m)

Methods

pure :: a -> Composite m a

(<*>) :: Composite m (a -> b) -> Composite m a -> Composite m b

(*>) :: Composite m a -> Composite m b -> Composite m b

(<*) :: Composite m a -> Composite m b -> Composite m a

(Monad m, MonadIO (Event m)) => MonadIO (Composite m)

Methods

liftIO :: IO a -> Composite m a

class CompositeLift t m where

A type class to lift the Composite computation to other computations.

Minimal complete definition

liftComposite

Methods

liftComposite :: Composite m a -> t m a

Lift the specified Composite computation to another computation.

Instances

Monad m => CompositeLift Composite m

Methods

liftComposite :: Composite m a -> Composite m a

runComposite :: Composite m a -> DisposableEvent m -> Event m (a, DisposableEvent m)

Run the computation returning the result and some DisposableEvent that being applied destroys the composite, for example, unsubscribes from signals or cancels the processes.

runComposite_ :: Monad m => Composite m a -> Event m a

Like runComposite but retains the composite parts during the simulation.

runCompositeInStartTime_ :: MonadDES m => Composite m a -> Simulation m a

Like runComposite_ but runs the computation in the start time.

runCompositeInStopTime_ :: MonadDES m => Composite m a -> Simulation m a

Like runComposite_ but runs the computation in the stop time.

disposableComposite :: Monad m => DisposableEvent m -> Composite m ()

When destroying the composite, the specified action will be applied.