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.

GetSubsystemList

Group

Model Preparation

Description

Return the list of subsystems in the current model: their name, their logical id and the name of the physical node on which each is assigned. The physical node name is an empty string when the subsystem has not yet been assigned to a physical node.

Required Control

None

Usage

(subsystemInfo1, subsystemInfo2, ...) = RtlabApi.GetSubsystemList()

(subsystemName, logicalId, physNodeName) = subsystemInfo1

...

Input

None

Output

  • subsystemInfo N: Tuple of information of the subsystem N.

  • subsysName: Name of the subsystem.

  • logicalId: Id of the subsystem. See Glossary.

  • physicalNodeName: Name of the physical node associated to the subsystem.

Exception

  • EOK: Success.

  • E2BIG: Specified storage not big enough to receive values.

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

  • ESRCH: Model has not been compiled yet.

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

Examples

See example configuration.

Related Items

None

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