io.engineblock.activityimpl.motor

Class CoreMotor

java.lang.Object

io.engineblock.activityimpl.motor.CoreMotor

All Implemented Interfaces:

ActivityDefObserver, Motor, Stoppable, Runnable

public class CoreMotor
extends Object
implements ActivityDefObserver, Motor, Stoppable

ActivityMotor is a Runnable which runs in one of an activity's many threads. It is the iteration harness for individual cycles of an activity. Each ActivityMotor instance is responsible for taking input from a LongSupplier and applying the provided LongConsumer to it on each cycle. These two parameters are called input and action, respectively.

Constructor Summary

Constructors

Constructor and Description
CoreMotor(ActivityDef activityDef, long slotId, Input input) Create an ActivityMotor.
CoreMotor(ActivityDef activityDef, long slotId, Input input, Action action) Create an ActivityMotor.
CoreMotor(ActivityDef activityDef, long slotId, Input input, Action action, Output output) Create an ActivityMotor.

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.
void	onActivityDefUpdate(ActivityDef activityDef)
void	requestStop() Ask this component to stop cycling.
void	run()
Motor	setAction(Action action) Set the action for this ActivityMotor.
Motor	setInput(Input input) Set the input for this ActivityMotor.
void	setResultOutput(Output resultOutput)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreMotor

public CoreMotor(ActivityDef activityDef,
                 long slotId,
                 Input input)

Create an ActivityMotor.

Parameters:

activityDef - The activity def that this motor will be associated with.

slotId - The enumeration of the motor, as assigned by its executor.

input - A LongSupplier which provides the cycle number inputs.

CoreMotor

public CoreMotor(ActivityDef activityDef,
                 long slotId,
                 Input input,
                 Action action)

Create an ActivityMotor.

Parameters:

activityDef - The activity def that this motor is based on.

slotId - The enumeration of the motor, as assigned by its executor.

input - A LongSupplier which provides the cycle number inputs.

action - An LongConsumer which is applied to the input for each cycle.

CoreMotor

public CoreMotor(ActivityDef activityDef,
                 long slotId,
                 Input input,
                 Action action,
                 Output output)

Create an ActivityMotor.

Parameters:

activityDef - The activity def that this motor is based on.

slotId - The enumeration of the motor, as assigned by its executor.

input - A LongSupplier which provides the cycle number inputs.

action - An LongConsumer which is applied to the input for each cycle.

output - An optional tracker.

Method Detail

setInput

public Motor setInput(Input input)

Set the input for this ActivityMotor.

Specified by:

setInput in interface Motor

Parameters:

input - The LongSupplier that provides the cycle number.

Returns:

this ActivityMotor, for chaining

getInput

public Input getInput()

Specified by:

getInput in interface Motor

setAction

public Motor setAction(Action action)

Set the action for this ActivityMotor.

Specified by:

setAction in interface Motor

Parameters:

action - The LongConsumer that will be applied to the next cycle number.

Returns:

this ActivityMotor, for chaining

getAction

public Action getAction()

Specified by:

getAction in interface Motor

getSlotId

public long getSlotId()

Description copied from interface: Motor

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

Specified by:

getSlotId in interface Motor

Returns:

long slot id

getSlotStateTracker

public SlotStateTracker getSlotStateTracker()

Description copied from interface: Motor

Get a description of the current slot run status.

Specified by:

getSlotStateTracker in interface Motor

Returns:

- a value from the RunState enum

run

public void run()

Specified by:

run in interface Runnable

toString

public String toString()

Overrides:

toString in class Object

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

setResultOutput

public void setResultOutput(Output resultOutput)