io.engineblock.activityapi.core

Interface Action

All Known Subinterfaces:

MultiPhaseAction

All Known Implementing Classes:

CoreAction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Action

An action is the core logic that occurs within an activity. Within a thread slot, a motor will continuously ask an action to process its input.

Method Summary

Modifier and Type	Method and Description
default void	init()
int	runCycle(long value) Apply a work function to an input value, producing an int status code.

Method Detail

runCycle

int runCycle(long value)

Apply a work function to an input value, producing an int status code.

The meaning of status codes is activity specific, however the values Integer.MIN_VALUE, and Integer.MAX_VALUE are reserved.

Parameters:

value - a long input

Returns:

an int status

init

default void init()