Simulation.Aivika.Ref

Tested with: GHC 8.0.1

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

Documentation

data Ref 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

ResultComputing Ref

Defined in Simulation.Aivika.Results

Methods

computeResultData :: Ref a -> ResultData a

computeResultSignal :: Ref a -> ResultSignal

ResultItemable (ResultValue a) => ResultProvider (Ref a)

Defined in Simulation.Aivika.Results

Methods

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

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

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

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

Defined in Simulation.Aivika.Results

Methods

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

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

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

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

Defined in Simulation.Aivika.Results

Methods

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

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

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

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

Defined in Simulation.Aivika.Results

Methods

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

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

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

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

Defined in Simulation.Aivika.Results

Methods

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

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

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

refChanged :: Ref a -> Signal a

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

refChanged_ :: Ref a -> Signal ()

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

newRef :: a -> Simulation (Ref a)

Create a new reference.

readRef :: Ref a -> Event a

Read the value of a reference.

writeRef :: Ref a -> a -> Event ()

Write a new value into the reference.

modifyRef :: Ref a -> (a -> a) -> Event ()

Mutate the contents of the reference.