Documentation

Simulink Real-Time .NET API

Alphabetical List By Category
CancelPropertyNotificationEventArgs ClassCancelPropertyNotification event data
ConnectCompletedEventArgs ClassxPCTargetPC.ConnectCompleted event data
DisconnectCompletedEventArgs ClassxPCTargetPC.DisconnectCompleted event data
GetDataCompletedEventArgs ClassGetDataCompleted event data
GetFileScSignalDataObjectCompletedEventArgs ClassxPCDataFileScSignalObject.GetDataCompleted event data
GetHostScSignalDataObjectCompletedEventArgs ClassxPCDataHostScSignalObject.DataObjectCompleted event data
GetLogDataCompletedEventArgs ClassxPCDataLoggingObject.GetDataCompleted event data
GetParamCompletedEventArgs ClassxPCParameter.GetParamCompleted event data
LoadCompletedEventArgs ClassxPCTargetPC.LoadCompleted event data
PropertyNotificationEventArgs ClassPropertyNotification event data
RebootCompletedEventArgs ClassxPCTargetPC.RebootCompleted event data
SCDISPLAYMODE Enumerated Data TypeTarget scope display mode values
SCFILEMODE Enumerated Data TypeWrite mode values for when file allocation table entry is updated
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
SetParamCompletedEventArgs ClassxPCParameter.SetParamCompleted event data
UnloadCompletedEventArgs ClassxPCTargetPC.UnloadCompleted event data
xPCApplication ClassAccess to real-time application loaded on target computer
xPCApplication.StartStart real-time application execution
xPCApplication.StartedEvent after xPCApplication.Start is complete
xPCApplication.StartingEvent before xPCApplication.Start executes
xPCApplication.StopStop real-time application execution
xPCApplication.StoppedEvent after xPCApplication.Stop is complete
xPCApplication.StoppingEvent before xPCApplication.Stop executes
xPCAppLogger ClassAccess to real-time application loggers
xPCAppStatus Enumerated Data TypeReal-time application status return values
xPCDataFileScSignalObject ClassObject that holds logged file scope signal data
xPCDataFileScSignalObject.GetDataCopy file scope signal data from target computer
xPCDataFileScSignalObject.GetDataAsyncAsynchronously copy file scope signal data from target computer
xPCDataFileScSignalObject.GetDataCompletedEvent when xPCDataFileScSignalObject.GetDataAsync is complete
xPCDataHostScSignalObject ClassObject that holds logged host scope signal data
xPCDataHostScSignalObject.GetDataCopy host scope signal data from target computer
xPCDataHostScSignalObject.GetDataAsyncAsynchronously copy host scope signal data from target computer
xPCDataHostScSignalObject.GetDataCompletedEvent when xPCDataHostScSignalObject.GetDataAsync is complete
xPCDataLoggingObject ClassObject that holds logged data
xPCDataLoggingObject.GetDataCopy signal data from target computer
xPCDataLoggingObject.GetDataAsyncAsynchronously copy signal data from target computer
xPCDataLoggingObject.GetDataCompletedEvent when xPCDataLoggingObject.GetDataAsync is complete
xPCDirectoryInfoConstruct new instance of xPCDirectoryInfo class on specified path
xPCDirectoryInfo ClassAccess folders and subfolders of target computer file system
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
xPCDriveInfoConstruct new instance of xPCDriveInfo class
xPCDriveInfo ClassInformation for target computer drive
xPCDriveInfo.RefreshSynchronize with file drives on target computer
xPCExceptionConstruct new instance of xPCException class
xPCException ClassInformation for xPCException
xPCExceptionReason Enumerated Data TypeException reasons
xPCFileInfoConstruct new instance of xPCFileInfo class
xPCFileInfo ClassAccess to file and xPCFileStream objects
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.OpenOpen file
xPCFileInfo.OpenReadCreate read-only xPCFileStream object
xPCFileInfo.RenameRename file
xPCFileMode Enumerated Data TypeOpen file with permissions
xPCFileScope ClassAccess to file scopes
xPCFileScopeCollection ClassCollection of xPCFileScope objects
xPCFileScopeCollection.AddCreate xPCFileScope object with next available scope ID as key
xPCFileScopeCollection.RefreshSynchronize with file scopes on target computer
xPCFileScopeCollection.StartAllStart all file scopes in one call
xPCFileScopeCollection.StopAllStop all file scopes in one call
xPCFileScopeSignal ClassAccess to file scope signals
xPCFileScopeSignalCollection ClassCollection of xPCFileScopeSignal objects
xPCFileScopeSignalCollection.AddAdd signals to file scope
xPCFileScopeSignalCollection.RefreshSynchronize with signals for associated scope on target computer
xPCFileStreamConstruct new instance of xPCFileStream class
xPCFileStream ClassAccess xPCFileStream objects
xPCFileStream.CloseClose current stream
xPCFileStream.ReadRead block of bytes from stream and write data to buffer
xPCFileStream.WriteWrite block of bytes to file stream
xPCFileStream.WriteByteWrite byte to current position in file stream
xPCFileSystem ClassFile system drives and folders
xPCFileSystem.CreateDirectoryCreate folder
xPCFileSystem.GetCurrentDirectoryCurrent working folder for real-time application
xPCFileSystem.GetDrivesDrive names for logical drives on target computer
xPCFileSystem.RemoveFileRemove file name from target computer
xPCFileSystem.SetCurrentDirectoryCurrent folder
xPCFileSystemInfoConstruct new instance of xPCFileSystemInfo class
xPCFileSystemInfo ClassFile system information
xPCFileSystemInfo.DeleteDelete current file or folder
xPCHostScope ClassAccess to host scopes
xPCHostScopeCollection ClassCollection of xPCHostScope objects
xPCHostScopeCollection.AddCreate xPCHostScope object with next available scope ID as key
xPCHostScopeCollection.RefreshRefresh host scope object state
xPCHostScopeCollection.StartAllStart all host scopes in one call
xPCHostScopeCollection.StopAllStop all host scopes in one call
xPCHostScopeSignal ClassAccess to host scope signals
xPCHostScopeSignalCollection ClassCollection of xPCHostScopeSignal objects
xPCHostScopeSignalCollection.AddAdd signals to host scope
xPCHostScopeSignalCollection.RefreshSynchronize signals for associated host scopes on target computer
xPCLog ClassBase data logging class
xPCLogMode Enumerated Data TypeSpecify log mode values
xPCLogType Enumerated Data TypeLogging type values
xPCOutputLogger ClassAccess to output logger
xPCParameter ClassSingle run-time tunable parameter
xPCParameter.GetParamGet parameter values from target computer
xPCParameter.GetParamAsyncAsynchronous request to get parameter values from target computer
xPCParameter.GetParamCompletedEvent when xPCParameter.GetParamAsync is complete
xPCParameter.SetParamChange value of parameter on target computer
xPCParameter.SetParamAsyncAsynchronous request to change parameter value on target computer
xPCParameter.SetParamCompletedEvent when xPCParameter.SetParamAsync is complete
xPCParameters ClassAccess run-time parameters
xPCParameters.LoadParameterSetLoad parameter values for real-time application
xPCParameters.RefreshRefresh state of object
xPCParameters.SaveParameterSetSave parameter values of real-time application
xPCProtocol Enumerated Data TypeDevelopment computer and target computer communication medium
xPCScope ClassAccess Simulink Real-Time scopes
xPCScope.ScopeStartedEvent after xPCScope.Start is complete
xPCScope.ScopeStartingEvent before xPCScope.Start executes
xPCScope.ScopeStoppedEvent after xPCScope.Stop is complete
xPCScope.ScopeStoppingEvent before xPCScope.Stop executes
xPCScope.StartStart scope
xPCScope.StopStop scope
xPCScope.TriggerSoftware-trigger start of data acquisition for scope
xPCScopeCollectionEventArgs ClassxPCScopeCollection.Added event data
xPCScopeRemCollectionEventArgs ClassxPCScopeCollection.Removed event data
xPCScopes ClassAccess scope objects
xPCScopes.RefreshAllRefresh state of object
xPCScopeSignalCollectionEventArgs ClassxPCScopeSignalCollection.Added event data
xPCSignal ClassAccess signal objects
xPCSignal.GetValueValue of signal at moment of request
xPCSignal.TryGetValueStatus of get signal value at moment of request
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
xPCStateLogger ClassAccess to state log
xPCTargetPCConstruct new instance of xPCTargetPC class
xPCTargetPC ClassAccess target computer
xPCTargetPC.ConnectEstablish connection with target computer
xPCTargetPC.ConnectAsyncAsynchronous request for target computer connection
xPCTargetPC.ConnectCompletedEvent when xPCTargetPC.ConnectAsync is complete
xPCTargetPC.ConnectedEvent after xPCTargetPC.Connect is complete
xPCTargetPC.ConnectingEvent before xPCTargetPC.Connect starts
xPCTargetPC.DisconnectDisconnect from target computer
xPCTargetPC.DisconnectAsyncAsynchronous request to disconnect from target computer
xPCTargetPC.DisconnectCompletedEvent when xPCTargetPC.DisconnectAsync is complete
xPCTargetPC.DisconnectedEvent after xPCTargetPC.Disconnect is complete
xPCTargetPC.DisconnectingEvent before xPCTargetPC.Disconnect starts
xPCTargetPC.DisposeClean up used resources
xPCTargetPC.DisposedEvent after xPCTargetPC.Dispose is complete
xPCTargetPC.LoadLoad real-time application onto target computer
xPCTargetPC.LoadAsyncAsynchronous request to load real-time application onto target computer
xPCTargetPC.LoadCompletedEvent when xPCTargetPC.LoadAsync is complete
xPCTargetPC.LoadedEvent after xPCTargetPC.Load is complete
xPCTargetPC.LoadingEvent before xPCTargetPC.Load starts
xPCTargetPC.PingTest communication between development and target computers
xPCTargetPC.RebootRestart target computer
xPCTargetPC.RebootAsyncAsynchronous request to restart target computer
xPCTargetPC.RebootCompletedEvent when xPCTargetPC.RebootAsync is complete
xPCTargetPC.RebootedEvent after xPCTargetPC.Reboot is complete
xPCTargetPC.RebootingEvent before xPCTargetPC.Reboot starts
xPCTargetPC.tcpPingDetermine TCP/IP accessibility of remote computer
xPCTargetPC.UnloadUnload real-time application from target computer
xPCTargetPC.UnloadAsyncAsynchronous request to unload real-time application from target computer
xPCTargetPC.UnloadCompletedEvent when xPCTargetPC.UnloadAsync is complete
xPCTargetPC.UnloadedEvent after xPCTargetPC.Unload is complete
xPCTargetPC.UnloadingEvent before xPCTargetPC.Unload starts
xPCTargetScope ClassAccess to target scopes
xPCTargetScopeCollection ClassCollection of xPCTargetScope objects
xPCTargetScopeCollection.AddCreate xPCTargetScope object
xPCTargetScopeCollection.RefreshRefresh target scope object state
xPCTargetScopeCollection.StartAllStart all target scopes in one call
xPCTargetScopeCollection.StopAllStop all target scopes in one call
xPCTargetScopeSignalCollection ClassCollection of xPCHostScopeSignal objects
xPCTargetScopeSignalCollection.AddCreate xPCTargetScopeSignal object
xPCTargetScopeSignalCollection.RefreshSynchronize signals for associated target scopes on target computer
xPCTETLogger ClassAccess to task execution time (TET) logger
xPCTgtScopeSignal ClassAccess to target scope signals
xPCTimeLogger ClassAccess to output log
Was this topic helpful?