RT-LAB API | ORCHESTRA

This chapter serves as an introduction to the RT-LAB Orchestra Application Programming Interface (RTAPI). Refer to the RT-LAB Connectivity chapter of the RT-LAB user guide for a general description of RT-LAB Orchestra, and for the definition of the terms used below.

The RTAPI is used by a C code External Component to exchange data with a domain created by an RTLAB framework. The data exchange within an RT-LAB Orchestra co-simulation follows a publish/subscribe mechanism. The exchanged data is referred to as a list of data items names whose union forms a domain.

Data items are published (sent to an RT-LAB framework) and subscribed to (received from an RT-LAB framework) by calling RTPublish() and RTSubscribe() respectively. The data exchange can be synchronous or asynchronous, as specified in the DDF. For a synchronous connection, calls to RTPublish() and RTSubscribe() must be enclosed in calls to functions that provide a locking mechanism.

Prior to exchanging data, a connection to a domain must be established by calling RTConnect().

Disconnection from a domain is performed by calling RTDisconnect().

Examples
A C code sample that contains calls to the RTAPI is provided in the RT-LAB distribution under the directory <RT-LAB installation dir>\Examples\Features\Orchestra\C_Code\src.

• RT-LAB | ORCHESTRA: Functions Reference