eu.bandm.sig.adlib2

Class Delay<A>

java.lang.Object

eu.bandm.sig.adlib2.StoredSignalSource<A>

eu.bandm.sig.adlib2.compile.CompilableStoredSignalSource<A>

eu.bandm.sig.adlib2.Delay<A>

Type Parameters:

A - the type of values produced by this signal source

All Implemented Interfaces:

AbstractClockedSignalSource, AbstractSignalSource, ClockedSignalSource<A>, CompilableControlFlow, CompilableDataFlow, Component, Process, Register, SignalSource<A>, Supplier<A>

public class Delay<A>
extends CompilableStoredSignalSource<A>
implements Register

A component that forwards the value from an input signal source delayed by a single clock tick.

Nested Class Summary

Nested classes/interfaces inherited from interface eu.bandm.sig.adlib2.Process

Process.Proxy

Field Summary

Fields inherited from class eu.bandm.sig.adlib2.StoredSignalSource

out, valueClass

Fields inherited from interface eu.bandm.sig.adlib2.AbstractClockedSignalSource

STREAM_CHARACTERISTICS, STREAM_SIZE

Constructor Summary

Constructors

Constructor and Description
Delay(Class<? super A> valueClass, A initial) Creates a new instance without a valid input source.
Delay(Class<? super A> valueClass, A initial, Function<? super Delay<A>,? extends SignalSource<A>> in) Creates a new instance with a feedback-looped input source.
Delay(Class<? super A> valueClass, A initial, SignalSource<A> in) Creates a new instance with an independent input source.

Method Summary

Modifier and Type	Method and Description
Consumer<CompilationContext>	compileControlFlow() Compiles the state transition of this entity.
Consumer<CompilationContext>	compileGetNextValue() Returns a code generator for loading the next value of the compiled version of this component on the operand stack.
Consumer<CompilationContext>	compileInitialization() Compiles the initialization of this entity.
Consumer<CompilationContext>	compileSetNextValue(Consumer<CompilationContext> value) Returns a code generator for storing the next value of the compiled version of this component from the operand stack.
Process	getLoadPhase()
A	getNextValue() Returns the value that will be produced on the next clock tick.
protected VariableContext.Variable	getNextVariable(CompilationContext context)
Process	getStorePhase()
void	init() Initializes the state of this process.
void	setInput(SignalSource<A> in)
void	setNextValue(A next) Sets the value that will be produced on the next clock tick.
void	step(RealtimeContext context) Signals a time event, executing a transition step for this process to the next observable state.

Methods inherited from class eu.bandm.sig.adlib2.compile.CompilableStoredSignalSource

compileDataFlow, compileSetStoredValueVariable, getStoredValueVariable, publishStoredValueVariable

Methods inherited from class eu.bandm.sig.adlib2.StoredSignalSource

get, getValueClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface eu.bandm.sig.adlib2.Register

andMeanwhile, andMeanwhile

Methods inherited from interface eu.bandm.sig.adlib2.ClockedSignalSource

adHoc, after, compile, cycle, during, ofSpliterator, ofStream, ofStream, spliterator, stream

Methods inherited from interface eu.bandm.sig.adlib2.SignalSource

choose, choose, choose, choose, clock, compileMainSignalSource, constant, constant, delayed, delayed, delayedFeedback, delayedFeedback, eq, getConstant, guard, hasConstant, invariant, map, map, neq, power, probe, relateWith, sampleAndHold, stored, zipWith

Methods inherited from interface eu.bandm.sig.adlib2.compile.CompilableDataFlow

compileDataFlowTo, hasDataFlowIO

Methods inherited from interface eu.bandm.sig.adlib2.Process

afterEvery, andThen, compileAsMainProcess, every, getProcess, hasControlFlowIO, hasInitializationIO, probe, sequence, sequence

Constructor Detail

Delay

public Delay(Class<? super A> valueClass,
             A initial)

Creates a new instance without a valid input source. The method setInput(eu.bandm.sig.adlib2.SignalSource<A>) must be invoked before this signal source can be used.

Parameters:

initial - the initial value of this signal source

Delay

public Delay(Class<? super A> valueClass,
             A initial,
             SignalSource<A> in)

Creates a new instance with an independent input source.

Parameters:

initial - the initial value of this signal source

in - the input signal source

Delay

public Delay(Class<? super A> valueClass,
             A initial,
             Function<? super Delay<A>,? extends SignalSource<A>> in)

Creates a new instance with a feedback-looped input source.

Parameters:

initial - the initial value of this signal source

in - a function that constructs the input signal source when applied to this delayed signal source

Method Detail

setInput

public void setInput(SignalSource<A> in)

getLoadPhase

public Process getLoadPhase()

Specified by:

getLoadPhase in interface Register

getStorePhase

public Process getStorePhase()

Specified by:

getStorePhase in interface Register

init

public void init()

Description copied from interface: Process

Initializes the state of this process. The state is initialized such that the first subsequent call to Process.step(RealtimeContext) transitions to the first specified observable state.

The default implementation does nothing.

Specified by:

init in interface Process

step

public void step(RealtimeContext context)

Description copied from interface: Process

Signals a time event, executing a transition step for this process to the next observable state.

The state of the process after successful completion of this method should be the n-th observable state, if Process.step(eu.bandm.sig.adlib2.RealtimeContext) has been invoked n times since the last initialization via Process.init(). The behavior of this method is unspecified if Process.init() has not been invoked before.

If this method completes abruptly by throwing an error or unchecked exception, the process state should be considered invalid.

Specified by:

step in interface Process

Parameters:

context - the realtime context information for this step

getNextVariable

protected VariableContext.Variable getNextVariable(CompilationContext context)

compileInitialization

public Consumer<CompilationContext> compileInitialization()

Description copied from interface: CompilableControlFlow

Compiles the initialization of this entity.

Specified by:

compileInitialization in interface CompilableControlFlow

Specified by:

compileInitialization in interface Process

Overrides:

compileInitialization in class CompilableStoredSignalSource<A>

See Also:

Process.hasInitializationIO(eu.bandm.sig.adlib2.compile.CompilationContext)

compileControlFlow

public Consumer<CompilationContext> compileControlFlow()

Description copied from interface: CompilableControlFlow

Compiles the state transition of this entity.

Specified by:

compileControlFlow in interface CompilableControlFlow

Specified by:

compileControlFlow in interface Process

Specified by:

compileControlFlow in class CompilableStoredSignalSource<A>

See Also:

Process.hasControlFlowIO(eu.bandm.sig.adlib2.compile.CompilationContext)

getNextValue

public A getNextValue()

Returns the value that will be produced on the next clock tick.

This method is in concurrent reader–writer conflict with the getStorePhase() process.

compileGetNextValue

public Consumer<CompilationContext> compileGetNextValue()

Returns a code generator for loading the next value of the compiled version of this component on the operand stack.

See Also:

getNextValue()

setNextValue

public void setNextValue(A next)

Sets the value that will be produced on the next clock tick.

This method is in concurrent writer–writer conflict with the getStorePhase() process.

compileSetNextValue

public Consumer<CompilationContext> compileSetNextValue(Consumer<CompilationContext> value)

Returns a code generator for storing the next value of the compiled version of this component from the operand stack.

See Also:

setNextValue(A)