Name

adams.flow.transformer.SetPlotContainerValue

Synopsis

Updates a value of a plot container before it is being displayed in the SequencePlotter sink. Usually, you would attach a variable to the 'value' property of this actor, in order to update the specified value of the container with a value that you calculated somewhere else in the flow.

Additional information

Flow input/output:
- input: adams.flow.container.SequencePlotterContainer
- output: adams.flow.container.SequencePlotterContainer

Container information:
- adams.flow.container.SequencePlotterContainer:
   - PlotName: name of the plot; java.lang.String
   - X: X value; java.lang.Comparable
   - Y: Y value; java.lang.Comparable
   - Content type: type of plot; adams.flow.container.SequencePlotterContainer$ContentType
   - Error X: X error; java.lang.Double[]
   - Error Y: Y error; java.lang.Double[]
   - MetaData: mapping of meta-data (String/Object); java.util.HashMap

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	SetPlotContainerValue

  
  
• 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

  
  
• containerValue
  

  The type of value to update.

  command-line	-container-value <PLOT_NAME|X_VALUE|Y_VALUE|X_ERROR_VALUE|Y_ERROR_VALUE|META_DATA>
  default	PLOT_NAME

  
  
• value
  

  The actual value to use for updating; values for X_VALUE and Y_VALUE get automatically parsed to doubles; in case of PLOT_NAME you can also use variables in the string.

  command-line	-value <adams.core.base.BaseString>
  default	Plot

  
  
• metaDataKey
  

  The key to use when updating meta-data.

  command-line	-meta-data-key <java.lang.String>
  default

  
  
• conversion
  

  The conversion to apply to the meta-data value string before adding it.

  command-line	-conversion <adams.data.conversion.ConversionFromString>
  default	adams.data.conversion.StringToString