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 4 Current »

Group

Model Execution
Description

Requests or releases 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 SetCurrentModel.
  • ENOMEM: Memory allocation error.
  • EIO: Error sending the request or receiving the reply.
  • ESRCH: Model instance id not found.
ExamplesSee example basic_example1.
Related ItemsConnect, ConnectByName, SetCurrentModel
Modulesimport RtlabApi
  • No labels

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter