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.

DisplayInformation

Group

Utilities

Description

Get the compilation or execution messages as well as return the compilation or execution status. You must call RegisterDisplay before calling this function to indicate to the controller to send messages to the client.

Required Control

None

Usage

(done, displayId, results) = RtlabApi.DisplayInformation(timeout)

Input

  • timeout: Milliseconds to wait for available results. 0 = do not wait. OP_API_INFINITE = block for available results.

Output

  • done: Status of the compilation or the execution. Return True if the compilation has completed or execution has been reset.

  • displayId: Message’s source

    • 0: compilation

    • 1: Master subsystem

    • 2+: Slave subsystems

  • results: Compilation or execution messages.

Exception

  • EOK: Success.

  • EAGAIN: No more information to display.

  • OP_API_ESEPARATION: Error while separating the model's subsystems.

  • OP_API_ECODE_GENERATION: Error while generating code for the subsystems.

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

  • EBUSY: Model executables already loaded.

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

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

  • OP_API_ENO_PRODUCT: No license for RT-LAB and RT-LABx.

Examples

See example compilation.

Related Items

RegisterDisplay

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