Versions Compared

Old Version 1

changes.mady.by.user Amira Aouina

Saved on

compared with

New Version Current

changes.mady.by.user Amira Aouina

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Page Content

Table of Contents
minLevel1
maxLevel6
include
outlinefalse
indent
styledefault
excludePage Content
typelist
class
printabletrue

...

The MetaController is a small program that runs in the background of RT-LAB on the host computer. It is usually launched automatically when the main RT-LAB UI is started, but can also be started manually or programmaticallyby scripting. It is visible in the list of processes on the operating system and can be accessed on Windows in the Windows tray icons toolbar with this specific icon (circled in red):

...

The role of the MetaController is to manage other background processes of RT-LAB, especially the Controller.exe applications that are spawned when projects are opened. The MetaController also manages the OpalDLoader executable which is automatically launched when the MetaController starts and closed when the MetaController exits.

The MetaController is an essential process for the proper operation of RT-LAB and its API. The MetaController should always be running whenever RT-LAB, or its API, are in use. Also, the MetaController should not be stopped or restarted while other RT-LAB processes (RT-LAB.exe, Controller.exe) are running.

The MetaController executable is typically located in <RTat “<RT-LAB Installation path>\common\bin\MetaController.exeexe”, unless a different path was specified during the installation of RT-LAB.

...

There are two ways the MetaController can be started:

  1. Automatically launched , whenever the main RT-LAB UI (RT-LAB.exe) is started. This will be the most common workflow case for most users.

    When the RT-LAB UI starts up, if it detects the MetaController is not currently running, it will automatically launch a MetaController and the MetaController tray icon will become visible in the tray icons toolbarsystem tray of the Windows taskbar. However, if a MetaController from the same RT-LAB version was is already running when the UI is launched, the already running MetaController will be used. If the running MetaController is from another RT-LAB version, it will automatically be closed and the correct appropriate MetaController will be launched.

  2. If the user does not intend to use the UI and relies on the API to control simulations, the MetaController must first be started manually , programmatically or from a program or by scripting. This must be done before any calls to the API are to be made.

Infonote

Whenever the MetaController is started manually or programmaticallyfrom a script, it is primordial to ensure the MetaController executable from the correct RT-LAB version is used.

Closing the MetaController

If the MetaController was is automatically launched by the RT-LAB UI, the UI will also close it automatically in the processas it itself closes, unless a project remains active. However, if the MetaController was is already running when RT-LAB was is launched, the MetaController will remain running even after the UI closes.

If the MetaController was started manually or programmaticallyby a script or a program, the MetaController process can be closed either by:

  • Right-click clicking on the MetaController icon in the system tray icon and selecting Exit:

    image-20240903-193152.pngImage Modified

  • Invoking the (Opal)CloseMetaController API call

Infonote

Terminating brutally the MetaController through system calls or the operating system is not recommended and should be kept as a last resort solution.

System Tray

...

Icon Menu

When right-clicking on the MetaController icon in the system tray icon, a small menu will appear offering the following options:

...

RT-LAB

Launch RT-LAB. The same effect can be achieved by double-clicking on the MetaController icon in the system tray icon.

ScopeView

Launch ScopeView

Help

Open the RT-LAB help.

Exit

Close the MetaController

Note

Beware: This will close only the MetaController and should be performed only when all other RT-LAB processes (RT-LAB.exe, Controller.exe) are closed. Unpredictable behavior may occur otherwise.

Command line options

When launching the MetaController through command line or programmatically, the following options can be passed as arguments:

-noUI

Windows only. Disables the creation of a icon in the system tray icon and GUI for the MetaController.

Note

IMPORTANT: Using this option is essential when RT-LAB is to be used in a fully automated context, such as continuous integration, where RT-LAB executes in a OS environment without graphical interface. Not using this option in this context may result in unpredictable behavior.

-launchUI

Windows only. After completing its launch, the MetaController will automatically launch the main RT-LAB UI. Should It should not be combined with the -noUI option.