Versions Compared

Key

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

Group

Model Interaction, Signals

Description

Returns

Return a set of basic information for each control signal (see Glossary).

Required Control

None

Usage

(signalInfo1, signalInfo2, ...) = RtlabApi.GetControlSignalsDescription()
(signalType, signalId, path, label, reserved, readonly, value) = signalInfo1

Input

None

Output

  • signalType: Signal type. See OP_SIGNAL_TYPE.

  • id: Id of the signal.

  • path: Path of the signal.

  • label: Label or name of the signal.

  • readonly: True when the signal is read-only.

  • value: Current value of the signal

Exception

  • 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.

  • EINVAL: Invalid parameters.

Examples

See example control_signal.

Related Items

GetControlSignals

Modules

import RtlabApi