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.

C-API | Glossary


Active Model

A model that is loaded on a target.

Alias Name Pattern

An 'alias pattern' is a character string. This character string is used to describe an alias name or a range of acceptable alias names. An alias name is said to 'match' an 'alias pattern' if it is part of the range of acceptable alias names that the pattern describes. The alias name that matches the pattern is called 'a match' (or a list of matches if there is more that one).

An alias pattern can contain any character. Some characters have a special meaning: '*' and '?'. When found in an alias, these "wildcard" characters will be interpreted, meaning that they will NOT be considered as a specific part of the alias name to match.

  • The '*' character will have the following semantic: "zero or more of whatever character(s)".
  • The '?' character will have the following semantic: "zero or one of whatever character".


alias pattern: my_alias

alias name matched: my_alias

alias pattern: /myPartition/my_alias

alias name matched: /myPartition/my_alias

alias pattern: /myPart*/my_alias

alias name matched: /myPartition/my_alias, /myParti/my_alias, /myPartController/my_alias, /myPart,


alias pattern: /myPartition/my_alia?

alias name matched: /myPartition/my_alias, /myPartition/my_alia


Control Signals

The control signals are the signals sent from the console to the computation nodes in the same order than specified at the input of the OpComm of the specified computation nodes.


Instance ID

A unique number assigned to a new model. The instance id is created when calling SetCurrentModel2.


Global Settings

These settings apply to all models when not overridden by local settings.


Logical Id

A unique number associated with each subsystem of type SM, SC or SS in a model. This number is assigned during the compilation of the model and is independent of the target where the simulation is performed. The SM subsystem is always assigned Id 1, the SC subsystem is always assigned Id 2 and the SS subsystem is assigned Id 2 if there is no console and a value greater than 2 if there is a console.

The logical Id can be obtained by calling the OpalGetSubsystemList function. master subsystem = 1, slave subsystem 1 = 2, slave subsystem 2 = 3.

Note: some API functions accept an Id of 0. This value means that the function is applied to all subsystems.

Local Settings

These settings apply only to the local model.


Time Factor

The value used as a multiplication factor with the calculation step to obtain the effective calculation step.

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | | +1 514-935-2323