Simulation.Aivika.Trans.Ref

Tested with: GHC 8.0.1

This module defines an updatable reference that depends on the event queue.

Documentation

data Ref m a

The Ref type represents a mutable variable similar to the IORef variable but only dependent on the event queue, which allows synchronizing the reference with the model explicitly through the Event monad.

Instances

MonadDES m => ResultComputing Ref m

Methods

computeResultData :: Ref m a -> ResultData a m

computeResultSignal :: Ref m a -> ResultSignal m

(MonadDES m, Observable (Ref m) (t m)) => Observable (Ref m) (t m)

Methods

readObservable :: Ref m a -> t m a

MonadDES m => Eq (Ref m a)

Methods

(==) :: Ref m a -> Ref m a -> Bool

(/=) :: Ref m a -> Ref m a -> Bool

(MonadDES m, ResultItemable (ResultValue [e])) => ResultProvider (Ref m (Vector e)) m

Methods

resultSource :: ResultName -> ResultDescription -> Ref m (Vector e) -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref m (Vector e) -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref m (Vector e) -> ResultSource m

(Ix i, Show i, MonadDES m, ResultItemable (ResultValue [e])) => ResultProvider (Ref m (Array i e)) m

Methods

resultSource :: ResultName -> ResultDescription -> Ref m (Array i e) -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref m (Array i e) -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref m (Array i e) -> ResultSource m

(MonadDES m, ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Ref m (TimingCounter a)) m

Methods

resultSource :: ResultName -> ResultDescription -> Ref m (TimingCounter a) -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref m (TimingCounter a) -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref m (TimingCounter a) -> ResultSource m

(MonadDES m, ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Ref m (SamplingCounter a)) m

Methods

resultSource :: ResultName -> ResultDescription -> Ref m (SamplingCounter a) -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref m (SamplingCounter a) -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref m (SamplingCounter a) -> ResultSource m

(MonadDES m, ResultItemable (ResultValue a)) => ResultProvider (Ref m a) m

Methods

resultSource :: ResultName -> ResultDescription -> Ref m a -> ResultSource m

resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref m a -> ResultSource m

resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref m a -> ResultSource m

refChanged :: Ref m a -> Signal m a

Return a signal that notifies about every change of the reference state.

refChanged_ :: MonadDES m => Ref m a -> Signal m ()

Return a signal that notifies about every change of the reference state.

newRef :: MonadDES m => a -> Simulation m (Ref m a)

Create a new reference.

newRef0 :: (MonadDES m, MonadRef0 m) => a -> m (Ref m a)

Create a new reference within more low level computation than Simulation.

readRef :: MonadDES m => Ref m a -> Event m a

Read the value of a reference.

writeRef :: MonadDES m => Ref m a -> a -> Event m ()

Write a new value into the reference.

modifyRef :: MonadDES m => Ref m a -> (a -> a) -> Event m ()

Mutate the contents of the reference.