Package adams.flow.standalone.rats.output

Class Branch

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.Branch

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

public class Branch
extends AbstractRatOutput

Forwards the input data to all defined sub-outputs ('sub-branches').

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-output <adams.flow.standalone.rats.RatOutput> [-output ...] (property: outputs)
    The transmitters to send the data to.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected RatOutput[]	m_Outputs	the RatOutput schemes to pass the data on to.

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

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the type of data that gets accepted.
void	defineOptions()	Adds options to the internal list of options.
protected String	doTransmit()	Performs the actual transmission.
RatOutput[]	getOutputs()	Returns the base transmitters to use.
String	globalInfo()	Returns a string describing the object.
String	outputsTipText()	Returns the tip text for this property.
void	setOutputs(RatOutput[] value)	Sets the base transmitters 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

backupState, canInput, check, cleanUp, configureLogger, doWait, findVariables, getAdditionalInformation, getFullName, getOwner, getQueue, getQuickInfo, getVariables, handleException, initialize, initTransmission, 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, 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_Outputs

protected RatOutput[] m_Outputs

the RatOutput schemes to pass the data on to.

Constructor Detail

Branch

public Branch()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 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

setOutputs

public void setOutputs(RatOutput[] value)

Sets the base transmitters to use.

Parameters:

value - the transmitters

getOutputs

public RatOutput[] getOutputs()

Returns the base transmitters to use.

Returns:

the transmitters

outputsTipText

public String outputsTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the type of data that gets accepted.

Specified by:

accepts in interface RatOutput

Specified by:

accepts in class AbstractRatOutput

Returns:

the type of data

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

doTransmit

protected String doTransmit()

Performs the actual transmission.

Specified by:

doTransmit in class AbstractRatOutput

Returns:

null if successful, otherwise error message