Properties

Name

The name of the ModFrame component. This name will be visible below the ModFrame component in the ModFrame Client configuration panel.

The name of a ModFrame component must be unique within the container it resides in.

Triggering

The triggering parameter decides how to initiate a transaction. The triggering is controlled by an input port named Trigger, and the value of this port decides if a transaction should occur or not. There are several triggering options available:

  • Digital rising flank: The trigger port type is boolean and triggering occurs on positive flanks on the port value.
  • Digital falling flank: The trigger port type is boolean and triggering occurs on negative flanks on the port value.
  • Digital flanks: The trigger port type is boolean and triggering occurs on both positive and negative flanks on the port value.
  • Digital high: The trigger port type is boolean and triggering occurs on every time step as long as the port value is true.
  • Digital low: The trigger port type is boolean and triggering occurs on every time step as long as the port value is false.
  • Analog change: The trigger port type is analog and triggering occurs when the analog port value changes.
  • Analog change discard zero: The trigger port type is analog and triggering occurs when the analog port value changes, except of transitions to zero.
  • String change: The trigger port type is string and triggering occurs when the string port value changes.
  • String change discard blanks: The trigger port type is string and triggering occurs when the string port value changes except of transitions to blank strings.

Trigger delay

This parameter makes it possible to delay the trigger signal, i.e. perform the triggered action a specific number of time steps after the trigger signal occurred. When the value is 0 or negative there is no delay, when > 0 the value indicates how many time steps to delay the triggered action.

Target

This parameter decides what the captured data values shall be linked to. The options are:

  • TrackerMaterial: Data values are linked to the tracking materials referenced by the TraMaIDs of the TrackerMaterialIDs port.
  • Material Lot: Data values are linked to the material lots referenced by the TraMaIDs of the TrackerMaterialIDs port.
  • All: All the targets above.

Data Value Dimension

This parameter controls the dimension of the data value ports. The options are:

  • Scalar: The data value ports are scalar. The value present on the ports is written to all the materials.
  • Vector: The data value ports are vectors of the same size as the TrackerMaterialIDs port. The value present on the port elements are written to the material referenced by the corresponding element on the TrackerMaterialIDs port.