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.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Group

Connections
Description

Gets 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
ExamplesNone
Related ItemsNone
Modulesimport RtlabApi
  • No labels