AbstractScript (adams-addons-pom 25.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.djl.networkgenerator.AbstractNetworkGenerator
      - adams.data.djl.networkgenerator.AbstractScript

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, NetworkGenerator, adams.flow.core.AdditionalOptionsHandler, adams.flow.core.FlowContextHandler, Serializable
```
public abstract class AbstractScript
extends AbstractNetworkGenerator
implements adams.flow.core.AdditionalOptionsHandler
```
Ancestor for network generator scripts.

Scripts of scripting languages like Groovy need to be derived from this class.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected adams.flow.core.AdditionalOptions m_AdditionalOptions
for storing the additional options.
- Fields inherited from class adams.data.djl.networkgenerator.AbstractNetworkGenerator
  m_FlowContext
- 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

AbstractScript()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`adams.flow.core.AdditionalOptions`	`getAdditionalOptions()`	Returns the value associated with the (additional) option.
`protected void`	`initialize()`	Initializes the members.
`void`	`setAdditionalOptions(adams.flow.core.AdditionalOptions options)`	Sets the additional options.

Methods inherited from class adams.data.djl.networkgenerator.AbstractNetworkGenerator
check, doGenerate, generate, getFlowContext, getQuickInfo, requiresFlowContext, setFlowContext

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

- Field Detail
  - m_AdditionalOptions
```
protected adams.flow.core.AdditionalOptions m_AdditionalOptions
```
    for storing the additional options.
- Constructor Detail
  - AbstractScript
```
public AbstractScript()
```
- Method Detail
  - initialize
```
protected void initialize()
```
    Initializes the members.
    
    Overrides:
    
    initialize in class adams.core.option.AbstractOptionHandler
  - setAdditionalOptions
```
public void setAdditionalOptions(adams.flow.core.AdditionalOptions options)
```
    Sets the additional options.
    
    Specified by:
    
    setAdditionalOptions in interface adams.flow.core.AdditionalOptionsHandler
    
    Parameters:
    
    options - the options (name <->value relation)
  - getAdditionalOptions
```
public adams.flow.core.AdditionalOptions getAdditionalOptions()
```
    Returns the value associated with the (additional) option.
    
    Specified by:
    
    getAdditionalOptions in interface adams.flow.core.AdditionalOptionsHandler
    
    Returns:
    
    the options (name <->value relation)