Simulation.Aivika.Signal

Tested with: GHC 8.0.1

This module defines the signal which we can subscribe handlers to. These handlers can be disposed. The signal is triggered in the current time point actuating the corresponded computations from the handlers.

Handling and Triggering Signal

data Signal a

The signal that can have disposable handlers.

Constructors

Signal

Fields

• handleSignal :: (a -> Event ()) -> Event DisposableEvent

  Subscribe the handler to the specified signal and return a nested computation within a disposable object that, being applied, unsubscribes the handler from this signal.

Instances

Functor Signal

Methods

fmap :: (a -> b) -> Signal a -> Signal b

(<$) :: a -> Signal b -> Signal a

Monoid (Signal a)

Methods

mempty :: Signal a

mappend :: Signal a -> Signal a -> Signal a

mconcat :: [Signal a] -> Signal a

handleSignal_ :: Signal a -> (a -> Event ()) -> Event ()

Subscribe the handler to the specified signal forever. To subscribe the disposable handlers, use function handleSignal.

handleSignalComposite :: Signal a -> (a -> Event ()) -> Composite ()

Like handleSignal but within the Composite computation.

data SignalSource a

The signal source that can publish its signal.

newSignalSource :: Simulation (SignalSource a)

Create a new signal source.

publishSignal :: SignalSource a -> Signal a

Publish the signal.

triggerSignal :: SignalSource a -> a -> Event ()

Trigger the signal actuating all its handlers at the current simulation time point.

Useful Combinators

mapSignal :: (a -> b) -> Signal a -> Signal b

Map the signal according the specified function.

mapSignalM :: (a -> Event b) -> Signal a -> Signal b

Compose the signal.

apSignal :: Event (a -> b) -> Signal a -> Signal b

Transform the signal.

filterSignal :: (a -> Bool) -> Signal a -> Signal a

Filter only those signal values that satisfy the specified predicate.

filterSignal_ :: (a -> Bool) -> Signal a -> Signal ()

Filter only those signal values that satisfy the specified predicate, but then ignoring the values.

filterSignalM :: (a -> Event Bool) -> Signal a -> Signal a

Filter only those signal values that satisfy the specified predicate.

filterSignalM_ :: (a -> Event Bool) -> Signal a -> Signal ()

Filter only those signal values that satisfy the specified predicate, but then ignoring the values.

emptySignal :: Signal a

An empty signal which is never triggered.

merge2Signals :: Signal a -> Signal a -> Signal a

Merge two signals.

merge3Signals :: Signal a -> Signal a -> Signal a -> Signal a

Merge three signals.

merge4Signals :: Signal a -> Signal a -> Signal a -> Signal a -> Signal a

Merge four signals.

merge5Signals :: Signal a -> Signal a -> Signal a -> Signal a -> Signal a -> Signal a

Merge five signals.

Signal Arriving

arrivalSignal :: Signal a -> Signal (Arrival a)

Transform a signal so that the resulting signal returns a sequence of arrivals saving the information about the time points at which the original signal was received.

Creating Signal in Time Points

newSignalInTimes :: [Double] -> Event (Signal Double)

Return a signal that is triggered in the specified time points.

newSignalInIntegTimes :: Event (Signal Double)

Return a signal that is triggered in the integration time points. It should be called with help of runEventInStartTime.

newSignalInStartTime :: Event (Signal Double)

Return a signal that is triggered in the start time. It should be called with help of runEventInStartTime.

newSignalInStopTime :: Event (Signal Double)

Return a signal that is triggered in the final time.

newSignalInTimeGrid :: Int -> Event (Signal Int)

Return a signal that is trigged in the grid by specified size.

Delaying Signal

delaySignal :: Double -> Signal a -> Signal a

Delay the signal values for the specified time interval.

delaySignalM :: Event Double -> Signal a -> Signal a

Delay the signal values for time intervals recalculated for each value.

Signal History

data SignalHistory a

Represents the history of the signal values.

signalHistorySignal :: SignalHistory a -> Signal a

The signal for which the history is created.

newSignalHistory :: Signal a -> Composite (SignalHistory a)

Create a history of the signal values.

newSignalHistoryStartingWith :: Maybe a -> Signal a -> Composite (SignalHistory a)

Create a history of the signal values starting with the optional initial value.

readSignalHistory :: SignalHistory a -> Event (Array Int Double, Array Int a)

Read the history of signal values.

Signalable Computations

data Signalable a

Describes a computation that also signals when changing its value.

Constructors

Signalable

Fields

• readSignalable :: Event a

  Return a computation of the value.

• signalableChanged_ :: Signal ()

  Return a signal notifying that the value has changed but without providing the information about the changed value.

Instances

Functor Signalable

Methods

fmap :: (a -> b) -> Signalable a -> Signalable b

(<$) :: a -> Signalable b -> Signalable a

ResultComputing Signalable

Methods

computeResultData :: Signalable a -> ResultData a

computeResultSignal :: Signalable a -> ResultSignal

Monoid a => Monoid (Signalable a)

Methods

mempty :: Signalable a

mappend :: Signalable a -> Signalable a -> Signalable a

mconcat :: [Signalable a] -> Signalable a

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

Methods

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

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

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

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

Methods

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

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

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

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

Methods

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

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

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

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

Methods

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

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

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

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

Methods

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

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

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

signalableChanged :: Signalable a -> Signal a

Return a signal notifying that the value has changed.

emptySignalable :: Monoid a => Signalable a

Return an identity.

appendSignalable :: Monoid a => Signalable a -> Signalable a -> Signalable a

An associative operation.

Debugging

traceSignal :: String -> Signal a -> Signal a

Show the debug message with the current simulation time.