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.

SetAcqWriteFile

Group

Model Configuration, Acquisition

Description

Set the filename to be used when acquiring data for a group into a file. Also allow enabling or disabling WriteFile. The running console which was getting data from the specified acquisition group will stop receiving any data for this group. The data are writing to a file on the target.

The change is persistent and is used in subsequent runs of the model. The change affects any application acquiring data from this group.

Required Control

Acquisition Control

Usage

RtlabApi.SetAcqWriteFile(acqGroup, fileName, varName, enabled)

Input

  • acqGroup: Acquisition group (numbering starts at 0).

  • fileName: Name of the file to write.

  • varName: Name of the variable wriiten in the file.

  • enabled: TRUE (1) to start the data logging, FALSE (0) to stop it.

Output

None

Exception

  • EPERM: System control had not been granted to this client.

  • EINVAL: Invalid acquisition group.

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

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

  • EFAULT: Invalid write file name or invalid variable name.

  • EACCES: Error saving parameters to .probe file.

  • E2BIG: Filename or variable name too big.

  • OP_API_MODEL_IO_TIMEOUT: Timed out waiting for reply from model.

  • OP_API_MODEL_IO_ERROR: Model is missing some or all processes or subsystems.

Examples

None

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