Name

adams.flow.sink.ProgressConsole

Synopsis

Outputs progress information in the console. The incoming token is used as 'current' value to be displayed. For convenience, the incoming token representing a number can also be in string format. Only outputs something if different from the last output.

Additional information

Flow input/output:
- input: java.lang.Number, java.lang.String

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	ProgressConsole

  
  
• 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

  
  
• minimum
  

  The minimum to use.

  command-line	-min <double>
  default	0.0

  
  
• maximum
  

  The maximum to use.

  command-line	-max <double>
  default	100.0

  
  
• prefix
  

  The prefix string to print before the percentage.

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

  
  
• format
  

  The format string to use for outputting the current value, use empty string to suppress output.

  command-line	-format <adams.data.DecimalFormatString>
  default	#.#%
  more	https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/DecimalFormat.html

  
  
• suffix
  

  The suffix string to print before the percentage.

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

  
  
• title
  

  The 'title' to use, used as prefix to the generated progress string, separated by ': '

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