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.

SetTimeFactor

Owned by Sylvain Ménard
Last updated: May 17, 2023
1 min read

Group

Model Execution

Description

Set the value of the time factor. When in real-time mode, the execution rate is the model's sampling rate times the time factor.

Required Control

System Control

Usage

RtlabApi.SetTimeFactor(timeFactor)

Input

  • timeFactor: See Glossary.

Output

None

Exception

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

  • EINVAL: Invalid time factor.

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

Examples

None

Related Items

Execute, GetTimeInfo.

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
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter