eu.bandm.sig.adlib2

Class BooleanSignalPort

java.lang.Object

eu.bandm.sig.adlib2.BooleanSignalPort

All Implemented Interfaces:

AbstractSignalSource, BooleanSignalSource, CompilableDataFlow, BooleanSupplier

public class BooleanSignalPort
extends Object
implements BooleanSignalSource

A receptacle for a signal source than can be plugged at runtime, even if compiled.

An instance of this class, when used directly, acts as a dynamic proxy that delegates all method invocations to a pluggable input signal source. The currently plugged input is looked up via getInput() at every delegation event, such that re-plugging via setInput(BooleanSignalSource) has immediate effect.

If an instance of this class is compiled, usually as a subcomponent of a complex signal network, then the compiled code shares the pluggable state of the original orig, and will dynamically delegate to the input signal source returned by orig.getInput(). Thus even complex network modules with multiple inputs and outputs can be compiled to monolithic code, but configured dynamically, by

1. creating an interpreted version of the module with inputs realized as ports, i.e. instances of BooleanSignalSource and its companion classes,
2. compiling the module,
3. retaining references to the ports,
4. plugging the actual inputs into the ports,
5. using the output signal sources of the compiled version in place of the interpreted one.

The pluggable input signal source can be set to null, which will cause the getAsBoolean() method of this object to fail at runtime with NullPointerException.

Constructor Summary

Constructors

Constructor and Description
BooleanSignalPort() Creates a new instance with no specified initial input.
BooleanSignalPort(BooleanSignalSource input) Creates a new instance with the specified initial input.

Method Summary

Modifier and Type	Method and Description
Consumer<CompilationContext>	compileDataFlow() Returns a code generator for outputting the value of this entity.
boolean	getAsBoolean() Returns the current value of this signal source.
BooleanSignalSource	getInput() Returns the current input signal source.
void	setInput(BooleanSignalSource input) Sets the current input signal source.

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.BooleanSignalSource

and, becoming, ceasing, choose, choose, choose, choose, choose, choose, choose, choose, choose, choose, choose, clock, compileMainSignalSource, constant, delayed, delayed, delayedFeedback, delayedFeedback, getConstantAsBoolean, getValueClass, guard, hasConstantAsBoolean, invariant, map, not, or, power, probe, publishStoredValueVariable, relateWith, sampleAndHold, stored, xor, zipWith

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

compileDataFlowTo, hasDataFlowIO

Constructor Detail

BooleanSignalPort

public BooleanSignalPort()

Creates a new instance with no specified initial input.

BooleanSignalPort

public BooleanSignalPort(BooleanSignalSource input)

Creates a new instance with the specified initial input.

Parameters:

input - the input signal source

Method Detail

getInput

public BooleanSignalSource getInput()

Returns the current input signal source.

setInput

public void setInput(BooleanSignalSource input)

Sets the current input signal source.

getAsBoolean

public boolean getAsBoolean()

Returns the current value of this signal source.

The value may be either computed on demand, or retrieved from storage.

Implementations of this method should have no side effect.

This implementation always delegates to getInput().getAsBoolean().

Specified by:

getAsBoolean in interface BooleanSignalSource

Specified by:

getAsBoolean in interface BooleanSupplier

Returns:

the current value of this signal source

compileDataFlow

public Consumer<CompilationContext> compileDataFlow()

Description copied from interface: BooleanSignalSource

Returns a code generator for outputting the value of this entity.

This implementation generates code to invoke this.getAsBoolean().

Specified by:

compileDataFlow in interface BooleanSignalSource

Specified by:

compileDataFlow in interface CompilableDataFlow