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.

GetModelState

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

Group

Model Execution

Description

Return the state of the currently connected model and its simulation mode.

Required Control

None

Usage

(modelState, realTimeMode) = RtlabApi.GetModelState()

Input

None

Output

  • message: The state of the model. See OP_MODEL_STATE.

  • realTimeMode: The real-time mode of the model. See OP_REALTIME_MODE.

Exception

  • EOK: Success.

  • EINVAL: Not connected to model controller.

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

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

Examples

See example basic_example1.

Related Items

OP_MODEL_STATE, OP_REALTIME_MODE.

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