Package adams.flow.processor

Class ManageInteractiveActors

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.AbstractModifyingProcessor

adams.flow.processor.ManageInteractiveActors

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ActorProcessor>, SizeOfHandler, ActorProcessor, ModifyingProcessor, Serializable, Comparable<ActorProcessor>

public class ManageInteractiveActors
extends AbstractModifyingProcessor

Enables/disables the interactive behaviour of actors implementing adams.flow.core.AutomatableInteraction.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-enable (property: enable)
    If enabled, the interactive behaviour of actors will get enabled.
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Enable	whether to enable the interactive behaviour.

Fields inherited from class adams.flow.processor.AbstractModifyingProcessor

m_Modified, m_ModifiedActor, m_NoCopy

Fields inherited from class adams.flow.processor.AbstractActorProcessor

m_Errors

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ManageInteractiveActors()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	enableTipText()	Returns the tip text for this property.
boolean	getEnable()	Returns whether the interactive behaviour gets enabled or disabled.
String	globalInfo()	Returns a string describing the object.
protected void	processActor(Actor actor)	Performs the actual processing.
void	setEnable(boolean value)	Sets whether to enable or disable the interactive behaviour.

Methods inherited from class adams.flow.processor.AbstractModifyingProcessor

getModifiedActor, getNoCopy, initialize, isModified, process, setNoCopy

Methods inherited from class adams.flow.processor.AbstractActorProcessor

addError, addError, checkData, compareTo, equals, getErrors, hasErrors, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.processor.ActorProcessor

compareTo, getErrors, hasErrors, shallowCopy, shallowCopy

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Enable

protected boolean m_Enable

whether to enable the interactive behaviour.

Constructor Detail

ManageInteractiveActors

public ManageInteractiveActors()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setEnable

public void setEnable(boolean value)

Sets whether to enable or disable the interactive behaviour.

Parameters:

value - if true then interactive behaviour will get enabled

getEnable

public boolean getEnable()

Returns whether the interactive behaviour gets enabled or disabled.

Returns:

true if the interactive behaviour gets enabled

enableTipText

public String enableTipText()

Returns the tip text for this property.

Returns:

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

processActor

protected void processActor(Actor actor)

Performs the actual processing.

Specified by:

processActor in class AbstractActorProcessor

Parameters:

actor - the actor to process

See Also:

ModifyingProcessor