Package adams.flow.standalone.rats.generator

Class Dummy

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.generator.AbstractRatGenerator

adams.flow.standalone.rats.generator.Dummy

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class Dummy
extends AbstractRatGenerator

Generates a dummy Rat setup.

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

-log <adams.flow.core.CallableActorReference> (property: log)
    The name of the callable log actor to use (logging disabled if actor not 
    found).
    default: unknown
 

-send-error-queue <adams.flow.control.StorageName> (property: sendErrorQueue)
    The name of the (optional) queue in internal storage to feed with send errors.
    default: senderrors
 

-show-in-control <boolean> (property: showInControl)
    If enabled, the generated Rat will be displayed in the adams.flow.standalone.RatControl 
    control panel.
    default: false
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.standalone.rats.generator.AbstractRatGenerator

m_Log, m_SendErrorQueue, m_ShowInControl

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

Method Summary

Modifier and Type	Method	Description
protected Rat[]	doGenerate()	Generates the actual setups.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.standalone.rats.generator.AbstractRatGenerator

check, defineOptions, generate, getLog, getSendErrorQueue, getShowInControl, logTipText, sendErrorQueueTipText, setLog, setSendErrorQueue, setShowInControl, showInControlTipText

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

Dummy

public Dummy()

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

doGenerate

protected Rat[] doGenerate()

Generates the actual setups.

Specified by:

doGenerate in class AbstractRatGenerator

Returns:

the generated setups