io.engineblock.activityapi.core

Interface Motor

All Superinterfaces:

Runnable, Stoppable

All Known Implementing Classes:

CoreMotor

public interface Motor
extends Runnable, Stoppable

The core threading harness within an activity.

Method Summary

Modifier and Type	Method and Description
Action	getAction()
Input	getInput()
long	getSlotId() get the slotId which this motor is assigned to within the activity instance.
SlotStateTracker	getSlotStateTracker() Get a description of the current slot run status.
Motor	setAction(Action action) Set the action on this motor.
Motor	setInput(Input input) Set the input on this motor.

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface io.engineblock.activityapi.core.Stoppable

requestStop

Method Detail

setInput

Motor setInput(Input input)

Set the input on this motor. It will be read from each cycle before applying the action.

Parameters:

input - an instance of ActivityInput

Returns:

this ActivityMotor, for method chaining

getInput

Input getInput()

setAction

Motor setAction(Action action)

Set the action on this motor. It will be applied to each input.

Parameters:

action - an instance of activityAction

Returns:

this ActivityMotor, for method chaining

getAction

Action getAction()

getSlotId

long getSlotId()

get the slotId which this motor is assigned to within the activity instance.

Returns:

long slot id

getSlotStateTracker

SlotStateTracker getSlotStateTracker()

Get a description of the current slot run status.

Returns:

- a value from the RunState enum