Documentation Home Page ◇ RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

GetControlSignals

Owned by Sylvain Ménard
Last updated: May 16, 2023
1 min read

Group

Model Interaction, Control Signals

Description

Return the current values of the control signals sent to the computation nodes. The control signals are the signals sent from the console to the computation nodes in the same order than specified at the input of the OpComm of the specified computation nodes. These signals can be set by a call to SetControlSignals.

Required Control

None

Usage

values = RtlabApi.GetControlSignals(logicalId)

Input

  • logicalId: Always 0.

Output

  • values: Tuple of signal values.

Exception

  • EOK: Success.

  • EBADF: Model not specified by previous Connect or OpenProject.

  • EINVAL: Model is not loaded, or invalid logicalId.

  • EIO: Error sending the request or receiving the reply.

  • ENOMEM: Memory allocation error.

  • E2BIG: Specified storage not big enough to receive values.

Examples

See example control_signal.

Related Items

SetControlSignals

Modules

import RtlabApi

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323