Versions Compared

Key

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

Group

Model Interaction, Parameters

Description

Change the value of one or more RT-LAB parameters in the model.

Required Control

Parameter Control

Usage

parameterTuple1 = (parameterId1, value1)

parameterTuple2 = (parameterId1, value1)

...

parametersInfo = (parameterTuple1, parameterTuple2, ...)

RtlabApi.SetParameters( parametersTuple )

Input

  • parametersInfo: Information about parameters to set. Tuple containing one tuple per parameter, each containing: parameter id and value.

Output

None

Exception

  • EOK: Success.

  • EPERM: Parameter control had not been granted to this client.

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

  • ENOEXEC: Model is not loaded.

  • EINVAL: No parameter to set or invalid parameter id.

  • E2BIG: Too many parameters or values to modify.

  • ENOMEM: Memory allocation error.

  • ENOENT: Cannot open parameter file or parameter id not found.

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

  • 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

See example parameter1.

Related Items

GetAllParamaters, GetParameterControl, GetParameters

Modules

import RtlabApi