Documentation Home Page RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

GetConnectionsDescription

Group

Connections

Description

Get the connections of a project (excluding datalogger connections)

Required Control

None

Usage

connectionsInfo = RtlabApi.GetConnectionsDescription()
(cnxInfo1, cnxInfo2, ...) = connectionsInfo 
(datapoint1, datapoint2) = cnxInfo1 
{'optype', ['path'], ['caption'], ['description'], ['label'], ...} = dpoint1

Input

None

Output

  • connectionsInfo : A tuple of tuple of information for each connection. 

  • cnxInfo : Tuple of 2 dictionnaries (1 per datapoint)

  • class: Datapoint type, could be OP_TYPE_MODEL, OP_TYPE_PANEL or OP_TYPE_IO

  • position: Position in the panel (panel attribute). May be an empty string.

  • path: Datapoint path. May be an empty string.

  • type: Type. May be an empty string.

  • label: Datapoint label. May be an empty string.

  • size: Datapoint size in the panel (panel attribute). May be an empty string.

  • direction: Direction. May be an empty string.

  • uiName: UI name. May be an empty string.

  • simulinkId: Simulink ID. May be an empty string.

  • alias: Alias. May be an empty string.

Exception

  • ENOMEM: Memory allocation error.

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

  • EBADF: Project not specified by previous OpenProject

Examples

None

Related Items

None

Modules

import RtlabApi

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323