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.

SetDecimationFactor

Group

Model Configuration, Acquisition

Description

Set the decimation factor to use when getting data for the specified acquisition group. The change is persistent and is used in subsequent runs of the model.

Required Control

Acquisition Control

Usage

RtlabApi.SetDecimationFactor(acqGroup, decimationFactor)

Input

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

  • decimationFactor: Value of the decimation factor to set for the specified acquisition group.

Output

None

Exception

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

  • EINVAL: invalid acquisition group or specified decimation factor is out of range.

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

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

  • EFAULT: Warning: Time factor differs from 1.0.

  • EACCES: Error saving parameters to .probe file.

  • OP_API_MODEL_IO_TIMEOUT: Timed out waiting for a reply from the model.

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

Examples

None

Related Items

SetFillDecimation

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