Package adams.flow.standalone.rats.output

Class AbstractMetaRatOutput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.output.AbstractRatOutput

adams.flow.standalone.rats.output.AbstractMetaRatOutput

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable

Direct Known Subclasses:

ContainerValuePicker, OutputWithCallableTransformer, OutputWithExternalTransformer, SimpleContainerContent

public abstract class AbstractMetaRatOutput
extends AbstractRatOutput

Ancestor for RatOutput schemes that wrap another RatOutput.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected RatOutput	m_Output	the base RatOutput to use.

Fields inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_Input, m_LoggingPrefix, m_Owner, m_Stopped, m_VariablesUpdated

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

Method Summary

Modifier and Type	Method	Description
protected String	callTransmit()	Hook method that calls the base-input's transmit() method.
void	defineOptions()	Adds options to the internal list of options.
protected String	doTransmit()	Performs the actual reception of data.
RatOutput	getOutput()	Returns the base transmitter to use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	initTransmission()	Initializes the transmission.
String	outputTipText()	Returns the tip text for this property.
protected String	postTransmit()	Hook method after calling the base-output's transmit() method.
protected String	preTransmit()	Hook method before calling the base-output's transmit() method.
void	setOutput(RatOutput value)	Sets the base transmitter to use.
void	setOwner(Rat value)	Sets the actor the transmitter belongs to.
String	setUp()	Hook method for performing checks at setup time.

Methods inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

accepts, backupState, canInput, check, cleanUp, configureLogger, doWait, findVariables, getAdditionalInformation, getFullName, getOwner, getQueue, getVariables, handleException, initialize, input, isBackedUp, isStopped, pruneBackup, pruneBackup, restoreState, shallowCopy, shallowCopy, stopExecution, transmit, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

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_Output

protected RatOutput m_Output

the base RatOutput to use.

Constructor Detail

AbstractMetaRatOutput

public AbstractMetaRatOutput()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setOwner

public void setOwner(Rat value)

Sets the actor the transmitter belongs to.

Specified by:

setOwner in interface RatOutput

Overrides:

setOwner in class AbstractRatOutput

Parameters:

value - the owner

setOutput

public void setOutput(RatOutput value)

Sets the base transmitter to use.

Parameters:

value - the transmitter

getOutput

public RatOutput getOutput()

Returns the base transmitter to use.

Returns:

the transmitter

outputTipText

public String outputTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRatOutput

Returns:

null if no info available, otherwise short string

setUp

public String setUp()

Hook method for performing checks at setup time.

Specified by:

setUp in interface RatOutput

Overrides:

setUp in class AbstractRatOutput

Returns:

null if successful, otherwise error message

initTransmission

public String initTransmission()

Initializes the transmission.

Specified by:

initTransmission in interface RatOutput

Overrides:

initTransmission in class AbstractRatOutput

Returns:

null if successfully initialized, otherwise error message

preTransmit

protected String preTransmit()

Hook method before calling the base-output's transmit() method.

Default implementation does nothing.

Returns:

null if successful, otherwise error message

callTransmit

protected String callTransmit()

Hook method that calls the base-input's transmit() method.

Returns:

null if successful, otherwise error message

postTransmit

protected String postTransmit()

Hook method after calling the base-output's transmit() method.

Default implementation does nothing.

Returns:

null if successful, otherwise error message

doTransmit

protected String doTransmit()

Performs the actual reception of data.

Specified by:

doTransmit in class AbstractRatOutput

Returns:

null if successful, otherwise error message