Versions Compared

Key

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

Group

Model Interaction, Signals

Description

Returns

Return the values for the specified signal names.

Required Control

None

Usage

signalValues = RtlabApi.GetSignalsByName(signalNames)

or

signalValue = OpalApiPy.GetSignalsByName(signalName)

Input

  • signalNames: Tuple of

string
  • strings with the name of each signals or a single string with the name of one signal.

Info

NB: when requesting signal from a Simulink vector, index starts at 1.

e.g: RtlabApi.GetSignalsByName('multi_drv_SM_OPALRT_Board/f_out/OpOutput/port1(1)')

Output

  • signalValues: Tuple of double values of each signal or a single double value.

Exception

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

  • EBADF: Model not specified by previous Connect or

SetCurrentModel.
  • EIO: Error sending the request or receiving the reply.
  • EINVAL: Invalid parameters.
  • ExamplesNoneRelated ItemsGetSignalsDescriptionModulesimport RtlabApi

    Group

    Model Interaction, SignalsDescription

    Returns the values for the specified signal names.

    Required Control

    NoneUsage

    signalValues = RtlabApi.GetSignalsByName(signalNames)

    or

    signalValue = OpalApiPy.GetSignalsByName(signalName)

    Input
    • signalNames: Tuple of string with the name of each signals or a single string with the name of one signal.
    Output
    • signalValues: Tuple of double values of each signal or a single double value.
    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

    None

    Related Items

    GetSignalsDescription

    Modules

    import RtlabApi