Copyright	Copyright (c) 2009-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.Ref

Description

Tested with: GHC 8.0.1

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

Synopsis

data Ref a
refChanged :: Ref a -> Signal a
refChanged_ :: Ref a -> Signal ()
newRef :: a -> Simulation (Ref a)
readRef :: Ref a -> Event a
writeRef :: Ref a -> a -> Event ()
modifyRef :: Ref a -> (a -> a) -> Event ()

Documentation

data Ref a Source #

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

Instances details

ResultComputing Ref Source #
Instance details Defined in Simulation.Aivika.Results Methods computeResultData :: Ref a -> ResultData a Source # computeResultSignal :: Ref a -> ResultSignal Source #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (SamplingStats a))) => ResultProvider (Ref (SamplingCounter a)) Source #
Instance details Defined in Simulation.Aivika.Results Methods resultSource :: ResultName -> ResultDescription -> Ref (SamplingCounter a) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (SamplingCounter a) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (SamplingCounter a) -> ResultSource Source #
(ResultItemable (ResultValue a), ResultItemable (ResultValue (TimingStats a))) => ResultProvider (Ref (TimingCounter a)) Source #
Instance details Defined in Simulation.Aivika.Results Methods resultSource :: ResultName -> ResultDescription -> Ref (TimingCounter a) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (TimingCounter a) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (TimingCounter a) -> ResultSource Source #
(Ix i, Show i, ResultItemable (ResultValue [e])) => ResultProvider (Ref (Array i e)) Source #
Instance details Defined in Simulation.Aivika.Results Methods resultSource :: ResultName -> ResultDescription -> Ref (Array i e) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (Array i e) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (Array i e) -> ResultSource Source #
ResultItemable (ResultValue [e]) => ResultProvider (Ref (Vector e)) Source #
Instance details Defined in Simulation.Aivika.Results Methods resultSource :: ResultName -> ResultDescription -> Ref (Vector e) -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref (Vector e) -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref (Vector e) -> ResultSource Source #
ResultItemable (ResultValue a) => ResultProvider (Ref a) Source #
Instance details Defined in Simulation.Aivika.Results Methods resultSource :: ResultName -> ResultDescription -> Ref a -> ResultSource Source # resultSource3 :: ResultName -> ResultDescription -> ResultDescription -> Ref a -> ResultSource Source # resultSource' :: ResultName -> [ResultName] -> ResultId -> [ResultId] -> Ref a -> ResultSource Source #

refChanged :: Ref a -> Signal a Source #

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

refChanged_ :: Ref a -> Signal () Source #

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

newRef :: a -> Simulation (Ref a) Source #

Create a new reference.

readRef :: Ref a -> Event a Source #

Read the value of a reference.

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

Write a new value into the reference.

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

Mutate the contents of the reference.