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.

GetSystemControl

Owned by Sylvain Ménard
Last updated: May 17, 2023
1 min read

Group

Model Execution

Description

Request or release the system control of the currently connected model. System control enables the client API to control the model's execution. Only one client API at a time is granted system control.

Required Control

None

Usage

RtlabApi.GetSystemControl(systemControl)

Input

  • systemControl: True(1) to request system control of the model, False(0) to release its control.

Output

None

Exception

  • EOK: Success.

  • EPERM: Control requested but already given to another client.

  • EBADF: Model not specified by previous Connect or OpenProject.

  • ENOMEM: Memory allocation error.

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

  • ESRCH: Model instance id not found.

Examples

See example basic_example1.

Related Items

Connect, ConnectByName, SetCurrentModel

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