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.

GetSignalsByName

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

Group

Model Interaction, Signals

Description

Return the values for the specified signal names.

Required Control

None

Usage

signalValues = RtlabApi.GetSignalsByName(signalNames)

or

signalValue = OpalApiPy.GetSignalsByName(signalName)

Input

  • signalNames: Tuple of strings with the name of each signals or a single string with the name of one signal.

NB: when requesting signal from a Simulink vector, index starts at 1.

e.g: RtlabApi.GetSignalsByName('multi_drv_SM_OPALRT_Board/f_out/OpOutput/port1(1)')

Output

  • signalValues: Tuple of double values of each signal or a single double value.

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

GetSignalsDescription

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
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter