Output definition

The output definition tab tab is used to define output material flow from this tracker process unit.

This parameter tab is based on the parameter matrix concept. Use the Add button to add a new row and the remove button to remove a selected row. The columns of the matrix are described below.

For every output flow, a tracking material output (TMO) port and a corresponding control (CTR) port will appear. The TMO ports can be connected to downstream tracker process units, or left unconnected to end the material trace at the current position. The CTR ports are used to control the flow through the tracking material output ports.

Material transfer

This column defines the type of material flow to use. The type of control port depends on the type of material flow selected.

  • Flush. This type of material flow allows all the material inside the tracker process unit to flow out through a single TMO port. A digital CTR port will be created. When the value of this CTR port is true, all the material inside the TPU will flow out of the corresponding TMO port.

  • Materials by ID. This option enables flow of distinct identifiable materials. A vector CTR port intended for a TraMaID array is created. This port may e.g. be connected to a MaterialLookup component.

  • Material amount by ID. This option enables flow of specific amounts of distinct identifiable materials. An matrix CTR ports intended for TraMaIDs in the first column and amounts in the second column is created.

  • Amount random. This option enables flow of a specific amount of material out of the TPU. What material that is chosen for movement is random. An analog CTR port will be created. This port controls the amount transferred every time step.

  • Material count. This option enables flow of a specific count of materials out of the TPU. An analog CTR port will be created. This port controls the count transferred every time step.

  • Materials by quality class. This option will cause material of a specific material quality class to flow out of the TMO port. An analog CTR port intended for MaterialQualityClassIDs is created.

  • Outdated materials. This option will cause material that has been present in the TPU for longer than a specific time period to flow out of the TMO port. A digital control port is created, and this port must be set to true for the outdate functionality to be enabled.

              

The outdate time is configurable in the Random Collection Properties tab.

  • Outdated materials external limit. This option will cause material older that a specific time to flow out of the TMO port. An analog CTR port intended for UTC time ticks will be created, and material older that this specific point in time will flow out of the TMO port.

Command port name

This column displays the name of the control port (CTR). The column is read-only, as the name of the CTR port is derived from the name of the material output port (TMO).

Material port name

This is the name of the tracking material output port (TMO). If the typed name does not start with TMO, the component will prefix the typed port name with ‘TMO’.

Topology independent

If this parameter is checked, the TMO port becomes a virtual invisible port, where material can flow out of the TPU to any other TPU in the tracker application.

Global search

When this property is checked, a global material search is enabled. This means that if the searched material (TraMaID) is not found in this tracker process unit, a search in all the other tracker process units will be performed, and the actual material will be moved out of the tracker process unit hosting it virtually through the TMO port of this tracker process unit.