Versions Compared

Old Version 5

changes.mady.by.user Sylvain Ménard

Saved on

compared with

New Version Current

changes.mady.by.user Amira Aouina

Saved on

Key

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

Group

Model Preparation

Description

Disconnect two paths of each other, if it is a list of paths, it disconnects paths with the same index in the tuple.

Required Control

None

Usage

RtLabApi.DeleteConnection(paths1, paths2

, continueOnFailure

)
paths1 = a string or tuple of strings
paths2 = a string or tuple of strings

continueOnFailure = bool

Input

  • paths1 and paths2: 

Each path element can be:
- A path to a signal or parameter in the model (ie. 'rtdemo1/sm_computation/Gain Kd/Gain')
- A path to a widget in a LabVIEW panel (ie. 'PID Controller/Reference')
- A path to a Waveform Graph in a LabVIEW panel on wanted plot (ie. 'PID Controller/Waveform Graph[0]')
- A path to an input or output of an I/Os (ie. 'Signal Generator/Sine Waves/Sine Wave 1/Output')
- An alias (ie. 'NameOfMyAlias')

continueOnFailure: If set to false, stops execution if any disconnection fails, otherwise it ignores the failure and tries the next pair of path, if any.

Output

None

Exception

  • EOK: success.

  • EINVAL: Invalid arguments specified.

Examples

Delete a specific connection between two datapoints:

  • RtlabApi.DeleteConnection('rtdemo1/sm_computation/Gain Kd/Gain', 'Controller/Waveform Graph[0]')

Delete all existing connections:

  • RtlabApi.DeleteConnection('*', '*')

Related Items

CreateConnection

Modules

import RtlabApi