Package adams.flow.template

Class StoreReportValueInVariable

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.template.AbstractActorTemplate

adams.flow.template.StoreReportValueInVariable

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable

public class StoreReportValueInVariable
extends AbstractActorTemplate

Generates a sub-flow (enlosed by a Tee) that sets the value of a variable with the associated value from the report.

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
 

-name <java.lang.String> (property: name)
    The new name for the actor; leave empty to use current.
    default:
 

-field <adams.data.report.Field> (property: field)
    The report field to retrieve.
    default: blah[N]
 

-variable <adams.core.VariableName> (property: variableName)
    The variable to store the report value in.
    default: variable
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Field	m_Field	the report field to extract.
protected VariableName	m_VariableName	the variable to store the value in.

Fields inherited from class adams.flow.template.AbstractActorTemplate

m_Name

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
StoreReportValueInVariable()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Actor	doGenerate()	Generates the actor.
String	fieldTipText()	Returns the tip text for this property.
Field	getField()	Returns the field to retrieve from the report.
VariableName	getVariableName()	Returns the variable to set.
String	globalInfo()	Returns a string describing the object.
boolean	isInteractive()	Whether the flow generated is an interactive one.
void	setField(Field value)	Sets the field to retrieve from the report.
void	setVariableName(VariableName value)	Sets the variable to set.
String	variableNameTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.template.AbstractActorTemplate

compareTo, equals, forCommandLine, forName, generate, getBaselineCorrections, getDefaultName, getName, nameTipText, postGenerate, preGenerate, setName, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Field

protected Field m_Field

the report field to extract.

m_VariableName

protected VariableName m_VariableName

the variable to store the value in.

Constructor Detail

StoreReportValueInVariable

public StoreReportValueInVariable()

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 AbstractActorTemplate

setField

public void setField(Field value)

Sets the field to retrieve from the report.

Parameters:

value - the field

getField

public Field getField()

Returns the field to retrieve from the report.

Returns:

the field

fieldTipText

public String fieldTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setVariableName

public void setVariableName(VariableName value)

Sets the variable to set.

Parameters:

value - the variable

getVariableName

public VariableName getVariableName()

Returns the variable to set.

Returns:

the variable

variableNameTipText

public String variableNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

isInteractive

public boolean isInteractive()

Whether the flow generated is an interactive one.

Specified by:

isInteractive in class AbstractActorTemplate

Returns:

true if interactive

doGenerate

protected Actor doGenerate()

Generates the actor.

Specified by:

doGenerate in class AbstractActorTemplate

Returns:

the generated actor