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.

GetAcquisitionControl

Group

Model Configuration, Acquisition

Description

Request or release the acquisition control of the currently connected model. Acquisition control enables the client API to control the model's acquisition parameters for a specific acquisition group. Only one client API at a time is granted acquisition control for a specific acquisition group.

Required Control

None

Usage

RtlabApi.GetAcquisitionControl(acqControl, acqGroup)

Input

  • acqControl: True(1) to request acquisition control for the specified acquisition group, False(0) to release its control.

  • acqGroup: Group for which acquisition control is requested (numbering starts at 0).

Output

None

Exception

  • 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.

  • EINVAL: Invalid acquisition group.

Examples

See example dynamic_acq.

Related Items

None

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