Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Group

Model Interaction, Parameters

Description

Returns

Get the

set of information of

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: 

Id
  • Identifier of the parameter.

  • path: 

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

SetCurrentModel
  • OpenProject.

Examples

See example Parameter1.

Related Items

None

Modules

import RtlabApi