Versions Compared

Key

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

Group

Model Interaction, Control Signals

Description

Requests

Request or

releases

release the signal control of the currently connected model. Signal control allows the client API to change the values of the model's control signals. Only one client API at a time is granted signal control.

Required Control

None

Usage

RtlabApi.GetSignalControl(logicalId, signalControl)

Input

  • logicalId: See Glossary. 0 means taking control for all subsystems.

  • signalControl: True(1) to request control of the signals of the model or the node, False(0) to release control of all target subsystems.

Output

None

Exception

  • EOK: Success.

  • EPERM: Control requested, but already given to another client.

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

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

Examples

See example control_signal.

Related Items

SetControlSignals, SetSignalsByName.

Modules

import RtlabApi