Polybench® Reference
Stops data processing on all components, or all components that use the specified SyncID.



The STOP action stops data processing. It is the same action that is performed when you press the Stop button in the toolbar from Polybench Designer.

An Action may use a Value and an Address
Value: synchronization identifier (user defined text or number) to decide which components should be stopped.
Address: empty.



Leave this empty to stop all components that perform some autonomous processing, such as file replay and device operators.
You may also specify a SyncID value that is used by some of the components in your project, to only stop those components.


Not used.

Background information

This is a broadcast event that Polybench sends to all or a group of objects in the system, to indicate that data processing stops. Most of the operators do not need this information, because they act as data-slaves, that is, they only process samples that come in via there inputs. But some operators, such as data sources (e.g. an acquisition device) will use this event to stop their operation.
Together with the STOP Action, a synchronization identifier may be transmitted. This allows operators to choose if they have to react on the stop call. Operators that allow this choice, will offer a property that is called SyncID. If and how an operator reacts on a STOP Action is specified for the operator.

The oposite Action is the START Action (link).
After calling the STOP action, some components may issue the STOPPED Action (link) to indicate that stopping was successful.

Synchronous or asynchronous

This action is performed synchronously with data processing. If an action is asynchronous, it is performed only after all synchronous actions in a sequence have been called. A synchronous action is performed immediately.