Application Programming Interfaces (APIs)

The programming interface into the SimWB real-time simulation system is defined by a family of APIs. The documentation is available from within the Control Center via the Help menu. PDFs of the individual API reference manuals are also installed.

The reference manuals describe the functions included in the APIs:

•   Client API Reference Manual – documents a network based API that provides access to the real-time host system via a TCP/IP network layer. A program or user who wants access into the real-time host must first authenticate itself via a user login call. The configuration server application is the other end point of the connection on the real-time host system. Most API calls in this category go through the configuration server.

This API is divided into 5 modules:

•   Client Configuration API – functions to access and configure the RT Host RTDB via the network connection

•   Test Configuration API – functions to configure tests and test sessions and defining software resources

•   Logging Daemon Access API – functions to register with the message logging daemon and send messages to the test system log

•   ‘C’ String and Dictionary API – helper functions to create string lists and dictionaries in ‘C’

•   RTDB Utility API – utility functions for interpreting RTDB values

•   C Script API Reference Manual – documents the API for writing C language scripts, including attaching wave generators to RTDB items and wait functions. The script user program can also use the Real-Time API to access the RTDB.

•   Real-Time API Reference Manual – documents the API designed to be used by any programs running on the real-time host system to access the RTDB. It provides function to map the RTDB into the process addressing space and set or get the values of any RTDB items.

•   Test Scripting Macros Reference Manual – documents the macros provided for SWs files, which simplifies the writing of scripts in the C programming language.

•   TODO: Python API

•   TODO: Java API.

•   Data Logger Access API Reference Manual – documents the API designed to be used by programs that have direct access to the data logger file system where the binary data file resides. It provides a limited number of calls to read binary data logging files and query test logging information.