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 argument identifier. The list of available ident definitions are governed by the database configuration.

Search input

This parameter defines how to handle the value of the argument identifier, and what criteria that are used to find materials that match the argument identifier identifier.

  • Ident value. The argument identifier is matched against ident values. Match requires complete match of all the characters of the search input.
  • Ident value ID. The argument identifier is matched against ident value IDs. Match requires match of the complete ID.
  • Ident value match start. The search input identifier is matched against ident values. Match requires that the first characters of the material identifiers are the same as the search input identifier.
  • Ident value match end. The argument identifier is matched against ident values. Match requires that the last characters of the material identifiers are the same as the external identifier.
  • Ident value reg ex. The search input identifier is matched against ident values. Match requires that a regular expression is satisfied. (To be explained later)

Input dimension

The input dimension defines the dimension of the argument identifier input port. A lookup may be performed on single argument identifiers or multiple argument identifiers.

  • Scalar. Lookup is performed on a single argument identifier. The input port is a string port.
  • Vector. Lookup is performed on multiple argument identifiers. The input port is a string vector port.

Lookup rule

This parameter defines the expected result of the lookup.

  • Distinct Material. It is expected that multiple material identifiers can match the external identifier(s). The number of materials found does not need to be equal to the number of argument identifiers.
  • Unique identification. It is expected that there exists one and only one material identifier that matches each argument identifier. If several materials match the argument identifier, a warning is generated, and the newest (CreateTime) of the matched materials are returned.

TPU filter

The TPU filter parameter defines where (in which TPU’s) to search for material.

  • Specific TPUs. The tracker process units defined in the Filters tab are searched.
  • All. All tracker process units in the tracker application are searched.

Hold Result

When this parameter is checked, the search results are held on the result ports until a new result arrives. When unchecked, the search results stay on the result ports for just one time step.

Report ambiguous lookups

When this parameter is checked, the component will report warnings related to ambiguous lookups. This feature may be useful for debugging purposes.