io.engineblock.activityapi.core

Interface Activity

All Superinterfaces:

ActivityDefObserver, Comparable<Activity>

All Known Implementing Classes:

SimpleActivity

public interface Activity
extends Comparable<Activity>, ActivityDefObserver

Provides the components needed to build and run an activity a runtime. The easiest way to build a useful Activity is to extend SimpleActivity.

Method Summary

Modifier and Type	Method and Description
void	closeAutoCloseables() Close all autocloseables that have been registered with this Activity.
ActionDispenser	getActionDispenserDelegate()
ActivityController	getActivityController()
ActivityDef	getActivityDef()
default String	getAlias()
RateLimiter	getCycleLimiter() Get the current cycle rate limiter for this activity.
RateLimiter	getCycleRateLimiter(Supplier<? extends RateLimiter> supplier) Get or create the cycle rate limiter in a safe way.
default String	getCycleSummary()
InputDispenser	getInputDispenserDelegate()
OutputDispenser	getMarkerDispenserDelegate()
MotorDispenser	getMotorDispenserDelegate()
default ParameterMap	getParams()
RateLimiter	getPhaseLimiter() Get the current phase rate limiter for this activity.
RateLimiter	getPhaseRateLimiter(Supplier<? extends RateLimiter> supplier) Get or create the phase RateLimiter in a concurrent-safe way.
IntPredicateDispenser	getResultFilterDispenserDelegate()
RunState	getRunState()
RateLimiter	getStrideLimiter() Get the current stride rate limiter for this activity.
RateLimiter	getStrideRateLimiter(Supplier<? extends RateLimiter> supplier) Get or create the stride RateLimiter in a concurrent-safe way.
default void	initActivity()
void	registerAutoCloseable(AutoCloseable closeable) Register an object which should be closed after this activity is shutdown.
void	setActionDispenserDelegate(ActionDispenser actionDispenser)
void	setActivityController(ActivityController activityController) Provide the activity with the controls needed to stop itself.
void	setCycleLimiter(RateLimiter rateLimiter) Set the cycle rate limiter for this activity.
void	setInputDispenserDelegate(InputDispenser inputDispenser)
void	setMotorDispenserDelegate(MotorDispenser motorDispenser)
void	setOutputDispenserDelegate(OutputDispenser outputDispenser)
void	setPhaseLimiter(RateLimiter rateLimiter) Set the phase rate limiter for this activity.
void	setResultFilterDispenserDelegate(IntPredicateDispenser resultFilterDispenser)
void	setRunState(RunState runState)
void	setStrideLimiter(RateLimiter rateLimiter) Set the stride rate limiter for this activity.
default void	shutdownActivity()

Methods inherited from interface java.lang.Comparable

compareTo

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

onActivityDefUpdate

Method Detail

setActivityController

void setActivityController(ActivityController activityController)

Provide the activity with the controls needed to stop itself.

Parameters:

activityController - The dedicated control interface for this activity

getActivityController

ActivityController getActivityController()

registerAutoCloseable

void registerAutoCloseable(AutoCloseable closeable)

Register an object which should be closed after this activity is shutdown.

Parameters:

closeable - An Autocloseable object

getActivityDef

ActivityDef getActivityDef()

getAlias

default String getAlias()

getParams

default ParameterMap getParams()

initActivity

default void initActivity()

closeAutoCloseables

void closeAutoCloseables()

Close all autocloseables that have been registered with this Activity.

getMotorDispenserDelegate

MotorDispenser getMotorDispenserDelegate()

setMotorDispenserDelegate

void setMotorDispenserDelegate(MotorDispenser motorDispenser)

getInputDispenserDelegate

InputDispenser getInputDispenserDelegate()

setInputDispenserDelegate

void setInputDispenserDelegate(InputDispenser inputDispenser)

getActionDispenserDelegate

ActionDispenser getActionDispenserDelegate()

setActionDispenserDelegate

void setActionDispenserDelegate(ActionDispenser actionDispenser)

getResultFilterDispenserDelegate

IntPredicateDispenser getResultFilterDispenserDelegate()

setResultFilterDispenserDelegate

void setResultFilterDispenserDelegate(IntPredicateDispenser resultFilterDispenser)

getMarkerDispenserDelegate

OutputDispenser getMarkerDispenserDelegate()

setOutputDispenserDelegate

void setOutputDispenserDelegate(OutputDispenser outputDispenser)

getRunState

RunState getRunState()

setRunState

void setRunState(RunState runState)

shutdownActivity

default void shutdownActivity()

getCycleSummary

default String getCycleSummary()

getCycleLimiter

RateLimiter getCycleLimiter()

Get the current cycle rate limiter for this activity. The cycle rate limiter is used to throttle the rate at which cycles are dispatched across all threads in the activity

Returns:

the cycle RateLimiter

setCycleLimiter

void setCycleLimiter(RateLimiter rateLimiter)

Set the cycle rate limiter for this activity. This method should only be used in a non-concurrent context. Otherwise, the supplier version getCycleRateLimiter(Supplier) should be used.

Parameters:

rateLimiter - The cycle RateLimiter for this activity

getCycleRateLimiter

RateLimiter getCycleRateLimiter(Supplier<? extends RateLimiter> supplier)

Get or create the cycle rate limiter in a safe way. Implementations should ensure that this method is synchronized or that each requestor gets the same cycle rate limiter for the activity.

Parameters:

supplier - A RateLimiter Supplier

Returns:

An extant or newly created cycle RateLimiter

getStrideLimiter

RateLimiter getStrideLimiter()

Get the current stride rate limiter for this activity. The stride rate limiter is used to throttle the rate at which new strides are dispatched across all threads in an activity.

Returns:

The stride RateLimiter

setStrideLimiter

void setStrideLimiter(RateLimiter rateLimiter)

Set the stride rate limiter for this activity. This method should only be used in a non-concurrent context. Otherwise, the supplier version getStrideRateLimiter(Supplier)} should be used.

Parameters:

rateLimiter - The stride RateLimiter for this activity.

getStrideRateLimiter

RateLimiter getStrideRateLimiter(Supplier<? extends RateLimiter> supplier)

Get or create the stride RateLimiter in a concurrent-safe way. Implementations should ensure that this method is synchronized or that each requestor gets the same stride rate limiter for the activity.

Parameters:

supplier - A RateLimiter Supplier

Returns:

An extant or newly created stride RateLimiter

getPhaseLimiter

RateLimiter getPhaseLimiter()

Get the current phase rate limiter for this activity. The phase rate limiter is used to throttle the rate at which new phases are dispatched across all threads in an activity.

Returns:

The stride RateLimiter

setPhaseLimiter

void setPhaseLimiter(RateLimiter rateLimiter)

Set the phase rate limiter for this activity. This method should only be used in a non-concurrent context. Otherwise, the supplier version getPhaseRateLimiter(Supplier)} should be used.

Parameters:

rateLimiter - The phase RateLimiter for this activity.

getPhaseRateLimiter

RateLimiter getPhaseRateLimiter(Supplier<? extends RateLimiter> supplier)

Get or create the phase RateLimiter in a concurrent-safe way. Implementations should ensure that this method is synchronized or that each requestor gets the same phase rate limiter for the activity.

Parameters:

supplier - A RateLimiter Supplier

Returns:

An extant or newly created phase RateLimiter