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.

GetParametersDescription

Group

Model Interaction, Parameters

Description

Get the parameters' description for the current model.

Required Control

None

Usage

parametersInfo = RtlabApi.GetParametersDescription ()
(parameterInfo1, parameterInfo2, ...) = parametersInfo
(id, path, name, variableName, value) = parameterInfo1

Input

None

Output

  • parametersInfo: A tuple of tuple of information for each parameters.

  • id: Identifier of the parameter.

  • path: Simulink path of the parameter.

  • name: Name of the parameter.

  • variableName: Name of the Matlab variable associated with the parameter. May be an empty string.

  • value: Value of the parameter.

Exception

  • 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

None

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