> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/error-codes/rt-lab-api-glossary.md).

# RT-LAB API Glossary

<table><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Active Model</strong></td><td>A model that is loaded on a target</td></tr><tr><td><strong>Alias Name Pattern</strong></td><td><p>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).</p><p>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.</p><ul><li>The '*' character will have the following semantic: "zero or more of whatever character(s)".</li><li>The '?' character will have the following semantic: "zero or one of whatever character".</li></ul><p><strong>Examples:</strong></p><p>alias pattern: my_alias</p><p>alias name matched: my_alias</p><p>alias pattern: /myPartition/my_alias</p><p>alias name matched: /myPartition/my_alias</p><p>alias pattern: /myPart*/my_alias</p><p>alias name matched: /myPartition/my_alias, /myParti/my_alias, /myPartController/my_alias, /myPart,</p><p>...</p><p>alias pattern: /myPartition/my_alia?</p><p>alias name matched: /myPartition/my_alias, /myPartition/my_alia</p></td></tr><tr><td><strong>Control Signals</strong></td><td>The control signals are transmitted from the console to the computation nodes in the same order as they are defined at the input of the OpComm block for the specified computation nodes.</td></tr><tr><td><strong>Instance ID</strong></td><td>A unique number assigned to a new model. The instance id is created when calling SetCurrentModel2.</td></tr><tr><td><strong>Global Settings</strong></td><td>Global settings are applied to all models unless explicitly overridden by local settings.</td></tr><tr><td><strong>Logical Id</strong></td><td><p>The logical ID is a unique identifier assigned to each subsystem of type SM, SC, or SS within a model. It is generated during model compilation and remains independent of the simulation target.<br>The SM subsystem is always assigned ID 1, and the SC subsystem is always assigned ID 2. The SS subsystem is assigned ID 2 when no console is present, and an ID greater than 2 when a console is included.<br>The logical Id can be obtained by calling the OpalGetSubsystemList function. master subsystem = 1, slave subsystem 1 = 2, slave subsystem 2 = 3.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Some API functions accept an Id of 0. This value means that the function is applied to all subsystems.</p></div></td></tr><tr><td><strong>Local Settings</strong></td><td>Local settings apply only to the local model.</td></tr><tr><td><strong>Time Factor</strong></td><td>The time factor is a multiplier applied to the calculation step to determine the effective calculation step.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/error-codes/rt-lab-api-glossary.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
