Package eu.bandm.sig.adlib2

Interface EnumSignalSource<E extends Enum<E>>

Type Parameters:

E - the enum type of the values of this signal source

All Superinterfaces:

AbstractSignalSource, CompilableDataFlow, IntSignalSource, IntSupplier

All Known Subinterfaces:

EnumClockedSignalSource<E>

All Known Implementing Classes:

CompilableEnumStoredSignalSource, EnumDelay, EnumSignalSourceChooser, EnumStoredSignalSource

public interface EnumSignalSource<E extends Enum<E>>
extends IntSignalSource

Interface of a signal source with enum values at construction time but ordinal int values at runtime.

See Also:

• Enum.ordinal()

Method Summary

Modifier and Type	Method	Description
default SignalSource<E>	box()
static <E extends Enum<E>> EnumSignalSource<E>	choose(BooleanSignalSource condition, EnumSignalSource<E> inTrue, EnumSignalSource<E> inFalse)
static <E extends Enum<E>, F extends Enum<F>> EnumSignalSource<F>	choose(EnumSignalSource<E> condition, EnumMap<E,? extends EnumSignalSource<F>> cases)	Returns a new signal source whose value is selected dynamically from a range of cases indexed by enum values.
default <A> SignalSource<A>	choose(EnumMap<E,? extends SignalSource<A>> cases)
default BooleanSignalSource	chooseBoolean(EnumMap<E,? extends BooleanSignalSource> cases)
default DoubleSignalSource	chooseDouble(EnumMap<E,? extends DoubleSignalSource> cases)
default <F extends Enum<F>> EnumSignalSource<F>	chooseEnum(EnumMap<E,? extends EnumSignalSource<F>> cases)
default FloatSignalSource	chooseFloat(EnumMap<E,? extends FloatSignalSource> cases)
default IntSignalSource	chooseInt(EnumMap<E,? extends IntSignalSource> cases)
default LongSignalSource	chooseLong(EnumMap<E,? extends LongSignalSource> cases)
static <E extends Enum<E>> EnumSignalSource<E>	constant(E value)	Returns a signal source whose value is constant (never changes).
Class<E>	getEnumClass()
static <E extends Enum<E>> EnumSignalSource<E>	of(Class<E> enumClass, SignalSource<E> body)
default EnumClockedSignalSource<E>	stored()	Returns a new signal source that stores snapshot values of this signal source driven by a clock.

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

compileDataFlowTo, hasDataFlowIO

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

abs, add, asInt, compileDataFlow, compileMainSignalSource, DEBUG, delayed, delayed, divide, equal, getAsInt, getConstantAsInt, getValueClass, greaterOrEqual, greaterThan, guard, hasConstantAsInt, invariant, lessOrEqual, lessThan, map, max, min, modulo, multiply, negate, negative, nonEqual, nonnegative, nonpositive, nonzero, positive, power, probe, publishStoredValueVariable, relateWith, sampleAndHold, subtract, zero, zipWith

Method Details

getEnumClass

Class<E> getEnumClass()

constant

static <E extends Enum<E>> EnumSignalSource<E> constant(E value)

Description copied from interface: IntSignalSource

Returns a signal source whose value is constant (never changes).

Parameters:

value - the value of the new signal source

Returns:

a signal source that always has the given value

of

static <E extends Enum<E>> EnumSignalSource<E> of(Class<E> enumClass,
 SignalSource<E> body)

box

default SignalSource<E> box()

stored

default EnumClockedSignalSource<E> stored()

Description copied from interface: IntSignalSource

Returns a new signal source that stores snapshot values of this signal source driven by a clock.

The IntSignalSource.getAsInt() method of the returned signal source is guaranteed to be extremely fast, both in interpreted and compiled mode. The computational effort of the underlying signal source is instead spent on the Process.step() method of the returned signal source, to be invoked at each clock tick.

If the underlying signal source is constant, the value is forwarded when the Process.init() method of the returned signal source is invoked, where as its implementation of Process.step() does nothing.

Specified by:

stored in interface IntSignalSource

Returns:

a new signal source that takes value snapshots of this signal source.

choose

default <A> SignalSource<A> choose(EnumMap<E,? extends SignalSource<A>> cases)

chooseEnum

default <F extends Enum<F>> EnumSignalSource<F> chooseEnum(EnumMap<E,? extends EnumSignalSource<F>> cases)

chooseFloat

default FloatSignalSource chooseFloat(EnumMap<E,? extends FloatSignalSource> cases)

chooseDouble

default DoubleSignalSource chooseDouble(EnumMap<E,? extends DoubleSignalSource> cases)

chooseInt

default IntSignalSource chooseInt(EnumMap<E,? extends IntSignalSource> cases)

chooseLong

default LongSignalSource chooseLong(EnumMap<E,? extends LongSignalSource> cases)

chooseBoolean

default BooleanSignalSource chooseBoolean(EnumMap<E,? extends BooleanSignalSource> cases)

choose

static <E extends Enum<E>,
F extends Enum<F>>
EnumSignalSource<F> choose(EnumSignalSource<E> condition,
 EnumMap<E,? extends EnumSignalSource<F>> cases)

Description copied from interface: IntSignalSource

Returns a new signal source whose value is selected dynamically from a range of cases indexed by enum values.

At any point in time, choose(s, m).getAsInt() == m.get(E.values()[s.getAsInt()]).getAsInt() holds.

The given map cases is assumed to be immutable and to contain an entry for every possible value of the enum type E.

Type Parameters:

E - the type of enum values

Parameters:

condition - the signal source that provides the ordinal number of the enum value

cases - a map of enum values to signal sources to select from

choose

static <E extends Enum<E>> EnumSignalSource<E> choose(BooleanSignalSource condition,
 EnumSignalSource<E> inTrue,
 EnumSignalSource<E> inFalse)