Learn more about Real-Time Workshop Embedded Coder

Function Reference

Alphabetical List  Class Reference

---

AUTOSAR Control AUTOSAR component configuration for import, code generation, and XML file export from Simulink models C++ Encapsulation Interface Control Control C++ encapsulation interfaces in generated code for ERT-based Simulink models Code Generation Objectives Customization Control step function prototypes in generated code for ERT-based Simulink models Code Generation Verification Compare numerical equivalence of simulation and generated code results Function Prototype Control Control step function prototypes in generated code for ERT-based Simulink models Model Entry Points Access entry points in generated code for ERT-based Simulink models System Target File Callback Interface Control Real-Time Workshop configuration options in callbacks for ERT-based custom targets Target Function Library Table Creation Create function replacement tables that make up Real-Time Workshop target function libraries (TFLs) Processor-in-the-Loop Control processor-in-the-loop (PIL) configuration

Back to Top

AUTOSAR

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

Back to Top of Section

AUTOSAR Component Import

arxml.importer	Construct arxml.importer object
createCalibrationComponentObjects (arxml.importer)	Create Simulink calibration objects from AUTOSAR calibration component
createComponentAsModel (arxml.importer)	Create AUTOSAR atomic software component as Simulink model
createComponentAsSubsystem (arxml.importer)	Create AUTOSAR atomic software component as Simulink atomic subsystem
createOperationAsConfigurableSubsystems (arxml.importer)	Create configurable Simulink subsystem library for client-server operation
getCalibrationComponentNames (arxml.importer)	Get calibration component names
getComponentNames (arxml.importer)	Get atomic software component names
getDependencies (arxml.importer)	Get list of XML dependency files
getFile (arxml.importer)	Return XML file name for arxml.importer object
setDependencies (arxml.importer)	Set XML file dependencies
setFile (arxml.importer)	Set XML file name for arxml.importer object

Back to Top of Section

AUTOSAR Configuration

addIOConf (RTW.AutosarInterface)	Add AUTOSAR I/O configuration to model
attachToModel (RTW.AutosarInterface)	Attach RTW.AutosarInterface object to model
getComponentName (RTW.AutosarInterface)	Get XML component name
getDataTypePackageName (RTW.AutosarInterface)	Get XML data type package name
getDefaultConf (RTW.AutosarInterface)	Get default configuration
getExecutionPeriod (RTW.AutosarInterface)	Get runnable execution period
getImplementationName (RTW.AutosarInterface)	Get XML implementation name
getInitEventName (RTW.AutosarInterface)	Get initial event name
getInitRunnableName (RTW.AutosarInterface)	Get initial runnable name
getInterfacePackageName (RTW.AutosarInterface)	Get XML interface package name
getInternalBehaviorName (RTW.AutosarInterface)	Get XML internal behavior name
getIOAutosarPortName (RTW.AutosarInterface)	Get I/O AUTOSAR port name
getIODataAccessMode (RTW.AutosarInterface)	Get I/O data access mode
getIODataElement (RTW.AutosarInterface)	Get I/O data element name
getIOErrorStatusReceiver (RTW.AutosarInterface)	Get receiver port name
getIOInterfaceName (RTW.AutosarInterface)	Get I/O interface name
getIOPortNumber (RTW.AutosarInterface)	Get I/O AUTOSAR port number
getIOServiceInterface (RTW.AutosarInterface)	Get port I/O service interface
getIOServiceName (RTW.AutosarInterface)	Get port I/O service name
getIOServiceOperation (RTW.AutosarInterface)	Get port I/O service operation
getIsServerOperation (RTW.AutosarInterface)	Determine whether server is specified
getPeriodicEventName (RTW.AutosarInterface)	Get periodic event name
getPeriodicRunnableName (RTW.AutosarInterface)	Get periodic runnable name
getPortDefaultConf (RTW.AutosarInterface)	Get port default configuration
getServerInterfaceName (RTW.AutosarInterface)	Get name of server interface
getServerOperationPrototype (RTW.AutosarInterface)	Get server operation prototype
getServerPortName (RTW.AutosarInterface)	Get server port name
getServerType (RTW.AutosarInterface)	Determine server type
RTW.AutosarInterface	Construct RTW.AutosarInterface object
runValidation (RTW.AutosarInterface)	Validate RTW.AutosarInterface object against model
setComponentName (RTW.AutosarInterface)	Set XML component name
setInitEventName (RTW.AutosarInterface)	Set initial event name
setInitRunnableName (RTW.AutosarInterface)	Set initial runnable name
setIOAutosarPortName (RTW.AutosarInterface)	Set AUTOSAR port name
setIODataAccessMode (RTW.AutosarInterface)	Set I/O data access mode
setIODataElement (RTW.AutosarInterface)	Set I/O data element
setIOInterfaceName (RTW.AutosarInterface)	Set I/O interface name
setIsServerOperation (RTW.AutosarInterface)	Indicate that server is specified
setPeriodicEventName (RTW.AutosarInterface)	Set periodic event name
setPeriodicRunnableName (RTW.AutosarInterface)	Set periodic runnable name
setServerInterfaceName (RTW.AutosarInterface)	Set name of server interface
setServerOperationPrototype (RTW.AutosarInterface)	Specify operation prototype
setServerPortName (RTW.AutosarInterface)	Set server port name
setServerType (RTW.AutosarInterface)	Specify server type
syncWithModel (RTW.AutosarInterface)	Synchronize configuration with model

Back to Top

C++ Encapsulation Interface Control

attachToModel (RTW.ModelCPPClass)	Attach model-specific C++ encapsulation interface to loaded ERT-based Simulink model
getArgCategory (RTW.ModelCPPArgsClass)	Get argument category for Simulink model port from model-specific C++ encapsulation interface
getArgName (RTW.ModelCPPArgsClass)	Get argument name for Simulink model port from model-specific C++ encapsulation interface
getArgPosition (RTW.ModelCPPArgsClass)	Get argument position for Simulink model port from model-specific C++ encapsulation interface
getArgQualifier (RTW.ModelCPPArgsClass)	Get argument type qualifier for Simulink model port from model-specific C++ encapsulation interface
getClassName (RTW.ModelCPPClass)	Get class name from model-specific C++ encapsulation interface
getDefaultConf (RTW.ModelCPPClass)	Get default configuration information for model-specific C++ encapsulation interface from Simulink model
getNumArgs (RTW.ModelCPPClass)	Get number of step method arguments from model-specific C++ encapsulation interface
getStepMethodName (RTW.ModelCPPClass)	Get step method name from model-specific C++ encapsulation interface
RTW.configSubsystemBuild	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
RTW.ModelCPPArgsClass	Create C++ encapsulation interface object for configuring model class with I/O arguments style step method
RTW.ModelCPPVoidClass	Create C++ encapsulation interface object for configuring model class with void-void style step method
runValidation (RTW.ModelCPPArgsClass)	Validate model-specific C++ encapsulation interface against Simulink model
runValidation (RTW.ModelCPPVoidClass)	Validate model-specific C++ encapsulation interface against Simulink model
setArgCategory (RTW.ModelCPPArgsClass)	Set argument category for Simulink model port in model-specific C++ encapsulation interface
setArgName (RTW.ModelCPPArgsClass)	Set argument name for Simulink model port in model-specific C++ encapsulation interface
setArgPosition (RTW.ModelCPPArgsClass)	Set argument position for Simulink model port in model-specific C++ encapsulation interface
setArgQualifier (RTW.ModelCPPArgsClass)	Set argument type qualifier for Simulink model port in model-specific C++ encapsulation interface
setClassName (RTW.ModelCPPClass)	Set class name in model-specific C++ encapsulation interface
setStepMethodName (RTW.ModelCPPClass)	Set step method name in model-specific C++ encapsulation interface

Back to Top

Code Generation Objectives Customization

addCheck (rtw.codegenObjectives.Objective)	Add checks
addParam (rtw.codegenObjectives.Objective)	Add parameters
excludeCheck (rtw.codegenObjectives.Objective)	Exclude checks
modifyInheritedParam (rtw.codegenObjectives.Objective)	Modify inherited parameter values
register (rtw.codegenObjectives.Objective)	Register objective
removeInheritedCheck (rtw.codegenObjectives.Objective)	Remove inherited checks
removeInheritedParam (rtw.codegenObjectives.Objective)	Remove inherited parameters
rtw.codegenObjectives.Objective	Create custom code generation objectives
setObjectiveName (rtw.codegenObjectives.Objective)	Specify objective name

Back to Top

Code Generation Verification

addCallback (cgv.CGV)	Add callback function
addConfigSet (cgv.CGV)	Add configuration set
addInputData (cgv.CGV)	Add input data
addPostLoadFiles (cgv.CGV)	Add files required by model
configModel (cgv.Config)	Determine and change configuration parameter values
displayReport (cgv.Config)	Display results of comparing configuration parameter values
getOutputData (cgv.CGV)	Get output data
getReportData (cgv.Config)	Return results of comparing configuration parameter values
run (cgv.CGV)	Execute CGV object
setOutputDir (cgv.CGV)	Specify folder
setOutputFile (cgv.CGV)	Specify output data file name

Back to Top

Function Prototype Control

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

Back to Top

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

Back to Top

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

Back to Top

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

Back to Top

Processor-in-the-Loop

Connectivity Configuration Define processor-in-the-loop (PIL) configuration Build Configure PIL build process Execution Download, Start 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

Back to Top of Section

Connectivity Configuration

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

Back to Top of Section

Build

rtw.connectivity.MakefileBuilder

Configure makefile-based build process

Back to Top of Section

Execution Download, Start and Stop

rtw.connectivity.Launcher

Control downloading, starting and resetting executable on target hardware

Back to Top of Section

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

Back to Top of Section

Host-Side Communications

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

Back to Top of Section

Target-Side Communications

rtw.pil.RtIOStreamApplicationFramework

Configure target-side communications

Class Reference

© 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS