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

Version 1 Next »

Group

Model Selection
Description

Note: This function is for backward compatibility only. Please consider using GetActiveProjects instead. 

Returns a list of active models (see Glossary). The returned names include the file extension (if any) of the original model file.

Required Control

None
Usage

(modelInfo1, modelInfo2,...) = RtlabApi.GetActiveModels()

(name, path, instId, host, ipAddr, state, assignations) = modelInfo1

(subsystemName1, targetName1, subsystemName2, targetName2,...) = assignations

Input

None

Output
  • modelInfo: Model’s information: filename, filepath, instance id, host name, ip address, model’s state, and subsystem assignation
  • name: Model’s name.
  • path: Model’s path.
  • instId: Model’s instance id.
  • host: Host name where the controller resides.
  • ipAddress: Host ip address where the controller resides.
  • assignation: For each subsystem, a tuple containing the assignation between the subsystem and the target.
Exception
  • EIO: Error sending the request or receiving the reply.
  • E2BIG: specified storage not big enough to receive values.
  • ENOMEM: Internal memory allocation error.
  • OP_API_EBAD_CONFIG: Node mapping not valid or IP address of controller machine not specified (environment variable OPAL_META_CTL_IP not set).
ExamplesNone
Related ItemsDisconnect, SetCurrentModel, ConnectByName.
Modulesimport RtlabApi
  • No labels