Name

adams.flow.standalone.Rat

Synopsis

Defines a single reception/transmission setup.

Additional information

Flow input/output:
-standalone-
Actor handler information:
- Actor execution: SEQUENTIAL
- Standalones allowed: false
- Source allowed: false
- Forwards input: true

Rat input/output:
-receiver generates: adams.flow.core.Unknown
-transmitter accepts: adams.flow.core.Unknown

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	Rat

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• receiver
  

  The receiver to use.

  command-line	-receiver <adams.flow.standalone.rats.input.RatInput>
  default	adams.flow.standalone.rats.input.DummyInput

  
  
• performLazySetup
  

  If enabled, initializing the sub-actors will only occurring the first time the rat gets executed (ie the input triggers); use with 'wrapUpAfterExecution' to save memory; gets disabled if actors contain a Breakpoint.

  command-line	-perform-lazy-setup <boolean>
  default	false

  
  
• actors
  

  The actors for transforming the data obtained by the receiver before sending it to the transmitter.

  command-line	-actor <adams.flow.core.Actor> [-actor ...]
  default

  
  
• transmitter
  

  The transmitter to use.

  command-line	-transmitter <adams.flow.standalone.rats.output.RatOutput>
  default	adams.flow.standalone.rats.output.DummyOutput

  
  
• log
  

  The name of the callable log actor to use (logging disabled if actor not found).

  command-line	-log <adams.flow.core.CallableActorReference>
  default	unknown

  
  
• logGenerator
  

  The generator for turning the error message into the required log object.

  command-line	-log-generator <adams.flow.standalone.rats.log.AbstractLogObjectGenerator>
  default	adams.flow.standalone.rats.log.LogEntryGenerator

  
  
• scopeHandlingVariables
  

  Defines how variables are handled in the local scope; whether to start with empty set, a copy of the outer scope variables or share variables with the outer scope.

  command-line	-scope-handling-variables <EMPTY|COPY|SHARE>
  default	EMPTY

  
  
• propagateVariables
  

  If enabled, variables that match the specified regular expression get propagated to the outer scope.

  command-line	-propagate-variables <boolean>
  default	false

  
  
• variablesRegExp
  

  The regular expression that variable names must match in order to get propagated.

  command-line	-variables-regexp <adams.core.base.BaseRegExp>
  default	.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html

  
  
• scopeHandlingStorage
  

  Defines how storage is handled in the local scope; whether to start with empty set, a (deep) copy of the outer scope storage or share the storage with the outer scope.

  command-line	-scope-handling-storage <EMPTY|COPY|SHARE>
  default	EMPTY

  
  
• propagateStorage
  

  If enabled, storage items which names match the specified regular expression get propagated to the outer scope.

  command-line	-propagate-storage <boolean>
  default	false

  
  
• storageRegExp
  

  The regular expression that the names of storage items must match in order to get propagated.

  command-line	-storage-regexp <adams.core.base.BaseRegExp>
  default	.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html

  
  
• flowErrorQueue
  

  The name of the (optional) queue in internal storage to feed with flow errors; Forwards the original data received as payload in an adams.flow.container.ErrorContainer alongside the error message.

  command-line	-flow-error-queue <adams.flow.control.StorageName>
  default	flowerrors

  
  
• sendErrorQueue
  

  The name of the (optional) queue in internal storage to feed with send errors; Forwards the original data received as payload in an adams.flow.container.ErrorContainer alongside the error message.

  command-line	-send-error-queue <adams.flow.control.StorageName>
  default	senderrors

  
  
• suppressErrors
  

  If enabled, errors are suppressed and only forwarded to the log actor.

  command-line	-suppress-errors <boolean>
  default	true

  
  
• showInControl
  

  If enabled, this Rat will be displayed in the adams.flow.standalone.RatControl control panel.

  command-line	-show-in-control <boolean>
  default	false

  
  
• initialState
  

  The initial state of the Rat actor.

  command-line	-initial-state <PAUSED|RUNNING>
  default	RUNNING

  
  
• mode
  

  The mode the Rat actor is run in.

  command-line	-mode <CONTINUOUS|MANUAL>
  default	CONTINUOUS

  
  
• finishBeforeStopping
  

  If enabled, actor first finishes processing all data before stopping.

  command-line	-finish-before-stopping <boolean>
  default	false

  
  
• stoppingTimeout
  

  The timeout in milliseconds when waiting for actors to finish (<= 0 for infinity; see 'finishBeforeStopping').

  command-line	-stopping-timeout <int>
  default	-1
  minimum	-1

  
  
• stoppingWarningInterval
  

  The interval in milliseconds to output logging warnings if the actors haven't stopped yet (and no stopping timeout set); no warning if <= 0.

  command-line	-stopping-warning-interval <int>
  default	10000
  minimum	-1

  
  
• wrapUpAfterExecution
  

  Whether to wrapUp the actors after execution to save memory; only available in conjunction with 'performLazySetup'.

  command-line	-wrapup-after-execution <boolean>
  default	false