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.

Ident definition

This parameter specifies the Ident definition of the identifiers to write or update. The available ident definitions are governed by the database configuration.

Operation mode

This parameter specifies the operating mode of the component. The alternatives are:

  • Update. The component is used to update existing identifiers. An input port named IdentValueIDs will appear. The IdentValues referenced by the IdentValueIDs port will be updated according to the values present on the IdentValues port.
  • Insert. The component is used to write new identifiers and link to TrackingMaterial or Material lots. An input port named TrackerMaterialIDs will appear. The ident values present on the IdentValues port will be written and linked to the TrackingMaterial and/or MaterialLots referenced by the TrackerMaterialIDs port. Whether the identifiers shall be linked to TrackingMaterial, MaterialLot or both are governed by the database configuration (IdentValue table).

Input dimension

This parameter controls the dimension of the ident value input. The alternatives are:

  • Vector. The ident value input will be a string vector port named IdentValues. The dimension of this port must be the same as the IdentValueIDs/TrackerMaterialIDs port. The elements in the IdentValues reference the corresponding elements in IdentValueIDs/TrackerMaterialIDs port.
  • Scalar. The ident value input will be a scalar string port named IdentValue. The scalar value references all the elements in the IdentValueIDs/TrackerMaterialIDs port. The result is that the same ident value is written to all the materials in write mode, or that the all the identifiers are updated to the same value in update mode.