Real-Time Workshop^® Embedded Coder™

Function Reference

AUTOSAR

AUTOSAR Component Import	Control import of AUTOSAR components
AUTOSAR Configuration	Control and validate AUTOSAR configuration

AUTOSAR Component Import

createCalibrationComponentObjects	Create Simulink calibration objects from AUTOSAR calibration component
createComponentAsModel	Create AUTOSAR atomic software component as Simulink model
createComponentAsSubsystem	Create AUTOSAR atomic software component as Simulink atomic subsystem
getCalibrationComponentNames	Get calibration component names
getComponentNames	Get atomic software component names
getDependencies	Get list of XML dependency files
getFile	Return XML file name for `arxml.importer` object
importer	Construct `arxml.importer` object
setDependencies	Set XML file dependencies
setFile	Set XML file name for `arxml.importer` object

AUTOSAR Configuration

addIOConf	Add AUTOSAR I/O configuration to a model
attachToModel (AUTOSAR)	Attach `RTW.AutosarInterface` object to model
getComponentName	Get XML component name
getDataTypePackageName	Get XML data type package name
getDefaultConf (AUTOSAR)	Get default configuration
getExecutionPeriod	Get runnable execution period
getImplementationName	Get XML implementation name
getInitEventName	Get initial event name
getInitRunnableName	Get initial runnable name
getInterfacePackageName	Get XML interface package name
getInternalBehaviorName	Get XML internal behavior name
getIOAutosarPortName	Get I/O AUTOSAR port name
getIODataAccessMode	Get I/O data access mode
getIODataElement	Get I/O data element name
getIOErrorStatusReceiver	Get receiver port name
getIOInterfaceName	Get I/O interface name
getIOPortNumber	Get I/O AUTOSAR port name
getIOServiceInterface	Get port I/O service interface
getIOServiceName	Get port I/O service name
getIOServiceOperation	Get port I/O service operation
getPeriodicEventName	Get periodic event name
getPeriodicRunnableName	Get periodic runnable name
getPortDefaultConf	Get port default configuration
runValidation (AUTOSAR)	Validate `RTW.AutosarInterface` object against model
setComponentName	Set XML component name
setInitEventName	Set initial event name
setInitRunnableName	Set initial runnable name
setIOAutosarPortName	Set AUTOSAR port name
setIODataAccessMode	Set I/O data access mode
setIODataElement	Set I/O data element
setIOInterfaceName	Set I/O interface name
setPeriodicEventName	Set periodic event name
setPeriodicRunnableName	Set periodic runnable name
syncWithModel	Synchronize configuration with model

C++ Encapsulation Interface Control

attachToModel (C++ Encapsulation Interface Control)	Attach model-specific C++ encapsulation interface to loaded ERT-based Simulink model
getArgCategory (C++ Encapsulation Interface Control)	Get argument category for Simulink model port from model-specific C++ encapsulation interface
getArgName (C++ Encapsulation Interface Control)	Get argument name for Simulink model port from model-specific C++ encapsulation interface
getArgPosition (C++ Encapsulation Interface Control)	Get argument position for Simulink model port from model-specific C++ encapsulation interface
getArgQualifier (C++ Encapsulation Interface Control)	Get argument type qualifier for Simulink model port from model-specific C++ encapsulation interface
getClassName	Get class name from model-specific C++ encapsulation interface
getDefaultConf (C++ Encapsulation Interface Control)	Get default configuration information for model-specific C++ encapsulation interface from Simulink model to which it is attached
getNumArgs (C++ Encapsulation Interface Control)	Get number of step method arguments from model-specific C++ encapsulation interface
getStepMethodName	Get step method name from model-specific C++ encapsulation interface
RTW.configSubsystemBuild	Open GUI to configure C function prototype or C++ encapsulation interface for right-click build of specified subsystem
RTW.getEncapsulationInterfaceSpecification	Get handle to model-specific C++ encapsulation interface control object
runValidation (C++ Encapsulation Interface Control)	Validate model-specific C++ encapsulation interface against Simulink model to which it is attached
setArgCategory (C++ Encapsulation Interface Control)	Set argument category for Simulink model port in model-specific C++ encapsulation interface
setArgName (C++ Encapsulation Interface Control)	Set argument name for Simulink model port in model-specific C++ encapsulation interface
setArgPosition (C++ Encapsulation Interface Control)	Set argument position for Simulink model port in model-specific C++ encapsulation interface
setArgQualifier (C++ Encapsulation Interface Control)	Set argument type qualifier for Simulink model port in model-specific C++ encapsulation interface
setClassName	Set class name in model-specific C++ encapsulation interface
setStepMethodName	Set step method name in model-specific C++ encapsulation interface

Function Prototype Control

addArgConf	Add argument configuration information for Simulink model port to model-specific C function prototype
attachToModel (Function Prototype Control)	Attach model-specific C function prototype to loaded ERT-based Simulink model
getArgCategory (Function Prototype Control)	Get argument category for Simulink model port from model-specific C function prototype
getArgName (Function Prototype Control)	Get argument name for Simulink model port from model-specific C function prototype
getArgPosition (Function Prototype Control)	Get argument position for Simulink model port from model-specific C function prototype
getArgQualifier (Function Prototype Control)	Get argument type qualifier for Simulink model port from model-specific C function prototype
getDefaultConf (Function Prototype Control)	Get default configuration information for model-specific C function prototype from Simulink model to which it is attached
getFunctionName	Get function name from model-specific C function prototype
getNumArgs (Function Prototype Control)	Get number of function arguments from model-specific C function prototype
getPreview	Get model-specific C function prototype code preview
RTW.configSubsystemBuild	Open GUI to configure C function prototype or C++ encapsulation interface for right-click build of specified subsystem
RTW.getFunctionSpecification	Get handle to a model-specific C prototype function control object
runValidation (Function Prototype Control)	Validate model-specific C function prototype against Simulink model to which it is attached
setArgCategory (Function Prototype Control)	Set argument category for Simulink model port in model-specific C function prototype
setArgName (Function Prototype Control)	Set argument name for Simulink model port in model-specific C function prototype
setArgPosition (Function Prototype Control)	Set argument position for Simulink model port in model-specific C function prototype
setArgQualifier (Function Prototype Control)	Set argument type qualifier for Simulink model port in model-specific C function prototype
setFunctionName	Set function name in model-specific C function prototype

Model Entry Points

model_initialize	Initialization entry point in generated code for ERT-based Simulink model
model_SetEventsForThisBaseStep	Set event flags for multirate, multitasking operation before calling `model_step` for ERT-based Simulink model — not generated as of Version 5.1 (R2008a)
model_step	Step routine entry point in generated code for ERT-based Simulink model
model_terminate	Termination entry point in generated code for ERT-based Simulink model

System Target File Callback Interface

slConfigUIGetVal	Return current value for custom target configuration option
slConfigUISetEnabled	Enable or disable custom target configuration option
slConfigUISetVal	Set value for custom target configuration option

Target Function Library Table Creation

addAdditionalHeaderFile	Add additional header file to array of additional header files for TFL table entry
addAdditionalIncludePath	Add additional include path to array of additional include paths for TFL table entry
addAdditionalLinkObj	Add additional link object to array of additional link objects for TFL table entry
addAdditionalLinkObjPath	Add additional link object path to array of additional link object paths for TFL table entry
addAdditionalSourceFile	Add additional source file to array of additional source files for TFL table entry
addAdditionalSourcePath	Add additional source path to array of additional source paths for TFL table entry
addConceptualArg	Add conceptual argument to array of conceptual arguments for TFL table entry
addEntry	Add table entry to collection of table entries registered in TFL table
copyConceptualArgsToImplementation	Copy conceptual argument specifications to matching implementation arguments for TFL table entry
createAndAddConceptualArg	Create conceptual argument from specified properties and add to conceptual arguments for TFL table entry
createAndAddImplementationArg	Create implementation argument from specified properties and add to implementation arguments for TFL table entry
createAndSetCImplementationReturn	Create implementation return argument from specified properties and add to implementation for TFL table entry
getTflArgFromString	Create TFL argument based on specified name and built-in data type
registerCFunctionEntry	Create TFL function entry based on specified parameters and register in TFL table
registerCPromotableMacroEntry	Create TFL promotable macro entry based on specified parameters and register in TFL table (for `abs` function replacement only)
setReservedIdentifiers	Register specified reserved identifiers to be associated with TFL table
setTflCFunctionEntryParameters	Set specified parameters for function entry in TFL table
setTflCOperationEntryParameters	Set specified parameters for operator entry in TFL table

Processor-in-the-Loop

Connectivity Configuration	Define processor-in-the-loop (PIL) configuration
Build	Configure PIL build process
Execution Download, Start and and Stop	Control downloading, starting and resetting PIL executable on target hardware
Host and Target Communications	Configure host-target communications
Host-Side Communications	Configure host-side communications channel and drivers
Target-Side Communications	Configure target-side communications channel and drivers

Connectivity Configuration

rtw.connectivity.ComponentArgs	Provide parameters to each of the target connectivity components
rtw.connectivity.Config	Define connectivity implementation, comprising builder, launcher, and communicator components
rtw.connectivity.ConfigRegistry	Register connectivity configuration

Build

rtw.connectivity.MakefileBuilder

Configure makefile-based build process

Execution Download, Start and and Stop

rtw.connectivity.Launcher

Control downloading, starting and resetting executable on target hardware

Host and Target Communications

rtiostreamClose	Shut down communications channel with remote processor
rtiostreamOpen	Initialize communications channel with remote processor
rtiostreamRecv	Receive data from remote processor
rtiostreamSend	Send data to remote processor

Host-Side Communications

rtiostream_wrapper	Test `rtiostream` shared library methods
rtw.connectivity.RtIOStreamHostCommunicator	Configure host-side communications

Target-Side Communications

rtw.pil.RtIOStreamApplicationFramework

Configure target-side communications

Functions — Alphabetical List