Name

adams.flow.control.TimedSubProcess

Synopsis

Encapsulates a sequence of flow items. The first actor must accept input and the last one must produce output.
Times how long the sub-flow execution takes and sends the time in milli-seconds (as double) in a adams.flow.container.TimingContainer container to the specified callable actor.

Additional information

Flow input/output:
- input: adams.flow.core.Unknown
- output: adams.flow.core.Unknown
Actor handler information:
- Actor execution: SEQUENTIAL
- Standalones allowed: false
- Source allowed: false
- Forwards input: true
Stop restriction: optional (currently: off)

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	TimedSubProcess

  
  
• 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

  
  
• 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

  
  
• actors
  

  All the actors that define this sequence.

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

  
  
• timingEnabled
  

  If enabled, then the actors performs timing on its execution.

  command-line	-timing-enabled <boolean>
  default	true

  
  
• prefix
  

  The prefix to store in the timing container; automatically expands variables.

  command-line	-prefix <java.lang.String>
  default

  
  
• callableName
  

  The name of the callable actor to use.

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

  
  
• optional
  

  If enabled, then the callable actor is optional, ie no error is raised if not found, merely ignored.

  command-line	-optional <boolean>
  default	false