io.engineblock.activityapi

Interface Input

All Superinterfaces:

longIntervalSupplier, LongSupplier

All Known Implementing Classes:

LinkedInput, TargetRateInput

public interface Input
extends longIntervalSupplier

An Input is the core data source for feeding actions within an activity. Inputs are required to act as sequences at this level. They act as the dataflow control points for banks of motors and actions. As such, they must know their bounds.

Method Summary

Modifier and Type	Method and Description
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()

Method Detail

getMin

AtomicLong getMin()

Returns:

the minimum value to be provided by this input sequence.

getMax

AtomicLong getMax()

Returns:

the maximum value to be provided by this input sequence.

getCurrent

long getCurrent()

Returns:

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

getAsLong

long getAsLong()

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 getMax(), the motor should take this as a signal to terminate gracefully with a log line indicating why.

Specified by:

getAsLong in interface LongSupplier

Returns:

The next long value in the sequence

getInterval

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

Parameters:

stride - The width of the interval of numbers returned

Returns:

the first value of the interval