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.

Stored procedure

The Stored procedure parameter is used to select the stored procedure to execute. Only stored procedures on the TSP schema are available for execution. When a stored procedure is selected, the parameters of the stored procedure will be reflected as
input ports on the component. It is not possible to change the stored procedure if the input ports are connected.
If the parameters of the stored procedure changes, this will be reflected on the input ports the next time the property page is opened.

Result port dimension

The Result port dimension parameter is used to select the dimension of the result set ports. The possible choices are:

  • Scalar. The result ports will be scalar. The type of scalar is decided in the Result Set Port Mapping tab.
  • Vector. The result ports will be vector. The type of scalar is decided in the Result Set Port Mapping tab.
  • Matrix. There will be one matrix result port. The elements of the matrix are analog.

Operation mode

The Operation mode defines the way the stored procedure is executed:

  • Asynchronous: The stored procedure is executed in a separate thread. This option is recommended in order to avoid delays in the tracker operation.
  • Synchronous: The stored procedure is executed by the main tracker thread. Use this option with care, since delays in the store procedure may delay the whole tracker operation.

Max execution queue length

The Max execution queue length parameter can be used to limit the number of queued execution requests.