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.

GetMonitoringControl

Group

Model Interaction, Monitoring

Description

Request or release the monitoring control of the currently connected model. Monitoring control allows the client API to take and restore the snapshot and also to configure the monitoring settings. Only one client API at a time is granted monitoring control.

Required Control

None

Usage

RtlabApi.GetMonitoringControl(monitoringControl)

Input

  • monitoringControl: True(1) to request monitoring 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.

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

  • ENOMEM: Memory allocation error.

  • ESRCH: Model instance id not found.

Examples

See example snapshot.

Related Items

Snapshot

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