Documentation

Simulink Real-Time .NET API

Alphabetical List By Category

Standalone Operation

Control and Instrumentation with .NET

Configuration and Execution of Real-Time Application with .NET

xPCTargetPC ClassAccess target computer
xPCTargetPCConstruct new instance of xPCTargetPC class
xPCTargetPC.PingTest communication between development and target computers
xPCTargetPC.tcpPingDetermine TCP/IP accessibility of remote computer
xPCTargetPC.ConnectEstablish connection with target computer
xPCTargetPC.ConnectAsyncAsynchronous request for target computer connection
xPCTargetPC.DisconnectDisconnect from target computer
xPCTargetPC.DisconnectAsyncAsynchronous request to disconnect from target computer
xPCTargetPC.DisposeClean up used resources
xPCTargetPC.RebootRestart target computer
xPCTargetPC.RebootAsyncAsynchronous request to restart target computer
xPCTargetPC.LoadLoad real-time application onto target computer
xPCTargetPC.UnloadUnload real-time application from target computer
xPCTargetPC.LoadAsyncAsynchronous request to load real-time application onto target computer
xPCTargetPC.UnloadAsyncAsynchronous request to unload real-time application from target computer
xPCApplication ClassAccess to real-time application loaded on target computer
xPCApplication.StartStart real-time application execution
xPCApplication.StopStop real-time application execution
xPCTargetPC.ConnectCompletedEvent when xPCTargetPC.ConnectAsync is complete
xPCTargetPC.ConnectingEvent before xPCTargetPC.Connect starts
xPCTargetPC.ConnectedEvent after xPCTargetPC.Connect is complete
xPCTargetPC.DisconnectCompletedEvent when xPCTargetPC.DisconnectAsync is complete
xPCTargetPC.DisconnectingEvent before xPCTargetPC.Disconnect starts
xPCTargetPC.DisconnectedEvent after xPCTargetPC.Disconnect is complete
xPCTargetPC.DisposedEvent after xPCTargetPC.Dispose is complete
xPCTargetPC.LoadedEvent after xPCTargetPC.Load is complete
xPCTargetPC.LoadingEvent before xPCTargetPC.Load starts
xPCTargetPC.LoadCompletedEvent when xPCTargetPC.LoadAsync is complete
xPCTargetPC.RebootingEvent before xPCTargetPC.Reboot starts
xPCTargetPC.RebootedEvent after xPCTargetPC.Reboot is complete
xPCTargetPC.RebootCompletedEvent when xPCTargetPC.RebootAsync is complete
xPCApplication.StartingEvent before xPCApplication.Start executes
xPCApplication.StartedEvent after xPCApplication.Start is complete
xPCApplication.StoppingEvent before xPCApplication.Stop executes
xPCApplication.StoppedEvent after xPCApplication.Stop is complete
xPCTargetPC.UnloadCompletedEvent when xPCTargetPC.UnloadAsync is complete
xPCTargetPC.UnloadedEvent after xPCTargetPC.Unload is complete
xPCTargetPC.UnloadingEvent before xPCTargetPC.Unload starts
ConnectCompletedEventArgs ClassxPCTargetPC.ConnectCompleted event data
DisconnectCompletedEventArgs ClassxPCTargetPC.DisconnectCompleted event data
RebootCompletedEventArgs ClassxPCTargetPC.RebootCompleted event data
LoadCompletedEventArgs ClassxPCTargetPC.LoadCompleted event data
UnloadCompletedEventArgs ClassxPCTargetPC.UnloadCompleted event data
GetDataCompletedEventArgs ClassGetDataCompleted event data
xPCException ClassInformation for xPCException
xPCExceptionConstruct new instance of xPCException class
xPCAppStatus Enumerated Data TypeReal-time application status return values
xPCProtocol Enumerated Data TypeDevelopment computer and target computer communication medium
xPCExceptionReason Enumerated Data TypeException reasons

Signal Monitoring and Tracing with .NET

xPCSignal ClassAccess signal objects
xPCSignals ClassAccess signal objects
xPCSignals.GetSignalsList of xPCSignal objects specified by array of signal identifiers
xPCSignals.GetSignalsValueVector of signal values from array
xPCSignals.RefreshRefresh state of object
xPCSignal.GetValueValue of signal at moment of request
xPCSignal.TryGetValueStatus of get signal value at moment of request
xPCScope ClassAccess Simulink Real-Time scopes
xPCScopes ClassAccess scope objects
xPCScope.StartStart scope
xPCScope.StopStop scope
xPCScope.TriggerSoftware-trigger start of data acquisition for scope
xPCScopes.RefreshAllRefresh state of object
xPCTargetScope ClassAccess to target scopes
xPCTargetScopeCollection ClassCollection of xPCTargetScope objects
xPCTargetScopeSignalCollection ClassCollection of xPCHostScopeSignal objects
xPCTgtScopeSignal ClassAccess to target scope signals
xPCTargetScopeCollection.AddCreate xPCTargetScope object
xPCTargetScopeSignalCollection.AddCreate xPCTargetScopeSignal object
xPCTargetScopeCollection.StartAllStart all target scopes in one call
xPCTargetScopeCollection.StopAllStop all target scopes in one call
xPCTargetScopeCollection.RefreshRefresh target scope object state
xPCTargetScopeSignalCollection.RefreshSynchronize signals for associated target scopes on target computer
xPCHostScope ClassAccess to host scopes
xPCHostScopeCollection ClassCollection of xPCHostScope objects
xPCHostScopeSignal ClassAccess to host scope signals
xPCHostScopeSignalCollection ClassCollection of xPCHostScopeSignal objects
xPCHostScopeCollection.AddCreate xPCHostScope object with next available scope ID as key
xPCHostScopeSignalCollection.AddAdd signals to host scope
xPCHostScopeCollection.StartAllStart all host scopes in one call
xPCHostScopeCollection.StopAllStop all host scopes in one call
xPCDataHostScSignalObject.GetDataCopy host scope signal data from target computer
xPCDataHostScSignalObject.GetDataAsyncAsynchronously copy host scope signal data from target computer
xPCHostScopeCollection.RefreshRefresh host scope object state
xPCHostScopeSignalCollection.RefreshSynchronize signals for associated host scopes on target computer
xPCScope.ScopeStartingEvent before xPCScope.Start executes
xPCScope.ScopeStartedEvent after xPCScope.Start is complete
xPCScope.ScopeStoppingEvent before xPCScope.Stop executes
xPCScope.ScopeStoppedEvent after xPCScope.Stop is complete
xPCDataHostScSignalObject.GetDataCompletedEvent when xPCDataHostScSignalObject.GetDataAsync is complete
GetHostScSignalDataObjectCompletedEventArgs ClassxPCDataHostScSignalObject.DataObjectCompleted event data
xPCScopeCollectionEventArgs ClassxPCScopeCollection.Added event data
xPCScopeRemCollectionEventArgs ClassxPCScopeCollection.Removed event data
xPCScopeSignalCollectionEventArgs ClassxPCScopeSignalCollection.Added event data
xPCException ClassInformation for xPCException
xPCExceptionConstruct new instance of xPCException class
xPCExceptionReason Enumerated Data TypeException reasons
SCDISPLAYMODE Enumerated Data TypeTarget scope display mode values
SCSTATUS Enumerated Data TypeScope status values
SCTRIGGERMODE Enumerated Data TypeScope trigger mode values
SCTRIGGERSLOPE Enumerated Data TypeScope trigger slope values
SCTYPE Enumerated Data TypeScope type

Signal Logging with .NET

xPCScope ClassAccess Simulink Real-Time scopes
xPCScopes ClassAccess scope objects
xPCScope.StartStart scope
xPCScope.StopStop scope
xPCScope.TriggerSoftware-trigger start of data acquisition for scope
xPCScopes.RefreshAllRefresh state of object
xPCFileScope ClassAccess to file scopes
xPCFileScopeCollection ClassCollection of xPCFileScope objects
xPCFileScopeSignal ClassAccess to file scope signals
xPCFileScopeSignalCollection ClassCollection of xPCFileScopeSignal objects
xPCSignal ClassAccess signal objects
xPCSignals ClassAccess signal objects
xPCFileScopeCollection.AddCreate xPCFileScope object with next available scope ID as key
xPCFileScopeSignalCollection.AddAdd signals to file scope
xPCFileScopeCollection.StartAllStart all file scopes in one call
xPCFileScopeCollection.StopAllStop all file scopes in one call
xPCFileScopeCollection.RefreshSynchronize with file scopes on target computer
xPCFileScopeSignalCollection.RefreshSynchronize with signals for associated scope on target computer
xPCDataFileScSignalObject.GetDataCopy file scope signal data from target computer
xPCDataFileScSignalObject.GetDataAsyncAsynchronously copy file scope signal data from target computer
xPCLog ClassBase data logging class
xPCAppLogger ClassAccess to real-time application loggers
xPCDataFileScSignalObject ClassObject that holds logged file scope signal data
xPCDataHostScSignalObject ClassObject that holds logged host scope signal data
xPCDataLoggingObject ClassObject that holds logged data
xPCOutputLogger ClassAccess to output logger
xPCStateLogger ClassAccess to state log
xPCTETLogger ClassAccess to task execution time (TET) logger
xPCTimeLogger ClassAccess to output log
xPCDataLoggingObject.GetDataCopy signal data from target computer
xPCDataLoggingObject.GetDataAsyncAsynchronously copy signal data from target computer
xPCFileSystem ClassFile system drives and folders
xPCFileSystemInfo ClassFile system information
xPCDirectoryInfo ClassAccess folders and subfolders of target computer file system
xPCDriveInfo ClassInformation for target computer drive
xPCFileSystem.CreateDirectoryCreate folder
xPCFileSystem.GetDrivesDrive names for logical drives on target computer
xPCFileSystem.RemoveFileRemove file name from target computer
xPCFileSystem.SetCurrentDirectoryCurrent folder
xPCFileSystem.GetCurrentDirectoryCurrent working folder for real-time application
xPCFileSystemInfo.DeleteDelete current file or folder
xPCFileSystemInfoConstruct new instance of xPCFileSystemInfo class
xPCDriveInfoConstruct new instance of xPCDriveInfo class
xPCDriveInfo.RefreshSynchronize with file drives on target computer
xPCDirectoryInfoConstruct new instance of xPCDirectoryInfo class on specified path
xPCDirectoryInfo.CreateCreate folder
xPCDirectoryInfo.DeleteDelete empty xPCDirectoryInfo object
xPCDirectoryInfo.GetDirectoriesSubfolders of current folder
xPCDirectoryInfo.GetFilesFile list from current folder
xPCDirectoryInfo.GetFileSystemInfosFile system information for files and subfolders in folder
xPCFileInfo ClassAccess to file and xPCFileStream objects
xPCFileStream ClassAccess xPCFileStream objects
xPCFileInfoConstruct new instance of xPCFileInfo class
xPCFileInfo.OpenOpen file
xPCFileInfo.OpenReadCreate read-only xPCFileStream object
xPCFileInfo.CopyToHostCopy file from target computer file system to development computer file system
xPCFileInfo.CreateCreate file in specified path
xPCFileInfo.DeletePermanently delete file on target computer
xPCFileInfo.RenameRename file
xPCFileStreamConstruct new instance of xPCFileStream class
xPCFileStream.WriteWrite block of bytes to file stream
xPCFileStream.WriteByteWrite byte to current position in file stream
xPCFileStream.ReadRead block of bytes from stream and write data to buffer
xPCFileStream.CloseClose current stream
xPCScope.ScopeStartingEvent before xPCScope.Start executes
xPCScope.ScopeStartedEvent after xPCScope.Start is complete
xPCScope.ScopeStoppingEvent before xPCScope.Stop executes
xPCScope.ScopeStoppedEvent after xPCScope.Stop is complete
xPCDataFileScSignalObject.GetDataCompletedEvent when xPCDataFileScSignalObject.GetDataAsync is complete
xPCDataLoggingObject.GetDataCompletedEvent when xPCDataLoggingObject.GetDataAsync is complete
GetLogDataCompletedEventArgs ClassxPCDataLoggingObject.GetDataCompleted event data
GetFileScSignalDataObjectCompletedEventArgs ClassxPCDataFileScSignalObject.GetDataCompleted event data
xPCScopeCollectionEventArgs ClassxPCScopeCollection.Added event data
xPCScopeRemCollectionEventArgs ClassxPCScopeCollection.Removed event data
xPCScopeSignalCollectionEventArgs ClassxPCScopeSignalCollection.Added event data
xPCException ClassInformation for xPCException
xPCExceptionConstruct new instance of xPCException class
xPCExceptionReason Enumerated Data TypeException reasons
xPCFileMode Enumerated Data TypeOpen file with permissions
xPCLogMode Enumerated Data TypeSpecify log mode values
xPCLogType Enumerated Data TypeLogging type values
SCFILEMODE Enumerated Data TypeWrite mode values for when file allocation table entry is updated

Parameter Tuning with .NET

xPCParameter ClassSingle run-time tunable parameter
xPCParameters ClassAccess run-time parameters
xPCParameter.GetParamGet parameter values from target computer
xPCParameter.GetParamAsyncAsynchronous request to get parameter values from target computer
xPCParameters.LoadParameterSetLoad parameter values for real-time application
xPCParameters.RefreshRefresh state of object
xPCParameters.SaveParameterSetSave parameter values of real-time application
xPCParameter.SetParamChange value of parameter on target computer
xPCParameter.SetParamAsyncAsynchronous request to change parameter value on target computer
xPCParameter.GetParamCompletedEvent when xPCParameter.GetParamAsync is complete
xPCParameter.SetParamCompletedEvent when xPCParameter.SetParamAsync is complete
CancelPropertyNotificationEventArgs ClassCancelPropertyNotification event data
GetParamCompletedEventArgs ClassxPCParameter.GetParamCompleted event data
PropertyNotificationEventArgs ClassPropertyNotification event data
SetParamCompletedEventArgs ClassxPCParameter.SetParamCompleted event data
xPCExceptionConstruct new instance of xPCException class
Was this topic helpful?