FRP.Rhine.Reactimation.Tick

Documentation

data Tickable m cla clb cl clc cld a b c d

A signal function (SF) enclosed by matching ResamplingBuffers and further auxiliary data, such that it can be stepped with each arriving tick from a clock cl. They play a similar role like ReactHandles in dunai.

The type parameters:

• m: The monad in which the SF and the ResamplingBuffers produce side effects
• cla: The (irrelevant) input clock of the left ResamplingBuffer
• clb: The clock at which the left ResamplingBuffer produces output
• cl: The clock at which the SF ticks
• clc: The clock at which the right ResamplingBuffer accepts input
• cld: The (irrelevant) output clock of the right ResamplingBuffer
• a: The (irrelevant) input type of the left ResamplingBuffer
• b: The input type of the SF
• c: The output type of the SF
• d: The (irrelevant) output type of the right ResamplingBuffer

Constructors

Tickable

Fields

• buffer1 :: ResamplingBuffer m cla clb a b

  The left buffer from which the input is taken.

• ticksf :: SF m cl b c

  The signal function that will process the data.

• buffer2 :: ResamplingBuffer m clc cld c d

  The right buffer in which the output is stored.

• parClockInL :: ParClockInclusion (Leftmost cl) clb

  The leftmost clock of the signal function, cl, may be a parallel subclock of the buffer clock. parClockInL specifies in which position 'Leftmost cl' is a parallel subclock of clb.

• parClockInR :: ParClockInclusion (Rightmost cl) clc

  The same on the output side.

• lastTime :: LastTime cl

  The last times when the different parts of the signal tree have ticked.

• initTime :: TimeDomainOf cl

  The time when the whole clock was initialised.

initLastTime :: SF m cl a b -> TimeDomainOf cl -> LastTime cl

Initialise the tree of last tick times.

createTickable :: ResamplingBuffer m cla (Leftmost cl) a b -> SF m cl b c -> ResamplingBuffer m (Rightmost cl) cld c d -> TimeDomainOf cl -> Tickable m cla (Leftmost cl) cl (Rightmost cl) cld a b c d

Initialise a Tickable from a signal function, two matching enclosing resampling buffers and an initial time.

tick

Arguments

:: (Monad m, Clock m cl, TimeDomainOf cla ~ TimeDomainOf cl, TimeDomainOf clb ~ TimeDomainOf cl, TimeDomainOf clc ~ TimeDomainOf cl, TimeDomainOf cld ~ TimeDomainOf cl, TimeDomainOf (Leftmost cl) ~ TimeDomainOf cl, TimeDomainOf (Rightmost cl) ~ TimeDomainOf cl)

=> Tickable m cla clb cl clc cld a b c d

-> TimeDomainOf cl

Timestamp of the present tick

-> Tag cl

Tag of the overall clock; contains the information which subsystem will become active

-> m (Tickable m cla clb cl clc cld a b c d)

In this function, one tick, or step of an asynchronous signal function happens. The TimeInfo holds the information which part of the signal tree will tick. This information is encoded in the Tag of the TimeInfo, which is of type 'Either tag1 tag2' in case of a SequentialClock or a ParallelClock, encoding either a tick for the left clock or the right clock.

trivialResamplingBuffer :: Monad m => cl -> ResamplingBuffer m (Rightmost cl) (Leftmost cl) () ()

A ResamplingBuffer producing only units. (Slightly more efficient and direct implementation than the one in Timeless that additionally unifies the clock types in a way needed for the tick implementation.)