Package adams.flow.template

Class DummySink

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.template.AbstractActorTemplate

adams.flow.template.DummySink

All Implemented Interfaces:

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

public class DummySink
extends AbstractActorTemplate

A dummy sink template, used as default by the TemplateSink actor.

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: 
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected Actor	doGenerate()	Generates the actor.
String	globalInfo()	Returns a string describing the object.
boolean	isInteractive()	Whether the flow generated is an interactive one.

Methods inherited from class adams.flow.template.AbstractActorTemplate

compareTo, defineOptions, 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

Constructor Detail

DummySink

public DummySink()

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

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