General

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.

Argument

This parameter defines the input argument to the query. The input argument is provided on an argument input port. The argument options are:

• TraMaID. The input argument is TraMaID and will be matched against TraMaIDs in the tracker application.
• IdentValue. The input argument is Identifier and will be matched against the ident values of the Identifiers in the tracker application. Match requires complete match of all the characters.
• IdentValueID. The input argument is Ident Value ID and will be matched against ident value IDs of the Identifiers in the tracker application. Match requires match of the complete ID.
• IdentValue match start. The input argument is Identifier and will be matched against the ident values of the Identifiers in the tracker application. Match requires that the first characters of the material identifiers are the same as the external identifier.
• IdentValue match end. The input argument is Identifier and will be matched against the ident values of the Identifiers in the tracker application. Match requires that the last characters of the material identifiers are the same as the external identifier.
• IdentValue reg ex. The input argument is Identifier and will be matched against the ident values of the Identifiers in the tracker application. Match requires that a regular expression is satisfied.

Argument IdentDefinition

This parameter specifies the ident definition of the identifier argument when the argument is IdentValue or IdentValueID. The list of available ident definitions are governed by the database configuration.

Argument type

This parameter defines the expected result of the lookup. The options are:

• Single Material Identification. It is expected that there exists one and only one material material that matches each argument. If several materials match the argument, a warning is generated, and the newest (CreateTime) of the matched materials are returned. Use this option when it is expected that the query will return only one material.
• Material group identification. It is expected that multiple materials identifiers can match the argument(s). The number of materials found does not need to be equal to the number of arguments. Use this option when it is expected that the query will return several materials.

Argument dimension

The Argument dimension defines the dimension of the argument input port. A lookup may be performed on a single argument or multiple arguments. The options are:

• Scalar. Lookup is performed on a single argument. The argument input port is a scalar port.
• Vector. Lookup is performed on multiple arguments. The argument input port is a vector port.

Exposure dimension

The exposure dimension defines the expected dimension of the exposed result values.

• Scalar. The query is expected to return a single material. The exposure ports are scalars.
• Vector. The query is expected to return multiple materials. The exposure ports are vectors.

Process filter

The Process Filter can restrict where (in which tracker process units) to search for material. The options are:

• Enabled. The tracker process units defined in the Process Filter tab are searched.
• Disabled. All tracker process units in the tracker application are searched.

Result reset

The Result reset parameter defines how long the query results will be available on the exposure ports. The reset options are:

• Immediately. The results are available in one time step.
• On consecutive trigger. The results are available until the next search is triggered.
• Step delayed. The results are available in a given number of time steps. The number of time steps are defined in the Result reset delay parameter.
• Time delayed. The results are available in a given period. The period (milliseconds) is defined in the Result reset delay parameter.

Result reset delay

The Result reset delay defines the delay when the Result reset parameter is one of the delayed options:

• Step delayed. Number of steps to delay the reset.
• Time delayed. Number of milliseconds to delay the reset.

Report ambiguous lookups

When this parameter is checked, the component will report warnings related to ambiguous lookups.