eu.bandm.sig.adlib2

Class ConstantRealtimeContext

java.lang.Object

eu.bandm.sig.adlib2.RealtimeContext

eu.bandm.sig.adlib2.ConstantRealtimeContext

public abstract class ConstantRealtimeContext
extends RealtimeContext

Source of information about constant-rate realtime sampling control flow.

Instances of this class represent signal drivers that operate with constant sampling rate, that is the amount of model time passing between consecutive Realtime#step events is always the same, and known statically before the network is used.

Static sampling rate/period information may be used during the construction of a network for

1. choosing simpler non-adaptive variants of model time-sensitive computational components, and
2. ad-hoc optimizing adaptive variants of model time-sensitive computational components by propagation of the constant values.

Component factories and constructors should indicate that they support either of these construction-time optimizations by declaring a parameter of type Optional<ConstantRealtimeContext>. If they do, then the contract is, unless otherwise noted:

1. The factory or constructor yields a more efficiently implemented result if the parameter value is present than if it is empty.
2. In exchange, the obtained component must be passed the identical ConstantRealtimeContext object on all Realtime#step events, or otherwise model time inconsistency may occur. Note that, for efficiency reasons, this restriction may not be dynamically checked by the component.

Constructor Summary

Constructors

Constructor and Description
ConstantRealtimeContext()

Method Summary

Modifier and Type	Method and Description
static ConstantRealtimeContext	period(int period)
static ConstantRealtimeContext	period(IntFraction period)
static ConstantRealtimeContext	rate(int rate)
static ConstantRealtimeContext	rate(IntFraction rate)
ConstantRealtimeContext	slowdown(int slowdown)
ConstantRealtimeContext	slowdown(IntFraction slowdown)
ConstantRealtimeContext	speedup(int speedup)
ConstantRealtimeContext	speedup(IntFraction speedup)
static ConstantRealtimeContext	unit()

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

getSamplingPeriodAsDouble, getSamplingPeriodAsFloat, getSamplingPeriodAsInt, getSamplingPeriodAsLong, getSamplingPeriodPerRateAsInt, getSamplingPeriodPerRateAsLong, getSamplingRateAsDouble, getSamplingRateAsFloat, getSamplingRateAsInt, getSamplingRateAsLong, getSamplingRatePerPeriodAsInt, getSamplingRatePerPeriodAsLong, getSignalProbe, isRational, setSignalProbe

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantRealtimeContext

public ConstantRealtimeContext()

Method Detail

unit

public static ConstantRealtimeContext unit()

rate

public static ConstantRealtimeContext rate(int rate)

rate

public static ConstantRealtimeContext rate(IntFraction rate)

period

public static ConstantRealtimeContext period(int period)

period

public static ConstantRealtimeContext period(IntFraction period)

slowdown

public ConstantRealtimeContext slowdown(int slowdown)

slowdown

public ConstantRealtimeContext slowdown(IntFraction slowdown)

speedup

public ConstantRealtimeContext speedup(int speedup)

speedup

public ConstantRealtimeContext speedup(IntFraction speedup)