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.

GetValueByAlias

Group

Model Interaction, Alias

Description

Get the values of one or more parameters (or signals) by specifying their alias names. The output contains one value for each alias.

Required Control

None

Usage

aliasNames = (aliasName1, aliasName2, ...)

aliasValues = RtlabApi.GetValueByAlias(aliasNames)

(aliasValue1, aliasValue2, ...) = aliasValues

Input

  • aliasNames: Tuple of aliases’ names to get.

Output

  • aliasValues: Tuple of values for the parameters or signals referenced by the aliases.

Exception

  • EOK: Success.

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

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

  • EINVAL: At least one of the alias doesn’t exist.

  • ENOMEM: Memory allocation error.

  • OP_API_MODEL_IO_TIMEOUT: Timed out waiting for reply from model.

  • OP_API_MODEL_IO_ERROR: Model is missing some or all processes or subsystems.

Examples

None

Related Items

CreateAlias, SetValueByAlias.

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