Package io.engineblock.activityimpl

Class SimpleActivity

java.lang.Object

io.engineblock.activityimpl.SimpleActivity

All Implemented Interfaces:

Activity, ActivityDefObserver, java.lang.Comparable<Activity>

public class SimpleActivity
extends java.lang.Object
implements Activity

A default implementation of an Activity, suitable for building upon.

Field Summary

Fields

Modifier and Type	Field	Description
protected ActivityDef	activityDef

Constructor Summary

Constructors

Constructor	Description
SimpleActivity(ActivityDef activityDef)
SimpleActivity(java.lang.String activityDefString)

Method Summary

Modifier and Type	Method	Description
void	closeAutoCloseables()	Close all autocloseables that have been registered with this Activity.
int	compareTo(Activity o)
ActionDispenser	getActionDispenserDelegate()
ActivityController	getActivityController()
ActivityDef	getActivityDef()
RateLimiter	getCycleLimiter()	Get the current cycle rate limiter for this activity.
RateLimiter	getCycleRateLimiter(java.util.function.Supplier<? extends RateLimiter> s)	Get or create the cycle rate limiter in a safe way.
InputDispenser	getInputDispenserDelegate()
ActivityInstrumentation	getInstrumentation()	Get or create the instrumentation needed for this activity.
OutputDispenser	getMarkerDispenserDelegate()
MotorDispenser	getMotorDispenserDelegate()
RateLimiter	getPhaseLimiter()	Get the current phase rate limiter for this activity.
RateLimiter	getPhaseRateLimiter(java.util.function.Supplier<? extends RateLimiter> supplier)	Get or create the phase RateLimiter in a concurrent-safe way.
IntPredicateDispenser	getResultFilterDispenserDelegate()
com.codahale.metrics.Timer	getResultTimer()
RunState	getRunState()
RateLimiter	getStrideLimiter()	Get the current stride rate limiter for this activity.
RateLimiter	getStrideRateLimiter(java.util.function.Supplier<? extends RateLimiter> s)	Get or create the stride RateLimiter in a concurrent-safe way.
void	initActivity()
void	onActivityDefUpdate(ActivityDef activityDef)
void	registerAutoCloseable(java.lang.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	setDefaultsFromOpSequence(OpSequence seq)	Modify the provided ActivityDef with defaults for stride and cycles, if they haven't been provided, based on the length of the sequence as determined by the provided ratios.
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

getAlias, getCycleSummary, getParams, shutdownActivity

Field Detail

activityDef

protected ActivityDef activityDef

Constructor Detail

SimpleActivity

public SimpleActivity(ActivityDef activityDef)

SimpleActivity

public SimpleActivity(java.lang.String activityDefString)

Method Detail

initActivity

public void initActivity()

Specified by:

initActivity in interface Activity

getRunState

public RunState getRunState()

Specified by:

getRunState in interface Activity

setRunState

public void setRunState(RunState runState)

Specified by:

setRunState in interface Activity

getMotorDispenserDelegate

public final MotorDispenser getMotorDispenserDelegate()

Specified by:

getMotorDispenserDelegate in interface Activity

setMotorDispenserDelegate

public final void setMotorDispenserDelegate(MotorDispenser motorDispenser)

Specified by:

setMotorDispenserDelegate in interface Activity

getInputDispenserDelegate

public final InputDispenser getInputDispenserDelegate()

Specified by:

getInputDispenserDelegate in interface Activity

setInputDispenserDelegate

public final void setInputDispenserDelegate(InputDispenser inputDispenser)

Specified by:

setInputDispenserDelegate in interface Activity

getActionDispenserDelegate

public final ActionDispenser getActionDispenserDelegate()

Specified by:

getActionDispenserDelegate in interface Activity

setActionDispenserDelegate

public final void setActionDispenserDelegate(ActionDispenser actionDispenser)

Specified by:

setActionDispenserDelegate in interface Activity

getResultFilterDispenserDelegate

public IntPredicateDispenser getResultFilterDispenserDelegate()

Specified by:

getResultFilterDispenserDelegate in interface Activity

setResultFilterDispenserDelegate

public void setResultFilterDispenserDelegate(IntPredicateDispenser resultFilterDispenser)

Specified by:

setResultFilterDispenserDelegate in interface Activity

getMarkerDispenserDelegate

public OutputDispenser getMarkerDispenserDelegate()

Specified by:

getMarkerDispenserDelegate in interface Activity

setOutputDispenserDelegate

public void setOutputDispenserDelegate(OutputDispenser outputDispenser)

Specified by:

setOutputDispenserDelegate in interface Activity

getActivityDef

public ActivityDef getActivityDef()

Specified by:

getActivityDef in interface Activity

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Activity o)

Specified by:

compareTo in interface java.lang.Comparable<Activity>

getActivityController

public ActivityController getActivityController()

Specified by:

getActivityController in interface Activity

setActivityController

public void setActivityController(ActivityController activityController)

Description copied from interface: Activity

Provide the activity with the controls needed to stop itself.

Specified by:

setActivityController in interface Activity

Parameters:

activityController - The dedicated control interface for this activity

registerAutoCloseable

public void registerAutoCloseable(java.lang.AutoCloseable closeable)

Description copied from interface: Activity

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

Specified by:

registerAutoCloseable in interface Activity

Parameters:

closeable - An Autocloseable object

closeAutoCloseables

public void closeAutoCloseables()

Description copied from interface: Activity

Close all autocloseables that have been registered with this Activity.

Specified by:

closeAutoCloseables in interface Activity

getCycleLimiter

public RateLimiter getCycleLimiter()

Description copied from interface: Activity

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

Specified by:

getCycleLimiter in interface Activity

Returns:

the cycle RateLimiter

setCycleLimiter

public void setCycleLimiter(RateLimiter rateLimiter)

Description copied from interface: Activity

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

Specified by:

setCycleLimiter in interface Activity

Parameters:

rateLimiter - The cycle RateLimiter for this activity

getCycleRateLimiter

public RateLimiter getCycleRateLimiter(java.util.function.Supplier<? extends RateLimiter> s)

Description copied from interface: Activity

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

Specified by:

getCycleRateLimiter in interface Activity

Parameters:

s - A RateLimiter Supplier

Returns:

An extant or newly created cycle RateLimiter

getStrideLimiter

public RateLimiter getStrideLimiter()

Description copied from interface: Activity

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.

Specified by:

getStrideLimiter in interface Activity

Returns:

The stride RateLimiter

setStrideLimiter

public void setStrideLimiter(RateLimiter rateLimiter)

Description copied from interface: Activity

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

Specified by:

setStrideLimiter in interface Activity

Parameters:

rateLimiter - The stride RateLimiter for this activity.

getStrideRateLimiter

public RateLimiter getStrideRateLimiter(java.util.function.Supplier<? extends RateLimiter> s)

Description copied from interface: Activity

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

Specified by:

getStrideRateLimiter in interface Activity

Parameters:

s - A RateLimiter Supplier

Returns:

An extant or newly created stride RateLimiter

getPhaseLimiter

public RateLimiter getPhaseLimiter()

Description copied from interface: Activity

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.

Specified by:

getPhaseLimiter in interface Activity

Returns:

The stride RateLimiter

getResultTimer

public com.codahale.metrics.Timer getResultTimer()

Specified by:

getResultTimer in interface Activity

setPhaseLimiter

public void setPhaseLimiter(RateLimiter rateLimiter)

Description copied from interface: Activity

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

Specified by:

setPhaseLimiter in interface Activity

Parameters:

rateLimiter - The phase RateLimiter for this activity.

getPhaseRateLimiter

public RateLimiter getPhaseRateLimiter(java.util.function.Supplier<? extends RateLimiter> supplier)

Description copied from interface: Activity

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

Specified by:

getPhaseRateLimiter in interface Activity

Parameters:

supplier - A RateLimiter Supplier

Returns:

An extant or newly created phase RateLimiter

getInstrumentation

public ActivityInstrumentation getInstrumentation()

Description copied from interface: Activity

Get or create the instrumentation needed for this activity. This provides a single place to find and manage, and document instrumentation that is uniform across all activities.

Specified by:

getInstrumentation in interface Activity

Returns:

A new or existing instrumentation object for this activity.

onActivityDefUpdate

public void onActivityDefUpdate(ActivityDef activityDef)

Specified by:

onActivityDefUpdate in interface ActivityDefObserver

setDefaultsFromOpSequence

public void setDefaultsFromOpSequence(OpSequence seq)

Modify the provided ActivityDef with defaults for stride and cycles, if they haven't been provided, based on the length of the sequence as determined by the provided ratios. Also, modify the ActivityDef with reasonable defaults when requested.