Documentation

Simulink Real-Time .NET API

Alphabetical List By Category

Control and Instrumentation From Outside MATLAB

Control and Instrumentation Using .NET

Configuration and Execution of Real-Time Application Using .NET

xPCTargetPC Class Access target computer
xPCTargetPC Construct new instance of xPCTargetPC class
xPCTargetPC.Ping Test communication between development and target computers
xPCTargetPC.tcpPing Determine TCP/IP accessibility of remote computer
xPCTargetPC.Connect Establish connection to target computer
xPCTargetPC.ConnectAsync Asynchronous request for target computer connection
xPCTargetPC.Disconnect Disconnect from target computer
xPCTargetPC.DisconnectAsync Asynchronous request to disconnect from target computer
xPCTargetPC.Dispose Clean up used resources
xPCTargetPC.Reboot Restart target computer
xPCTargetPC.RebootAsync Asynchronous request to restart target computer
xPCTargetPC.Load Load real-time application onto target computer
xPCTargetPC.Unload Unload real-time application from target computer
xPCTargetPC.LoadAsync Asynchronous request to load real-time application onto target computer
xPCTargetPC.UnloadAsync Asynchronous request to unload real-time application from target computer
xPCApplication Class Access to real-time application loaded on target computer
xPCApplication.Start Start real-time application execution
xPCApplication.Stop Stop real-time application execution
xPCTargetPC.ConnectCompleted Event when xPCTargetPC.ConnectAsync is complete
xPCTargetPC.Connecting Event before xPCTargetPC.Connect starts
xPCTargetPC.Connected Event after xPCTargetPC.Connect is complete
xPCTargetPC.DisconnectCompleted Event when xPCTargetPC.DisconnectAsync is complete
xPCTargetPC.Disconnecting Event before xPCTargetPC.Disconnect starts
xPCTargetPC.Disconnected Event after xPCTargetPC.Disconnect is complete
xPCTargetPC.Disposed Event after xPCTargetPC.Dispose is complete
xPCTargetPC.Loaded Event after xPCTargetPC.Load is complete
xPCTargetPC.Loading Event before xPCTargetPC.Load starts
xPCTargetPC.LoadCompleted Event when xPCTargetPC.LoadAsync is complete
xPCTargetPC.Rebooting Event before xPCTargetPC.Reboot starts
xPCTargetPC.Rebooted Event after xPCTargetPC.Reboot is complete
xPCTargetPC.RebootCompleted Event when xPCTargetPC.RebootAsync is complete
xPCApplication.Starting Event before xPCApplication.Start executes
xPCApplication.Started Event after xPCApplication.Start is complete
xPCApplication.Stopping Event before xPCApplication.Stop executes
xPCApplication.Stopped Event after xPCApplication.Stop is complete
xPCTargetPC.UnloadCompleted Event when xPCTargetPC.UnloadAsync is complete
xPCTargetPC.Unloaded Event after xPCTargetPC.Unload is complete
xPCTargetPC.Unloading Event before xPCTargetPC.Unload starts
xPCAppStatus Enumerated Data Type Real-time application status return values
xPCProtocol Enumerated Data Type Development computer and target computer communication medium
ConnectCompletedEventArgs Class xPCTargetPC.ConnectCompleted event data
DisconnectCompletedEventArgs Class xPCTargetPC.DisconnectCompleted event data
RebootCompletedEventArgs Class xPCTargetPC.RebootCompleted event data
LoadCompletedEventArgs Class xPCTargetPC.LoadCompleted event data
UnloadCompletedEventArgs Class xPCTargetPC.UnloadCompleted event data
GetDataCompletedEventArgs Class GetDataCompleted event data
xPCException Class Information for xPCException
xPCException Construct new instance of xPCException class
xPCExceptionReason Enumerated Data Type Exception reasons

Signal Monitoring and Tracing Using .NET

xPCSignal Class Access signal objects
xPCSignals Class Access signal objects
xPCSignals.GetSignals List of xPCSignal objects specified by array of signal identifiers
xPCSignals.GetSignalsValue Vector of signal values from array
xPCSignals.Refresh Refresh state of object
xPCSignal.GetValue Value of signal at moment of request
xPCSignal.TryGetValue Status of get signal value at moment of request
xPCScope Class Access Simulink Real-Time scopes
xPCScopes Class Access scope objects
xPCScope.Start Start scope
xPCScope.Stop Stop scope
xPCScope.Trigger Software-trigger start of data acquisition for scope
xPCScopes.RefreshAll Refresh state of object
xPCTargetScope Class Access to target scopes
xPCTargetScopeCollection Class Collection of xPCTargetScope objects
xPCTargetScopeSignalCollection Class Collection of xPCHostScopeSignal objects
xPCTgtScopeSignal Class Access to target scope signals
xPCTargetScopeCollection.Add Create xPCTargetScope object
xPCTargetScopeSignalCollection.Add Create xPCTargetScopeSignal object
xPCTargetScopeCollection.StartAll Start all target scopes in one call
xPCTargetScopeCollection.StopAll Stop all target scopes in one call
xPCTargetScopeCollection.Refresh Refresh target scope object state
xPCTargetScopeSignalCollection.Refresh Synchronize signals for associated target scopes on target computer
xPCHostScope Class Access to host scopes
xPCHostScopeCollection Class Collection of xPCHostScope objects
xPCHostScopeSignal Class Access to host scope signals
xPCHostScopeSignalCollection Class Collection of xPCHostScopeSignal objects
xPCHostScopeCollection.Add Create xPCHostScope object with next available scope ID as key
xPCHostScopeSignalCollection.Add Add signals to host scope
xPCHostScopeCollection.StartAll Start all host scopes in one call
xPCHostScopeCollection.StopAll Stop all host scopes in one call
xPCDataHostScSignalObject.GetData Copy host scope signal data from target computer
xPCDataHostScSignalObject.GetDataAsync Asynchronously copy host scope signal data from target computer
xPCHostScopeCollection.Refresh Refresh host scope object state
xPCHostScopeSignalCollection.Refresh Synchronize signals for associated host scopes on target computer
xPCScope.ScopeStarting Event before xPCScope.Start executes
xPCScope.ScopeStarted Event after xPCScope.Start is complete
xPCScope.ScopeStopping Event before xPCScope.Stop executes
xPCScope.ScopeStopped Event after xPCScope.Stop is complete
xPCDataHostScSignalObject.GetDataCompleted Event when xPCDataHostScSignalObject.GetDataAsync is complete
xPCException Class Information for xPCException
xPCException Construct new instance of xPCException class
xPCExceptionReason Enumerated Data Type Exception reasons
GetHostScSignalDataObjectCompletedEventArgs Class xPCDataHostScSignalObject.DataObjectCompleted event data
xPCScopeCollectionEventArgs Class xPCScopeCollection.Added event data
xPCScopeRemCollectionEventArgs Class xPCScopeCollection.Removed event data
xPCScopeSignalCollectionEventArgs Class xPCScopeSignalCollection.Added event data
SCDISPLAYMODE Enumerated Data Type Target scope display mode values
SCSTATUS Enumerated Data Type Scope status values
SCTRIGGERMODE Enumerated Data Type Scope trigger mode values
SCTRIGGERSLOPE Enumerated Data Type Scope trigger slope values
SCTYPE Enumerated Data Type Scope type

Signal Logging Using .NET

xPCScope Class Access Simulink Real-Time scopes
xPCScopes Class Access scope objects
xPCScope.Start Start scope
xPCScope.Stop Stop scope
xPCScope.Trigger Software-trigger start of data acquisition for scope
xPCScopes.RefreshAll Refresh state of object
xPCFileScope Class Access to file scopes
xPCFileScopeCollection Class Collection of xPCFileScope objects
xPCFileScopeSignal Class Access to file scope signals
xPCFileScopeSignalCollection Class Collection of xPCFileScopeSignal objects
xPCSignal Class Access signal objects
xPCSignals Class Access signal objects
xPCFileScopeCollection.Add Create xPCFileScope object with next available scope ID as key
xPCFileScopeSignalCollection.Add Add signals to file scope
xPCFileScopeCollection.StartAll Start all file scopes in one call
xPCFileScopeCollection.StopAll Stop all file scopes in one call
xPCFileScopeCollection.Refresh Synchronize with file scopes on target computer
xPCFileScopeSignalCollection.Refresh Synchronize with signals for associated scope on target computer
xPCDataFileScSignalObject.GetData Copy file scope signal data from target computer
xPCDataFileScSignalObject.GetDataAsync Asynchronously copy file scope signal data from target computer
xPCLog Class Base data logging class
xPCAppLogger Class Access to real-time application loggers
xPCDataFileScSignalObject Class Object that holds logged file scope signal data
xPCDataHostScSignalObject Class Object that holds logged host scope signal data
xPCDataLoggingObject Class Object that holds logged data
xPCOutputLogger Class Access to output logger
xPCStateLogger Class Access to state log
xPCTETLogger Class Access to task execution time (TET) logger
xPCTimeLogger Class Access to output log
xPCDataLoggingObject.GetData Copy signal data from target computer
xPCDataLoggingObject.GetDataAsync Asynchronously copy signal data from target computer
xPCFileSystem Class File system drives and folders
xPCFileSystemInfo Class File system information
xPCDirectoryInfo Class Access folders and subfolders of target computer file system
xPCDriveInfo Class Information for target computer drive
xPCFileSystem.CreateDirectory Create folder
xPCFileSystem.GetDrives Drive names for logical drives on target computer
xPCFileSystem.RemoveFile Remove file name from target computer
xPCFileSystem.SetCurrentDirectory Current folder
xPCFileSystem.GetCurrentDirectory Current working folder for real-time application
xPCFileSystemInfo.Delete Delete current file or folder
xPCFileSystemInfo Construct new instance of xPCFileSystemInfo class
xPCDriveInfo Construct new instance of xPCDriveInfo class
xPCDriveInfo.Refresh Synchronize with file drives on target computer
xPCDirectoryInfo Construct new instance of xPCDirectoryInfo class on specified path
xPCDirectoryInfo.Create Create folder
xPCDirectoryInfo.Delete Delete empty xPCDirectoryInfo object
xPCDirectoryInfo.GetDirectories Subfolders of current folder
xPCDirectoryInfo.GetFiles File list from current folder
xPCDirectoryInfo.GetFileSystemInfos File system information for files and subfolders in folder
xPCFileInfo Class Access to file and xPCFileStream objects
xPCFileStream Class Access xPCFileStream objects
xPCFileInfo Construct new instance of xPCFileInfo class
xPCFileInfo.Open Open file
xPCFileInfo.OpenRead Create read-only xPCFileStream object
xPCFileInfo.CopyToHost Copy file from target computer file system to development computer file system
xPCFileInfo.Create Create file in specified path
xPCFileInfo.Delete Permanently delete file on target computer
xPCFileInfo.Rename Rename file
xPCFileStream Construct new instance of xPCFileStream class
xPCFileStream.Write Write block of bytes to file stream
xPCFileStream.WriteByte Write byte to current position in file stream
xPCFileStream.Read Read block of bytes from stream and write data to buffer
xPCFileStream.Close Close current stream
xPCException Class Information for xPCException
xPCExceptionReason Enumerated Data Type Exception reasons
GetLogDataCompletedEventArgs Class xPCDataLoggingObject.GetDataCompleted event data
GetFileScSignalDataObjectCompletedEventArgs Class xPCDataFileScSignalObject.GetDataCompleted event data
xPCScopeCollectionEventArgs Class xPCScopeCollection.Added event data
xPCScopeRemCollectionEventArgs Class xPCScopeCollection.Removed event data
xPCScopeSignalCollectionEventArgs Class xPCScopeSignalCollection.Added event data
xPCScope.ScopeStarting Event before xPCScope.Start executes
xPCScope.ScopeStarted Event after xPCScope.Start is complete
xPCScope.ScopeStopping Event before xPCScope.Stop executes
xPCScope.ScopeStopped Event after xPCScope.Stop is complete
xPCDataFileScSignalObject.GetDataCompleted Event when xPCDataFileScSignalObject.GetDataAsync is complete
xPCDataLoggingObject.GetDataCompleted Event when xPCDataLoggingObject.GetDataAsync is complete
xPCException Construct new instance of xPCException class
xPCFileMode Enumerated Data Type Open file with permissions
xPCLogMode Enumerated Data Type Specify log mode values
xPCLogType Enumerated Data Type Logging type values
SCFILEMODE Enumerated Data Type Write mode values for when file allocation table entry is updated

Parameter Tuning Using .NET

xPCParameter Class Single run-time tunable parameter
xPCParameters Class Access run-time parameters
xPCParameter.GetParam Get parameter values from target computer
xPCParameter.GetParamAsync Asynchronous request to get parameter values from target computer
xPCParameters.LoadParameterSet Load parameter values for real-time application
xPCParameters.Refresh Refresh state of object
xPCParameters.SaveParameterSet Save parameter values of real-time application
xPCParameter.SetParam Change value of parameter on target computer
xPCParameter.SetParamAsync Asynchronous request to change parameter value on target computer
xPCParameter.GetParamCompleted Event when xPCParameter.GetParamAsync is complete
xPCParameter.SetParamCompleted Event when xPCParameter.SetParamAsync is complete
CancelPropertyNotificationEventArgs Class CancelPropertyNotification event data
GetParamCompletedEventArgs Class xPCParameter.GetParamCompleted event data
PropertyNotificationEventArgs Class PropertyNotification event data
SetParamCompletedEventArgs Class xPCParameter.SetParamCompleted event data
xPCException Construct new instance of xPCException class
Was this topic helpful?