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.

GetActiveProjects

Group

Model Selection

Description

Return a list of active projects. For each project, this function returns the full path of the configuration file, the name and the IP address of the machine that opened this project, the instance ID of the current project session, and the list of models belonging to this project. For each model, path, ID and state are returned.

Required Control

None

Usage

(projectInfo1, projectInfo2,...) = RtlabApi.GetActiveProjects()

(project_path, project_instance_id, controller_machine_name, controller_ip_address, number_of_models, models) = projectInfo1

(modelInfo1, modelInfo2,...) = models

(model_path, model_instance_id, model_state) = modelInfo1

Input

None

Output

1 tuple per active project:

  • project_path: path of the active project’s configuration file

  • project_instance_id: instance Identifier of the active project

  • controller_machine_name: controller machine name

  • controller_ip_address: controller's IP address and port number

  • number_of_models: number of models in the project

  • 1 tuple per model:

    • model_path: model's path

    • model_id: model identifier (1 .. number_of_models)

    • model_state: model's state (cf. OP_MODEL_STATE)

Return value

  • EOK: Success.

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

Examples

None

Related items

OpenProject

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