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.

GetSignalsDescription

Group

Model Interaction, Control Signals

Description

Return a set of basic information for each available signal in the model.

Required Control

None

Usage

signalInfos = RtlabApi.GetSignalsDescription()

(signalType, signalId, path, label, reserved, readonly, value) = signalInfo1

Input

None

Output

  • signalInfos: Tuple of tuples of information for each signals.

  • signalType: Signal type. See OP_SIGNAL_TYPE.

  • signalId: Id of the signal.

  • path: Path of the signal.

  • label: Label or name of the signal.

  • readonly: True when the signal is read-only.

  • value: Current value of the signal.

Exception

  • EPERM: Control requested, but already given to another client.

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

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

  • EINVAL: Invalid parameters.

Examples

None

Related Items

GetSignalsByName.

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