Documentation

Simulink Real-Time C/C++ API

Alphabetical List By Category
dirStructType definition for file system folder information structure
diskinfoType definition for file system disk information structure
fileinfoType definition for file information structure
lgmodeType definition for logging options structure
scopedataType definition for scope data structure
xPCAddScopeCreate scope
xPCAverageTETReturn average task execution time
xPCCloseConnectionClose TCP/IP communication connection
xPCClosePortClose TCP/IP communication connection
xPCDeRegisterTargetDelete target communication properties from Simulink Real-Time API library
xPCErrorMsgReturn text description for error message
xPCFreeAPIUnload Simulink Real-Time DLL
xPCFSCDChange current folder on target computer to specified path
xPCFSCloseFileClose file on target computer
xPCFSDirGet contents of specified folder on target computer
xPCFSDirItemsGet contents of specified folder on target computer
xPCFSDirSizeReturn size of specified folder listing on target computer
xPCFSDirStructSizeGet number of items in folder
xPCFSDiskInfoInformation about target computer file system
xPCFSFileInfoReturn information for open file on target computer
xPCFSGetErrorGet text description for error number on target computer file system
xPCFSGetFileSizeReturn size of file on target computer
xPCFSGetPWDGet current folder of target computer
xPCFSMKDIRCreate folder on target computer
xPCFSOpenFileOpen file on target computer
xPCFSReadFileRead open file on target computer
xPCFSRemoveFileRemove file from target computer
xPCFSRMDIRRemove folder from target computer
xPCFSScGetFilenameGet name of file for scope
xPCFSScGetWriteModeGet write mode of file for scope
xPCFSScGetWriteSizeGet block write size of data chunks
xPCFSScSetFilenameSpecify name for file to contain signal data
xPCFSScSetWriteModeSpecify when file allocation table entry is updated
xPCFSScSetWriteSizeSpecify that memory buffer collect data in multiples of write size
xPCFSWriteFileWrite to file on target computer
xPCGetAPIVersionGet version number of Simulink Real-Time API
xPCGetAppNameReturn real-time application name
xPCGetEchoReturn display mode for target message window
xPCGetExecTimeReturn real-time application execution time
xPCGetLastErrorReturn constant of last error
xPCGetLoadTimeOutReturn timeout value for communication between development and target computers
xPCGetLogModeReturn logging mode and increment value for real-time application
xPCGetNumOutputsReturn number of outputs
xPCGetNumParamsReturn number of tunable parameters
xPCGetNumScopesReturn number of scopes added to real-time application
xPCGetNumSignalsReturn number of signals
xPCGetNumStatesReturn number of states
xPCGetOutputLogCopy output log data to array
xPCGetParamGet parameter value and copy it to array
xPCGetParamDimsGet row and column dimensions of parameter
xPCGetParamIdxReturn parameter index
xPCGetParamNameGet name of parameter
xPCGetSampleTimeReturn real-time application sample time
xPCGetScopeGet and copy scope data to structure
xPCGetScopeListGet and copy list of scope numbers
xPCGetScopesGet and copy list of scope numbers
xPCGetSessionTimeReturn length of time Simulink Real-Time kernel has been running
xPCGetSigIdxfromLabelReturn array of signal indices
xPCGetSigLabelWidthReturn number of elements in signal
xPCGetSignalReturn value of signal
xPCGetSignalIdxReturn index for signal
xPCGetSignalLabelCopy label of signal to character array
xPCGetSignalNameCopy name of signal to character array
xPCGetSignalsReturn vector of signal values
xPCGetSignalWidthReturn width of signal
xPCGetStateLogCopy state log values to array
xPCGetStopTimeReturn stop time
xPCGetTargetVersionGet Simulink Real-Time kernel version
xPCGetTETLogCopy TET log to array
xPCGetTimeLogCopy time log to array
xPCInitAPIInitialize Simulink Real-Time DLL
xPCIsAppRunningReturn real-time application running status
xPCIsOverloadedReturn target computer overload status
xPCIsScFinishedReturn data acquisition status for scope
xPCLoadAppLoad real-time application onto target computer
xPCLoadParamSetRestore parameter values
xPCMaximumTETCopy maximum task execution time to array
xPCMaxLogSamplesReturn maximum number of samples that can be in log buffer
xPCMinimumTETCopy minimum task execution time to array
xPCNumLogSamplesReturn number of samples in log buffer
xPCNumLogWrapsReturn number of times log buffer wraps
xPCOpenConnectionOpen connection to target computer
xPCOpenTcpIpPortOpen TCP/IP connection to Simulink Real-Time system
xPCRebootRestart target computer
xPCRegisterTargetRegister target with Simulink Real-Time API library
xPCRemScopeRemove scope
xPCReOpenPortReopen communication channel
xPCSaveParamSetSave parameter values of real-time application
xPCScAddSignalAdd signal to scope
xPCScGetAutoRestartScope autorestart status
xPCScGetDataCopy scope data to array
xPCScGetDecimationReturn decimation of scope
xPCScGetNumPrePostSamplesGet number of pre- or post-triggering samples before triggering scope
xPCScGetNumSamplesGet number of samples in one data acquisition cycle
xPCScGetNumSignalsGet number of signals in scope
xPCScGetSignalListCopy list of signals to array
xPCScGetSignalsCopy list of signals to array
xPCScGetStartTimeGet start time for last data acquisition cycle
xPCScGetStateGet state of scope
xPCScGetTriggerLevelGet trigger level for scope
xPCScGetTriggerModeGet trigger mode for scope
xPCScGetTriggerScopeGet trigger scope
xPCScGetTriggerScopeSampleGet sample number for triggering scope
xPCScGetTriggerSignalGet trigger signal for scope
xPCScGetTriggerSlopeGet trigger slope for scope
xPCScGetTypeGet type of scope
xPCScRemSignalRemove signal from scope
xPCScSetAutoRestartScope autorestart status
xPCScSetDecimationSet decimation of scope
xPCScSetNumPrePostSamplesSet number of pre- or posttriggering samples before triggering scope
xPCScSetNumSamplesSet number of samples in one data acquisition cycle
xPCScSetTriggerLevelSet trigger level for scope
xPCScSetTriggerModeSet trigger mode of scope
xPCScSetTriggerScopeSelect scope for triggering another scope
xPCScSetTriggerScopeSampleSet sample number for triggering scope
xPCScSetTriggerSignalSelect signal for triggering scope
xPCScSetTriggerSlopeSet slope of signal that triggers scope
xPCScSoftwareTriggerSet software trigger of scope
xPCScStartStart data acquisition for scope
xPCScStopStop data acquisition for scope
xPCSetEchoTurn message display on or off
xPCSetLastErrorSet last error to specific character string constant
xPCSetLoadTimeOutChange initialization timeout value between development and target computers
xPCSetLogModeSet logging mode and increment value of scope
xPCSetParamChange value of parameter
xPCSetSampleTimeChange real-time application sample time
xPCSetScopeSet properties of scope
xPCSetStopTimeChange real-time application stop time
xPCStartAppStart real-time application
xPCStopAppStop real-time application
xPCTargetPingPing target computer
xPCTgScGetGridGet status of grid line for particular scope
xPCTgScGetModeGet scope mode for displaying signals
xPCTgScGetViewModeGet view mode for target computer display
xPCTgScGetYLimitsCopy y-axis limits for scope to array
xPCTgScSetGridSet grid mode for scope
xPCTgScSetModeSet display mode for scope
xPCTgScSetViewModeSet view mode for scope
xPCTgScSetYLimitsSet y-axis limits for scope
xPCUnloadAppUnload real-time application
Was this topic helpful?