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.

GetParametersByName

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

Group

Model Interaction, Parameters

Description

Get the values for the specified list of scalar parameters.

Required Control

None

Usage

parameterNames = (parameterName1, parameterName2, ...)
parameterValues = RtlabApi.GetParametersByName ( parameterNames )
(parameterValue1, parameterValue2,...) = parameterValues

Input

  • parameterNames: Tuple of parameters’ name.

Output

  • parameterValues: List of parameters’ values.

Exception

  • EOK: Success.

  • ENOMEM: Memory allocation error.

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

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

Examples

See example Parameter1.

Related Items

SetParametersByName

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