Properties

The properties tab contains the most central parameters of TrackerMaterialGenerator.

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.

Material Definition

The material definition of the generated material is decided by this property. All material must belong to a specific material definition.

Quality Assignment

This parameter controls the quality assignment of the generated materials. The quality can be set to a predefined value, or assigned by a port value. If the port value options are used, MaterialQualityIDs are expected on the ports. The value present on the port when triggering occurs will be assigned to the generated material.

Article Assignment

This parameter controls the article assignment of the generated materials. The article can be set none, to a predefined value, or assigned by a port value. If the port value options are used, ArticleIDs are expected on the ports. The value present on the port when triggering occurs will be assigned to the generated material.

Material Lot Assignment

Assignment of material lot is optional. If a material lot should be assigned to the material, this parameter is used do control the material lot definition of the generated material.

Amount determination

This parameter controls the amount property of the generated material. The amount can either be set to a fixed value provided by the Fixed amount parameter or assigned by the use of a scalar or vector port. Vector amount ports are used when multiple materials are generated in one transaction. The amounts present on the ports at triggering time will be assigned to the generated material.

Fixed amount

This is the fixed amount to assign to material when the Amount determination is set to Fixed amount.

Material count determination

This parameter decides the number of materials to generate on a transaction. The number of materials may be fixed or provided by a port value. When the number of material is fixed, the number of materials generated are controlled by the Fixed material count property. When port determination is used, the number present on the port at triggering time controls the number of materials to generate.

Fixed material count

This is the fixed count of material to generate when the Material count determination is set to Fixed count.

Material probability

This property decides the initial individual probability of the generated material. The property is only effective when material lots are assigned. The probability can be set to a fixed value provided by the fixed material probability parameter, or provided by a port value.

Fixed Material Probability

This is the fixed material probability to assign when the Material probability parameter is set to Fixed Probability.