Versions Compared

Key

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

Group

Model Interaction, Alias

Description

Sets

Set the values of one or more parameters (or signals) by specifying their alias names and their values.

Note that if any of the aliases specified in the argument referenced a parameter, the parameter control is required. If any of the aliases specified in the argument referenced a control signal, the signal control is required.

Required Control

Parameter control or/and signal Control

Usage

aliasNames = (aliasName1, aliasName2, ...)

aliasValues = (aliasValue1, aliasValue2, ...)

RtlabApi.SetValueByAlias(aliasNames, aliasValues)

Input

  • aliasNames: Tuple of aliases names.

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

Output

None

Exception

  • EOK: Success.

  • EPERM: Parameter or signal control has not been granted to this client.

  • EINVAL: One of the aliases doesn’t exist.

  • ENOMEM: Memory allocation error.

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

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

  • 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, GetValueByAlias

Modules

import RtlabApi