Function Reference

Alphabetical List
Click for Class Reference

AUTOSAR

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

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
getApplicationComponentNames (arxml.importer)	Get list of application software component names
getCalibrationComponentNames (arxml.importer)	Get calibration component names
getClientServerInterfaceNames (arxml.importer)	Get list of client-server interfaces
getComponentNames (arxml.importer)	Get application and sensor/actuator software component names
getDependencies (arxml.importer)	Get list of XML dependency files
getFile (arxml.importer)	Return XML file name for `arxml.importer` object
getSensorActuatorComponentNames (arxml.importer)	Get list of sensor/actuator software component names
setDependencies (arxml.importer)	Set XML file dependencies
setFile (arxml.importer)	Set XML file name for `arxml.importer` object

AUTOSAR Configuration

addEventConf (RTW.AutosarInterface)	Add configured AUTOSAR event to model
addIOConf (RTW.AutosarInterface)	Add AUTOSAR I/O configuration to model
attachToModel (RTW.AutosarInterface)	Attach `RTW.AutosarInterface` object to model
getArxmlFilePackaging (RTW.AutosarInterface)	Get AUTOSAR XML packaging format
getComponentName (RTW.AutosarInterface)	Get XML component name
getComponentType (RTW.AutosarInterface)	Get type of software component
getDataTypePackageName (RTW.AutosarInterface)	Get XML data type package name
getDefaultConf (RTW.AutosarInterface)	Get default configuration
getEventType (RTW.AutosarInterface)	Get event type
getExecutionPeriod (RTW.AutosarInterface)	Get runnable execution period
getImplementationName (RTW.AutosarInterface)	Get name of XML implementation
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 name of XML file that specifies software component internal behavior
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 name of error status receiver port
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
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
getTriggerPortName (RTW.AutosarInterface)	Get name of Simulink inport that provides trigger data for DataReceivedEvent
removeEventConf (RTW.AutosarInterface)	Remove AUTOSAR event from model
RTW.AutosarInterface	Construct `RTW.AutosarInterface` object
runValidation (RTW.AutosarInterface)	Validate `RTW.AutosarInterface` object against model
setArxmlFilePackaging (RTW.AutosarInterface)	Set AUTOSAR XML packaging format
setComponentName (RTW.AutosarInterface)	Set XML component name
setComponentType (RTW.AutosarInterface)	Set type of software component
setDataTypePackageName (RTW.AutosarInterface)	Specify XML package name for data type
setEventType (RTW.AutosarInterface)	Set type for event
setExecutionPeriod (RTW.AutosarInterface)	Specify execution period for TimingEvent
setImplementationName (RTW.AutosarInterface)	Set name of XML implementation
setInitEventName (RTW.AutosarInterface)	Set initial event name
setInitRunnableName (RTW.AutosarInterface)	Set initial runnable name
setInterfacePackageName (RTW.AutosarInterface)	Set name of XML interface package
setInternalBehaviorName (RTW.AutosarInterface)	Set name of XML file for software component internal behavior
setIOAutosarPortName (RTW.AutosarInterface)	Set AUTOSAR port name
setIODataAccessMode (RTW.AutosarInterface)	Set I/O data access mode
setIODataElement (RTW.AutosarInterface)	Set I/O data element
setIOErrorStatusReceiver (RTW.AutosarInterface)	Set name of error status receiver port
setIOInterfaceName (RTW.AutosarInterface)	Set I/O interface name
setIOServiceInterface (RTW.AutosarInterface)	Set port I/O service interface
setIOServiceName (RTW.AutosarInterface)	Set port I/O service name
setIOServiceOperation (RTW.AutosarInterface)	Set port I/O service operation
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
setTriggerPortName (RTW.AutosarInterface)	Specify Simulink inport that provides trigger data for DataReceivedEvent
syncWithModel (RTW.AutosarInterface)	Synchronize configuration with model

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

Code Execution Profiling

Summary and Timer
Section Profile

Summary and Timer

display	Generate message that describes how to open code execution profiling report
getNumSectionProfiles	Get number of profiled code sections
getSectionProfile	Get `rtw.pil.ExecutionProfileSection` object for a profiled code section
getTimerTicksPerSecond	Get number of timer ticks per second
report	Open code execution profiling report
setTimerTicksPerSecond	Set number of timer ticks per second

Section Profile

getMaxTicks	Get maximum number of timer ticks for single invocation of profiled code section
getName	Get name of profiled task
getNumCalls	Total number of calls to profiled code section
getSampleOffset	Get sample offset associated with profiled task
getSamplePeriod	Get sample time associated with profiled task
getSectionNumber	Get number that uniquely identifies profiled code section
getTicks	Get execution times in timer ticks for profiled section of code
getTimes	Get execution times in seconds for profiled section of code
getTotalSelfTicks	Get total number of timer ticks recorded for profiled code section excluding periods in child functions
getTotalTicks	Get total number of timer ticks recorded for profiled code section

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

Code Generation Verification

activateConfigSet (cgv.CGV)	Activate configuration set of model
addBaseline (cgv.CGV)	Add baseline file for comparison
addConfigSet (cgv.CGV)	Add configuration set
addHeaderReportFcn (cgv.CGV)	Add callback function to execute before executing any input data in object
addInputData (cgv.CGV)	Add input data
addPostExecFcn (cgv.CGV)	Add callback function to execute after each input data file is executes
addPostExecReportFcn (cgv.CGV)	Add callback function to execute after each input data file executes
addPostLoadFiles (cgv.CGV)	Add files required by model
addPreExecFcn (cgv.CGV)	Add callback function to execute before each input data file executes
addPreExecReportFcn (cgv.CGV)	Add callback function to execute before each input data file executes
addTrailerReportFcn (cgv.CGV)	Add callback function to execute after all input data executes
compare (cgv.CGV)	Compare signal data
configModel (cgv.Config)	Determine and change configuration parameter values
copySetup (cgv.CGV)	Create copy of `cgv.CGV` object
createToleranceFile (cgv.CGV)	Create file correlating tolerance information with signal names
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
getSavedSignals (cgv.CGV)	Display list of signal names to command line
getStatus (cgv.CGV)	Return execution status
plot (cgv.CGV)	Create plot for signal or multiple signals
run (cgv.CGV)	Execute CGV object
setMode (cgv.CGV)	Specify mode of execution
setOutputDir (cgv.CGV)	Specify folder
setOutputFile (cgv.CGV)	Specify output data file name

Embedded IDEs and Embedded Targets

IDE Automation Interface

Analog Devices VisualDSP++

activate	Mark file, project, or build configuration as active
add	Add files to active project in IDE
address	Memory address and page value of symbol in IDE
adivdsp	Create handle object to interact with VisualDSP++ IDE
adivdspsetup	Configure your coder product to interact with VisualDSP++ IDE
build	Build or rebuild current project
cd	Set working folder in IDE
close	Close project in IDE window
dir	Files and folders in current IDE window
display (IDE Object)	Properties of IDE handle
getbuildopt	Generate structure of build tools and options
halt	Halt program execution by processor
info	Information about processor
insert	Insert debug point in file
isrunning	Determine whether processor is executing process
isvisible	Determine whether IDE appears on desktop
listsessions	List existing sessions
load	Load program file onto processor
new	Create project, library, or build configuration in IDE
open	Open project in IDE
profile	Generate real-time execution or stack profiling report
read	Read data from processor memory
remove	Remove file, project, or breakpoint
reset	Stop program execution and reset processor
run	Execute program loaded on processor
save	Save file
setbuildopt	Set active configuration build options
symbol	Program symbol table from IDE
visible	Set whether IDE window appears while IDE runs
write	Write data to processor memory block
xmakefilesetup	Configure your coder product to generate makefiles

Eclipse IDE

activate	Mark file, project, or build configuration as active
add	Add files to active project in IDE
address	Memory address and page value of symbol in IDE
build	Build or rebuild current project
close	Close project in IDE window
dir	Files and folders in current IDE window
display (IDE Object)	Properties of IDE handle
eclipseide	Create handle object to interact with Eclipse IDE
eclipseidesetup	Configure your coder product to interact with Eclipse IDE
halt	Halt program execution by processor
insert	Insert debug point in file
isrunning	Determine whether processor is executing process
load	Load program file onto processor
new	Create project, library, or build configuration in IDE
open	Open project in IDE
profile	Generate real-time execution or stack profiling report
pwd	Working folder used by Eclipse
read	Read data from processor memory
reload	Reload most recent program file to processor signal processor
remove	Remove file, project, or breakpoint
restart	Reload most recent program file to processor signal processor
run	Execute program loaded on processor
write	Write data to processor memory block
xmakefilesetup	Configure your coder product to generate makefiles

Green Hills MULTI

activate	Mark file, project, or build configuration as active
add	Add files to active project in IDE
address	Memory address and page value of symbol in IDE
build	Build or rebuild current project
cd	Set working folder in IDE
close	Close project in IDE window
connect	Connect IDE to processor
dir	Files and folders in current IDE window
display (IDE Object)	Properties of IDE handle
getbuildopt	Generate structure of build tools and options
ghsmulti	Create handle object to interact with MULTI IDE
ghsmulticonfig	Configure coder product to interact with MULTI IDE
halt	Halt program execution by processor
info	Information about processor
insert	Insert debug point in file
isrunning	Determine whether processor is executing process
list	Information listings from IDE
load	Load program file onto processor
new	Create project, library, or build configuration in IDE
open	Open project in IDE
profile	Generate real-time execution or stack profiling report
read	Read data from processor memory
regread	Values from processor registers
regwrite	Write data values to registers on processor
reload	Reload most recent program file to processor signal processor
remove	Remove file, project, or breakpoint
reset	Stop program execution and reset processor
restart	Reload most recent program file to processor signal processor
run	Execute program loaded on processor
setbuildopt	Set active configuration build options
symbol	Program symbol table from IDE
write	Write data to processor memory block
xmakefilesetup	Configure your coder product to generate makefiles

Texas Instruments Code Composer Studio 3.3

activate	Mark file, project, or build configuration as active
add	Add files to active project in IDE
address	Memory address and page value of symbol in IDE
animate	Run application on processor to breakpoint
build	Build or rebuild current project
ccsboardinfo	Information about boards and simulators known to IDE
cd	Set working folder in IDE
checkEnvSetup	Configure your coder product to interact with Code Composer Studio
close	Close project in IDE window
configure	Define size and number of RTDX channel buffers
dir	Files and folders in current IDE window
disable	Disable RTDX interface, specified channel, or all RTDX channels
display (IDE Object)	Properties of IDE handle
enable	Enable RTDX interface, specified channel, or all RTDX channels
flush	Flush data or messages from specified RTDX channels
getbuildopt	Generate structure of build tools and options
halt	Halt program execution by processor
info	Information about processor
insert	Insert debug point in file
isenabled	Determine whether RTDX link is enabled for communications
isreadable	Determine whether specified memory block can read MATLAB software
isrtdxcapable	Determine whether processor supports RTDX
isrunning	Determine whether processor is executing process
isvisible	Determine whether IDE appears on desktop
iswritable	Determine whether MATLAB can write to specified memory block
list	Information listings from IDE
load	Load program file onto processor
msgcount	Number of messages in read-enabled channel queue
new	Create project, library, or build configuration in IDE
open	Open project in IDE
profile	Generate real-time execution or stack profiling report
read	Read data from processor memory
readmat	Matrix of data from RTDX channel
readmsg	Read messages from specified RTDX channel
regread	Values from processor registers
regwrite	Write data values to registers on processor
reload	Reload most recent program file to processor signal processor
remove	Remove file, project, or breakpoint
reset	Stop program execution and reset processor
restart	Reload most recent program file to processor signal processor
run	Execute program loaded on processor
save	Save file
setbuildopt	Set active configuration build options
symbol	Program symbol table from IDE
ticcs	Create handle object to interact with Code Composer Studio IDE
visible	Set whether IDE window appears while IDE runs
write	Write data to processor memory block
writemsg	Write messages to specified RTDX channel
xmakefilesetup	Configure your coder product to generate makefiles

Texas Instruments Code Composer Studio 4

checkEnvSetup

Configure your coder product to interact with Code Composer Studio

XMakefile

remoteBuild	Build Simulink-generated code on remote target running Linux
xmakefilesetup	Configure your coder product to generate makefiles

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

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

Processor-in-the-Loop

Connectivity Configuration	Define processor-in-the-loop (PIL) configuration
Build	Configure PIL build process
Timer	Create and configure timer object
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

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

Build

rtw.connectivity.MakefileBuilder

Configure makefile-based build process

Timer

rtw.connectivity.Timer

Create and configure timer object for target

Execution Download, Start 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

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
enableCPP	Enable C++ support for function entry in TFL table
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
registerCPPFunctionEntry	Create TFL C++ 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)
setNameSpace	Set name space for C++ function entry in TFL table
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

Class Reference

Related Products & Applications

Get Simulink trial software

Learn more about Simulink through this collection of videos, articles, technical literature and the Getting Started with Simulink Guide.

Get this Simulink Kit

Search MATLAB Documentation
R2011b Documentation → Embedded Coder
View documentation for other releases	Learn more about Embedded Coder