Simulink Real-Time API for Microsoft .NET Framework

The Simulink^® Real-Time™ API for Microsoft^® .NET Framework consists of objects arranged in hierarchical order. Each of these objects has functions and properties that allow you to manipulate and interact with the API. The API provides various object types, including objects for the target computer, real-time applications, scopes, and the file system. You can use these API functions from languages and custom programs that support managed code, such as Microsoft Visual Studio^®, Windows^® PowerShell™, and MATLAB^®.

The Microsoft Windows API supplies the infrastructure for using threads. The Simulink Real-Time API for Microsoft .NET Framework builds on top of that infrastructure to provide a programming model that includes asynchronous support. You do not need prior knowledge of threads programming to use this API.

The Simulink Real-Time .NET object model closely models the Simulink Real-Time system, as shown in this conceptual diagram.

The API object hierarchy derived from the Simulink Real-Time system is shown in this conceptual diagram.

The key object types are xPCTargetPC, xPCApplication, and xPCFileSystem.

xPCTargetPC Class

The xPCTargetPC Class object represents the overall Simulink Real-Time system.

The xPCTargetPC object is at the root level of the object model. After you connect the .NET application running on the development computer to the real-time application running on the target computer, the object exposes session information. xPCTargetPC provides member functions that you use to access information and to manipulate the real-time application and the target computer file system.

An xPCTargetPC object contains two main object types, xPCApplication and xPCFileSystem.

xPCApplication Class

The xPCApplication Class object represents the real-time application that you generate from a Simulink model and download to the target computer.

With the xPCApplication object, you can access real-time application information, change application behavior, and access scope, signal, parameter, and data logging objects:

• xPCScopes Class — Represents a container or placeholder for Simulink Real-Time target, host, and file scopes.

• xPCSignals Class — Represents a container or placeholder for real-time application signals. With this object, you can access one or more xPCSignal objects.

• xPCSignal Class — Represents a specific signal, which represents the port signal of a nongraphical block output. With this object, you can access signal-related information and monitor signal behavior during simulation.

• xPCParameters Class — Represents a container or placeholder for real-time application parameters. With this object, you can access one or more xPCParameter objects.

• xPCParameter Class — Represents a specific parameter or a run-time parameter of a specific block. With this object, you can access block parameter information and tune parameter values during simulation.

• xPCAppLogger Class — Represents a placeholder for specific logging objects.

xPCFileSystem

An xPCFileSystem Class object represents the entire Simulink Real-Time file system.

An xPCFileSystem object contains objects like the following:

• xPCDriveInfo Class — Represents a volume drive that the target computer recognizes.

• xPCDirectoryInfo Class — Represents a target computer folder item.

• xPCFileInfo Class — Represents a target computer file item.