io.engineblock.activityimpl.input

Class LinkedInput

java.lang.Object

io.engineblock.activityimpl.input.LinkedInput

All Implemented Interfaces:

ActivityDefObserver, Input, longIntervalSupplier, Stoppable, LongSupplier

public class LinkedInput
extends Object
implements Input, ActivityDefObserver, Stoppable

Constructor Summary

Constructors

Constructor and Description
LinkedInput(ActivityDef activityDef, Input linkedInput)

Method Summary

Modifier and Type	Method and Description
protected boolean	canAdvance() for testing
long	getAsLong() For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value.
long	getCurrent()
long	getInterval(long stride) For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value.
AtomicLong	getMax()
AtomicLong	getMin()
void	onActivityDefUpdate(ActivityDef activityDef)
void	requestStop() Ask this component to stop cycling.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkedInput

public LinkedInput(ActivityDef activityDef,
                   Input linkedInput)

Method Detail

getMin

public AtomicLong getMin()

Specified by:

getMin in interface Input

Returns:

the minimum value to be provided by this input sequence.

getMax

public AtomicLong getMax()

Specified by:

getMax in interface Input

Returns:

the maximum value to be provided by this input sequence.

getCurrent

public long getCurrent()

Specified by:

getCurrent in interface Input

Returns:

the current value of the atomic register used by this input.

getAsLong

public long getAsLong()

Description copied from interface: Input

For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value. When the value exceeds the the value provided by Input.getMax(), the motor should take this as a signal to terminate gracefully with a log line indicating why.

Specified by:

getAsLong in interface Input

Specified by:

getAsLong in interface LongSupplier

Returns:

The next long value in the sequence

getInterval

public long getInterval(long stride)

Description copied from interface: Input

For the sake of efficiency, ActivityMotors that consume values from this interface should do a range check after getting the value. When the value exceeds the value provided by getMax, the motor should take this as a signal to terminate gracefullly with a log line indicating why.

Specified by:

getInterval in interface Input

Specified by:

getInterval in interface longIntervalSupplier

Parameters:

stride - The width of the interval of numbers returned

Returns:

the first value of the interval

canAdvance

protected boolean canAdvance()

for testing

Returns:

true, if this input could advance according to the linked input

onActivityDefUpdate

public void onActivityDefUpdate(ActivityDef activityDef)

Specified by:

onActivityDefUpdate in interface ActivityDefObserver

requestStop

public void requestStop()

Description copied from interface: Stoppable

Ask this component to stop cycling. This is an asynchronous request. Once the current active cycle completes, the request will cause the component to stop cooperatively.

Specified by:

requestStop in interface Stoppable