Package adams.flow.core

Interface TimedActor

All Superinterfaces:

Actor, AdditionalInformationHandler, CallableActorUser, CleanUpHandler, Comparable, Destroyable, ErrorHandler, LoggingLevelHandler, LoggingSupporter, OptionalCallableActor, OptionHandler, QuickInfoSupporter, Serializable, ShallowCopySupporter<Actor>, Stoppable, StoppableWithFeedback, VariableChangeListener, VariablesInspectionHandler

All Known Implementing Classes:

TimedSource, TimedSubProcess, TimedTee, TimedTrigger

public interface TimedActor
extends Actor, CallableActorUser, OptionalCallableActor

Interface for actors that time their execution and send the timing data to a callable actor.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
String	callableNameTipText()	Returns the tip text for this property.
Actor	getCallableActor()	Returns the currently set callable actor.
CallableActorReference	getCallableName()	Returns the name of the callable actor in use.
String	getPrefix()	Returns the prefix to store in the timing container.
boolean	getTimingEnabled()	Returns whether to perform timing on its execution.
boolean	hasCallableActor()	Checks whether a reference to the callable actor is currently available.
String	prefixTipText()	Returns the tip text for this property.
void	setCallableName(CallableActorReference value)	Sets the name of the callable actor to use.
void	setPrefix(String value)	Sets the prefix to store in the timing container.
void	setTimingEnabled(boolean value)	Sets whether to perform timing on its execution.
String	timingEnabledTipText()	Returns the tip text for this property.

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.flow.core.OptionalCallableActor

getOptional, optionalTipText, setOptional

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

setTimingEnabled

void setTimingEnabled(boolean value)

Sets whether to perform timing on its execution.

Parameters:

value - true if timing enabled

getTimingEnabled

boolean getTimingEnabled()

Returns whether to perform timing on its execution.

Returns:

true if timing enabled

timingEnabledTipText

String timingEnabledTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPrefix

void setPrefix(String value)

Sets the prefix to store in the timing container.

Parameters:

value - the prefix

getPrefix

String getPrefix()

Returns the prefix to store in the timing container.

Returns:

the prefix

prefixTipText

String prefixTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setCallableName

void setCallableName(CallableActorReference value)

Sets the name of the callable actor to use.

Parameters:

value - the callable name

getCallableName

CallableActorReference getCallableName()

Returns the name of the callable actor in use.

Returns:

the callable name

callableNameTipText

String callableNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

hasCallableActor

boolean hasCallableActor()

Checks whether a reference to the callable actor is currently available.

Returns:

true if a reference is available

See Also:

getCallableActor()

getCallableActor

Actor getCallableActor()

Returns the currently set callable actor.

Specified by:

getCallableActor in interface CallableActorUser

Returns:

the actor, can be null