Mathworks REAL-TIME WORKSHOP EMBEDDED CODER 5 Reference

Download

Page 1

Real-Time Worksho

Reference

Embedded Coder™ 5

Page 2

How to Contact The MathWorks

www.mathworks. comp.soft-sys.matlab Newsgroup www.mathworks.com/contact_TS.html T echnical Support

suggest@mathworks.com Product enhancem ent suggestions bugs@mathwo doc@mathworks.com Documentation error reports service@mathworks.com Order status, license renewals, passcodes info@mathwo

com

rks.com

Web

Bug reports

Sales, prici

ng, and general information

508-647-7000 (Phone)

508-647-7001 (Fax)

The MathWorks, Inc. 3 Apple Hill Drive Natick, MA 01760-2098

For contact information about worldwide offices, see the MathWorks Web site.

Real-Time Workshop

The software described in this document is furnished under a license agreement. The software may be used or copied only under the terms of the license agreement. No part of this manual may be photocopied or reproduced in any form without prior written consent from The MathW orks, Inc.

FEDERAL ACQUISITION: This provision applies to all acquisitions of the Program and Documentation by, for, or through the federal government of the United States. By accepting delivery of the Program or Documentation, the government hereby agrees that this software or documentation qualifies as commercial computer software or commercial computer software documentation as such terms are used or defined in FAR 12.212, DFARS Part 227.72, and DFARS 252.227-7014. Accordingly, the terms and conditions of this Agreement and only those rights specified in this Agreement, shall pertain to and govern theuse,modification,reproduction,release,performance,display,anddisclosureoftheProgramand Documentation by the federal government (or other entity acquiring for or through the federal government) and shall supersede any conflicting contractual terms or conditions. If this License fails to meet the government’s needs or is inconsistent in any respect with federal procurement law, the government agrees to return the Program and Docu mentation, unused, to The MathWorks, Inc.

Trademarks

MATLAB and Simulink are registered trademarks of The MathWorks, Inc. See

www.mathworks.com/trademarks for a list of additional trademarks. Other product or brand

names may be trademarks or registered trademarks of their respective holders.

Patents

The MathWorks products are protected by one or more U.S. patents. Please see

www.mathworks.com/patents for more information.

Embedded Coder™ Reference

Page 3

Revision History

September 2006 Online only New for Version 4.5 (Release 2006b) March 2007 Online only Revised for Version 4.6 (Release 2007a) September 2007 Online only Revised for Version 5.0 (Release 2007b) March 2008 Online only Revised for Version 5.1 (Release 2008a) October 2008 Online only Revised for Version 5.2 (Release 2008b) March 2009 Online only Revised for Version 5.3 (Release 2009a) September 2009 Online only Revised for Version 5.4 (Release 2009b) March 2010 Online only Revised for Version 5.5 (Release 2010a)

Page 4

Page 5

Function Reference

AUTOSAR ......................................... 1-2

AUTOSAR Component Import AUTOSAR Configuration

....................... 1-2

........................... 1-3

Contents

C++ Encapsulation Interface Control

Code Generation Objectives Customization

Code Generation Verification

Function Prototype Control

Model Entry Points

Processor-in-the-Loop

Connectivity Configuration Build Execution Download, Start and Stop Host and Target Communications Host-Side Communications Target-Side Communications

System Target File Callback Interface

Target Function Library Table Creation

............................................ 1-13

................................ 1-12

.............................. 1-13

....................... 1-9

........................ 1-10

......................... 1-13

......................... 1-14

........................ 1-14

................ 1-6

.................. 1-14

.................... 1-14

............... 1-15

............. 1-16

.......... 1-8

Page 6

Class Reference

AUTOSAR ......................................... 2-1

AUTOSAR Component Import AUTOSAR Configuration

....................... 2-1

........................... 2-1

C++ Encapsulation Interface Control

Code Generation Objectives Customization

Code Generation Verification

Function Prototype Control

....................... 2-2

........................ 2-2

................ 2-2

.......... 2-2

Alphabetical List

Block Reference

AUTOSAR Client-Server Communication ............ 4-2

vi Contents

Configuration Wizards

Module Packaging

................................. 4-4

............................. 4-3

Page 7

Blocks — Alphabetical List

Configuration Parameters

Real-Time Workshop Pane: SIL and PIL Verification .. 6-2

Real-Time Workshop: SIL and PIL Verification Tab

Overview Enable portable word sizes Create SIL block Code coverage tool

...................................... 6-4

.......................... 6-5

.................................. 6-7

................................. 6-9

Real-Time Workshop Pane: Code Style

Real-Time Workshop: Code Style Tab Overview Parentheses l ev el Preserve operand order in expression Preserve condition expression in if statement Convert if-elseif-else patterns to switch-case statements Preserve extern keyword in function declaratio ns

Real-Time Workshop Pane: Templates

Real-Time Workshop: Templates Tab Overview Code templates: Source file (*.c) template Code templates: Header file (*.h) template Data templates: Source file (*.c) template Data templates: Header file (*.h) template File customization template Generate an example main program Target operating system

Real-Time Workshop Pane: Code Placement

Real-Time W orkshop: Code Placement Tab Overview Data definition Data definition filename Data declaration Data declaration filename #include file delimiter Module naming

................................. 6-13

......................... 6-29

............................ 6-32

................................... 6-37

............................ 6-39

.................................. 6-41

.......................... 6-43

.............................. 6-44

................................... 6-45

.............. 6-10

................. 6-15

........... 6-16

............... 6-22

.............. 6-25

............. 6-26

.............. 6-27

............. 6-28

.................. 6-30

........ 6-12

.. 6-18

....... 6-20

......... 6-24

......... 6-34

.... 6-36

vii

Page 8

Module name ..................................... 6-47

Signal display level Parameter tune level File packaging format

................................ 6-49

............................... 6-51

.............................. 6-53

Real-Time Workshop Pane: Data Type Replacement

Real-Time Workshop: Data Type Replacement Tab

Overview Replace data type names in the generated code Replacement Name: double Replacement Name: single Replacement Name: int32 Replacement Name: int16 Replacement Name: int8 Replacement Name: uint32 Replacement Name: uint16 Replacement Name: uint8 Replacement Name : boolean Replacement Name: int Replacement Name: uint Replacement Name: char

Real-Time Workshop Pane: Memory Sections

Real-Time W orkshop: Memory Sections Tab Overview Package Refresh package list Initialize/Terminate Execution Constants Inputs/Outputs Internal data Parameters Validation results

...................................... 6-58

......... 6-59

......................... 6-61

.......................... 6-63

.......................... 6-65

.......................... 6-67

........................... 6-69

......................... 6-71

......................... 6-73

.......................... 6-75

........................ 6-77

............................ 6-79

........................... 6-81

........................... 6-83

........ 6-85

......................................... 6-88

............................... 6-90

............................... 6-91

........................................ 6-92

........................................ 6-93

................................... 6-95

..................................... 6-97

...................................... 6-99

................................. 6-101

.. 6-56

... 6-87

viii Contents

Real-Time Workshop Pane: AUTOSAR Code Generation

Options

Real-Time Workshop: AUTOSAR Code Generation Options

Tab Overview Generate XML file from schema version Use AUTOSAR compiler abstraction macros Configure AUTOSAR Interface

......................................... 6-102

.................................. 6-104

............... 6-105

........... 6-105

...................... 6-107

Page 9

Parameter Reference .............................. 6-108

Recommended S ettings Summary Parameter Command-Line Information Summary

.................... 6-108

....... 6-120

Index

Page 10

x Contents

Page 11

Function Reference

AUTOSAR (p. 1-2) Control AUTOSAR component

configuration for import, code generation, and XML file export from Simulink

models

C++ Encapsulation Interface Control (p. 1-6)

Code Generation Objectives Customization (p. 1-8)

Code Generation Verification (p. 1-9) Compare numerical equivalence

Function Prototype Control (p. 1-10) Control step function prototypes

Model Entry Points (p. 1-12) Access entry points in generated

Processor-in-the-Loop (p. 1-13) Control processor-in-the-loop (PIL)

System Target File Callback Interface (p. 1-15)

Target Function Library Table Creation (p. 1-16)

Control C++ encapsulation interfaces in generated code for ERT-based Simulink models

Control step function prototypes in generated code for ERT-based Simulink models

of simulation and generated code results

in generated code for ERT-based Simulink models

code for ERT-based Simulink models

configuration

Control Real-Time Workshop configuration o p t ions in callbacks for ERT-based custom targets

Create function replacement tables that make up Real-Time Workshop target function libraries (TFLs)

Page 12

1 Function Reference

AUTOSAR

AUTOSAR Component Import (p. 1-2)

AUTOSAR Configuration (p. 1-3) Control and validate AUTOSAR

Control import of AUT OSA R components

configuration

AUTOSAR Component Import

arxml.importer

createCalibrationComponentObjects (arxml.importer)

createComponentAsModel (arxml.importer)

createComponentAsSubsystem (arxml.importer)

createOperationAsConfigurableSubsystems (arxml.importer)

getCalibrationComponentNames (arxml.importer)

Construct

Create Simulink calibration objects from AUTOSAR calibration component

Create AUTOSAR atomic software component as Simulink model

Create AUTOSAR atomic software component as Simulink atomic subsystem

Create configurable Simulink subsystem library for client-server operation

Get calibration component names

arxml.importer object

1-2

getComponentNames (arxml.importer)

getDependencies (arxml.importer) Get list of XML dependency files

getFile (arxml.importer) Return XML file name for

setDependencies (arxml.importer) Set XML file dependencies

setFile (arxml.importer) S et XML file name for

Get atomic software component names

arxml.importer object

Page 13

AUTOSAR Configuration

addIOConf (RTW.AutosarInterface) Add AUTOSAR I/O configuration to

model

AUTOSAR

attachToModel (RTW.AutosarInterface)

getComponentName (RTW.AutosarInterface)

getDataTypePackageName (RTW.AutosarInterface)

getDefaultConf (RTW.AutosarInterface)

getExecutionPeriod (RTW.AutosarInterface)

getImplementationName (RTW.AutosarInterface)

getInitEventName (RTW.AutosarInterface)

getInitRunnableName (RTW.AutosarInterface)

getInterfacePackageName (RTW.AutosarInterface)

getInternalBehaviorName (RTW.AutosarInterface)

Attach object to mode l

Get XML component name

Get XML data type package name

Get default configuration

Get runnable execution period

Get XML implementation name

Getinitialeventname

Get initial runnable name

Get XM L interface package name

Get XML internal behavior name

RTW.AutosarInterface

getIOAutosarPortName (RTW.AutosarInterface)

getIODataAccessMode (RTW.AutosarInterface)

getIODataElement (RTW.AutosarInterface)

getIOErrorStatusReceiver (RTW.AutosarInterface)

GetI/OAUTOSARportname

Get I/O data access mode

Get I/O data element name

Get receiver port name

1-3

Page 14

1 Function Reference

getIOInterfaceName (RTW.AutosarInterface)

getIOPortNumber (RTW.AutosarInterface)

getIOServiceInterface (RTW.AutosarInterface)

getIOServiceName (RTW.AutosarInterface)

getIOServiceOperation (RTW.AutosarInterface)

getIsServerOperation (RTW.AutosarInterface)

getPeriodicEventName (RTW.AutosarInterface)

getPeriodicRunnableName (RTW.AutosarInterface)

getPortDefaultConf (RTW.AutosarInterface)

getServerInterfaceName (RTW.AutosarInterface)

Get I/O interface name

Get I/O AUTOSAR port number

GetportI/Oserviceinterface

GetportI/Oservicename

GetportI/Oserviceoperation

Determine whether server is specified

Get periodic event name

Get periodic runnable name

Getportdefaultconfiguration

Get name of server interface

1-4

getServerOperationPrototype (RTW.AutosarInterface)

getServerPortName (RTW.AutosarInterface)

getServerType (RTW.AutosarInterface)

RTW.AutosarInterface Construct

runValidation (RTW.AutosarInterface)

setComponentName (RTW.AutosarInterface)

Get server operation prototype

Get server port name

Determine server type

object

Validate object against model

SetXMLcomponentname

RTW.AutosarInterface

Page 15

AUTOSAR

setInitEventName (RTW.AutosarInterface)

setInitRunnableName (RTW.AutosarInterface)

setIOAutosarPortName (RTW.AutosarInterface)

setIODataAccessMode (RTW.AutosarInterface)

setIODataElement (RTW.AutosarInterface)

setIOInterfaceName (RTW.AutosarInterface)

setIsServerOperation (RTW.AutosarInterface)

setPeriodicEventName (RTW.AutosarInterface)

setPeriodicRunnableName (RTW.AutosarInterface)

setServerInterfaceName (RTW.AutosarInterface)

Set initial event name

Set initial runnable name

Set A UTOSAR port name

Set I/O data access mode

Set I/O data element

Set I/O interface name

Indicate that server is specified

Set periodic event name

Set p eriodic runnable name

Set name of server interface

setServerOperationPrototype (RTW.AutosarInterface)

setServerPortName (RTW.AutosarInterface)

setServerType (RTW.AutosarInterface)

syncWithModel (RTW.AutosarInterface)

Specify operation prototype

Set server port name

Specify server type

Synchronize configuration with model

1-5

Page 16

1 Function Reference

C++ Encapsulation Interface Control

attachToModel (RTW.ModelCPPClass)

getArgCategory (RTW.ModelCPPArgsClass)

getArgName (RTW.ModelCPPArgsClass)

getArgPosition (RTW.ModelCPPArgsClass)

getArgQualifier (RTW.ModelCPPArgsClass)

getClassName (RTW.ModelCPPClass)

getDefaultConf (RTW.ModelCPPClass)

Attach model-specific C++ encapsulation interface to loaded ERT-based Simulink model

Get argume nt category for Simulink model port from model-specific C++ encapsulation interface

GetargumentnameforSimulink model port from model-specific C++ encapsulation interface

GetargumentpositionforSimulink model port from model-specific C++ encapsulation interface

Getargumenttypequalifier for Simulink model port from model-specific C++ encapsulation interface

Get class nam e from model-specific C++ encapsulation interface

Get default config u ration information for model-specific C++ encapsulation interface from Simulink model

1-6

getNumArgs (RTW.ModelCPPClass) Get number of step method

arguments from model-specific C++ encapsulation interface

getStepMethodName (RTW.ModelCPPClass)

RTW.configSubsystemBuild Configure C function prototype

Getstepmethodnamefrom model-specific C++ encapsulation interface

or C++ encapsula tio n interface for right-click bui ld of specified subsystem

Page 17

C++ Encapsulation Interface Control

RTW.getEncapsulationInterfaceSpecificationGethandletomodel-specificC++

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)

runValidation (RTW.ModelCPPVoidClass)

setArgCategory (RTW.ModelCPPArgsClass)

setArgName (RTW.ModelCPPArgsClass)

setArgPosition (RTW.ModelCPPArgsClass)

setArgQualifier (RTW.ModelCPPArgsClass)

setClassName (RTW.ModelCPPClass)

setStepMethodName (RTW.ModelCPPClass)

Validate model-specific C++ encapsulation interface against Simulink model

Set argume nt category for Simulink model port in model-specific C++ encapsulation interface

Set argument name for Simulink model port in model-specific C++ encapsulation interface

SetargumentpositionforSimulink model port in model-specific C++ encapsulation interface

Setargumenttypequalifier for Simulink model port in model-specific C++ encapsulation interface

Set class name in model-specific C++ encapsulation interface

Setstepmethodnamein model-specific C++ encapsulation interface

1-7

Page 18

1 Function Reference

Code Generation Objectives Customization

addCheck (rtw.codegenObjectives.Objective)

addParam (rtw.codegenObjectives.Objective)

excludeCheck (rtw.codegenObjectives.Objective)

modifyInheritedParam (rtw.codegenObjectives.Objective)

removeIn (rtw.cod

removeInheritedParam (rtw.codegenObjectives.Objective)

rtw.codegenObjectives.Objective Create custom code generation

setObjectiveName (rtw.codegenObjectives.Objective)

genObjectives.Objective)

heritedCheck

egenObjectives.Objective)

Add checks

Add parameters

Exclude chec

Modify inherited parameter values

Remove inherited checks

Remove inherited parameters

objectives

Specify objective name

bjective

1-8

Page 19

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

compare (cgv.CGV) Compare signal data

configModel (cgv.Config) Determine and change configuration

createToleranceFile (cgv.CG V ) Create file correlating tolerance

displayReport (cgv.Config) Display results of comparing

getOutputData (cgv.CGV) Get output data

getReportData (cgv.Config) Return results of comparing

Code Generation Verification

parameter values

information with signal names

configuration parameter values

getSavedSignals (cgv.CGV) Display list of signal names to

command line

plot (cgv.CGV) Create plot for signal or multiple

signals

run (cgv.CGV) Execute CGV object

setOutputDir (cgv.CGV) Specify folder

setOutputFile (cgv.CGV) Specify output data file name

1-9

Page 20

1 Function Reference

Function Prototype Control

addArgConf (RTW.ModelSpecificCPrototype)

attachToModel (RTW.ModelSpecificCPrototype)

getArgCategory (RTW.ModelSpecificCPrototype)

getArgName (RTW.ModelSpecificCPrototype)

getArgPosition (RTW.ModelSpecificCPrototype)

getArgQualifier (RTW.ModelSpecificCPrototype)

getDefaultConf (RTW.ModelSpecificCPrototype)

Add argument configuration information for Simulink model port to model-specific C function prototype

Attach model-specific C function prototype to loaded ERT -bas ed Simulink model

Get argume nt category for Simulink model port from model-specific C function prototype

GetargumentnameforSimulink model port from model-specific C function prototype

GetargumentpositionforSimulink model port from model-specific C function prototype

Getargumenttypequalifier for Simulink model port from model-specific C function prototype

Get default config u ration information for model-specific C function prototype from Simulink model

1-10

getFunctionName (RTW.ModelSpecificCPrototype)

getNumArgs (RTW.ModelSpecificCPrototype)

getPreview (RTW.ModelSpecificCPrototype)

Get function name from model-specific C function prototype

Get number of function arguments from model-specific C function prototype

Get model-specific C function prototype code preview

Page 21

Function Prototype Control

RTW.configSubsystemBuild Configure C function prototype

or C++ encapsula tio n interface for right-click bui ld 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)

setArgCategory (RTW.ModelSpecificCPrototype)

setArgName (RTW.ModelSpecificCPrototype)

setArgPosition (RTW.ModelSpecificCPrototype)

setArgQualifier (RTW.ModelSpecificCPrototype)

setFunctionName (RTW.ModelSpecificCPrototype)

Validate model-specific C function prototype against Simulink model

Set argume nt category for Simulink model port in model-specific C function prototype

Set argument name for Simulink model port in model-specific C function prototype

SetargumentpositionforSimulink model port in model-specific C function prototype

Setargumenttypequalifier for Simulink model port in model-specific C function prototype

Setfunctionnameinmodel-specific C function prototype

1-11

Page 22

1 Function Reference

Model Entry Points

model_initialize Initialization entry point in

model_SetEventsForThisBaseStep Set event flags for multirate,

generated code for ERT-based Simulink model

multitasking operation before calling

model_step for ERT-based Simulink

model — not generated as of Version

5.1 (R2008a)

model_step

model_ter

minate

Step routine entry point in generated code for ERT-based Simulink model

Terminati code for ER

on entry point in generated

T-based Simulink model

1-12

Page 23

Processor-in-the-Loop

Connectivity Configuration (p. 1-13) Define processor-in-the-loop (PIL)

Build (p. 1-13) Configure PIL build process

Processor-in-the-Loop

configuration

Execution Download, Start and Stop (p. 1-14)

Host and Target Communications (p. 1-14)

Host-Side C om m u n i cation s (p. 1-14) Configure host-side communications

Target-Side Communications (p. 1-14)

Control downloading, starting and resetting PIL executable on target hardware

Configure host-target communications

channel and drivers

Configure target-side communications channel and drivers

Connectivity Configuration

rtw.connectivity.ComponentArgs

rtw.connectivity.Config Define connectivity implementation,

rtw.connectivity.ConfigRegistry Register connectivity configuration

Provide parameters to each target connectivity component

comprising builder, launcher, and communicator components

Bui

rtw.connectivity.MakefileBuilder Configure makefile-based build

process

1-13

Page 24

1 Function Reference

Execution Downl

rtw.connectivi

ty.Launcher

Host and Targe

rtIOStreamClose Shut down communications channel

rtIOStreamOpen

rtIOStrea

mRecv

mSend

oad, Start and Stop

Control downloading, starting and resetting executable on target hardware

t Communications

with remote processor

Initialize with remote

Receive da

Send data t

communications channel

processor

ta from remote processor

o remote p roce ssor

Host-Side Communications

rtiostream_wrapper Test rtiostream shared library

methods

rtw.connectivity.RtIOStreamHostCommunicator

Configure host-side communications

1-14

Target-Side Communications

rtw.pil.RtIOStreamApplicationFramework

Configure target-side communications

Page 25

System Target File Callback Interface

slConfigUIGetVal Return current value for custom

target configuration option

System Target File Callback Interface

slConfigUISetEnabled

slConfigUISetVal Set value for custom target

Enable or disable custom target configuration option

configuration option

1-15

Page 26

1 Function Reference

Target Function Library Table Creation

addAdditionalHeaderFile Add additional header file to array of

addAdditionalIncludePath Add additional include path to array

addAdditionalLinkObj Add addi t ional link object to array of

addAdditionalLinkObjPath Add additional link object path to

addAdditionalSourceFile Add additional source file to array of

additional header files for TFL table entry

of additional include paths for TFL table entry

additional link objects for TFL table entry

array of additional link object paths for TFL table entry

additional source files for TFL table entry

1-16

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

copyConceptualArgsToImplementationCopy conceptual argument

createAndAddConceptualArg Create conceptual argument from

Add table entry to collection of table entries registered in TFL table

specifications to matching implementation arguments for TFL table entry

specified properties an d add to conceptual arguments for TFL table entry

Page 27

Target Function Library Table Creation

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 p arame ters 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

identifierstobeassociatedwithTFL table

setTflCFunctionEntryParameters Set specified parameters for function

entry in TFL table

setTflCOperationEntryParameters Set specified parameters for operator

entry in TFL table

1-17

Page 28

1 Function Reference

1-18

Page 29

Class Reference

• “AUTOSAR” on page 2-1

• “C++ Encapsulation Interface Control” on page 2-2

• “Code Generation Objectives Customization” on p age 2-2

• “Code Generation Verification” on page 2-2

• “Function Prototype Control” on page 2-2

AUTOSAR

In this section...

“AUTOSAR Component Import” on page 2-1

“AUTOSAR Configuration” on page 2-1

AUTOSAR Component Import

arxml.importer

AUTOSAR Configuration

RTW.AutosarInterface Control and validate AUTOSAR

Control import of AUT OSA R components

configuration

Page 30

2 Class Reference

C++ Encapsulation Interface Control

RTW.ModelCPPArgsClass Control C++ encapsulation interfaces

for models using I/O arguments style step method

RTW.ModelCPPClass Control C++ encapsulation interfaces

for models

RTW.ModelCPPVoidClass Control C++ encapsulation interfaces

for models using step method

Code Generation Objectives Customization

rtw.codegenObjectives.Objective Customize code generation objectives

void-void style

Code Generation Verification

cgv.CGV Verify numerical equivalence of

cgv.Config Check and modify model

Function Prototype Control

RTW.ModelSpecificCPrototype Describe signatures of functions for

2-2

results

configuration parameter values

model

Page 31

Alphabetical List

Page 32

addAdditionalHeaderFile

Purpose Add additional header file to array of additional header files for TFL

table entry

Syntax addAdditionalHeaderFile(hEntry, headerFile)

Arguments hEntry

Handle to a TFL table entry previously returned by instantiating a TF L entry class, such as

hEntry = RTW.TflCOperationEntry.

headerFile

String specifying an additional header file.

Description The addAdditionalHeaderFile function adds a specified additional

header file to the array of additional header files for a TFL table entry.

Example In the following example, the addAdditionalHeaderFile

function is used along with addAdditionalIncludePath,

addAdditionalSourceFile,andaddAdditionalSourcePath to fully

specify additional header and source files for a TFL table entry.

hEntry = RTW.TflCFunctionEntry or

% Path to external header and source files

libdir = fullfile('$(MATLAB_ROOT)','..', '..', 'lib');

op_entry = RTW.TflCOperationEntry;

addAdditionalHeaderFile(op_entry, 'all_additions.h');

addAdditionalIncludePath(op_entry, fullfile(libdir, 'include'));

addAdditionalSourceFile(op_entry, 'all_additions.c');

addAdditionalSourcePath(op_entry, fullfile(libdir, 'src'));

See Also addAdditionalIncludePath, addAdditionalSourceFile,

addAdditionalSourcePath

3-2

Page 33

addAdditionalHeaderFile

“Specifying Build Information for Function Replacements” in the Real-Time Workshop

“Replacing Math Functions and Operators Using Target Function Libraries” in the Real-Time Workshop Embedded Coder documentation

Embedded Coder™ documentation

3-3

Page 34

addAdditionalIncludePath

Purpose Add additional include path to array of additional include paths for

TFL table entry

Syntax addAdditionalIncludePath(hEntry, path)

Arguments hEntry

Handle to a TFL table entry previously returned by instantiating a TF L entry class, such as

hEntry = RTW.TflCOperationEntry.

path

String specifying the full path to an additional header file.

Description The addAdditionalIncludePath function adds a specified additional

include path to the array of additional include paths for a TFL table entry.

Example In the following example, the addAdditionalIncludePath

function is used along with addAdditionalHeaderFile,

addAdditionalSourceFile,andaddAdditionalSourcePath to fully

specify additional header and source files for a TFL table entry.

hEntry = RTW.TflCFunctionEntry or

% Path to external header and source files

libdir = fullfile('$(MATLAB_ROOT)','..', '..', 'lib');

op_entry = RTW.TflCOperationEntry;

addAdditionalHeaderFile(op_entry, 'all_additions.h');

addAdditionalIncludePath(op_entry, fullfile(libdir, 'include'));

addAdditionalSourceFile(op_entry, 'all_additions.c');

addAdditionalSourcePath(op_entry, fullfile(libdir, 'src'));

See Also addAdditionalHeaderFile, addAdditionalSourceFile,

addAdditionalSourcePath

3-4

Page 35

addAdditionalIncludePath

“Specifying Build Information for Function Replacements” in the Real-Time Workshop Embedded Coder documentation

“Replacing Math Functions and Operators Using Target Function Libraries” in the Real-Time Workshop Embedded Coder documentation

3-5

Page 36

addAdditionalLinkObj

Purpose Add additional link object to array of additional link objects for TFL

table entry

Syntax addAdditionalLinkObj(hEntry, linkObj)

Arguments hEntry

Handle to a TFL table entry previously returned by instantiating a TF L entry class, such as

hEntry = RTW.TflCOperationEntry.

linkObj

String specifying an additional link object.

Description The addAdditionalLinkObj function adds a specified additional link

object to the array of additional link objects for a TFL table entry.

Example In the following example, the addAdditionalLinkObj function is used

along with link object file for a TFL table entry.

addAdditionalLinkObjPath to fu lly specify an additional

hEntry = RTW.TflCFunctionEntry or

% Path to external object files

libdir = fullfile('$(MATLAB_ROOT)','..', '..', 'lib');

op_entry = RTW.TflCOperationEntry;

...

addAdditionalLinkObj(op_entry, 'addition.o');

addAdditionalLinkObjPath(op_entry, fullfile(libdir, 'bin'));

See Also cgv.CGV

Tutorials • “How To Verify a SIL or PIL Configuration”

How To • “Configuring a PIL Simulation”

• “Choosing a PIL Approach”

• “Managing Configuration Sets”

3-46

Page 77

cgv.CGV.compare

Purpose Compare signal data

Syntax [matchNames, matchFigures, mism atch Names,

mismatchFigures] = cgv.CGV.compare(data_set1, data_set2)

[matchNames, matchFigures, mism atch Names,

mismatchFigures] = cgv.CGV.compare(data_set1, data_set2, 'Plot', 'param_value')

[matchNames, matchFigures, mism atch Names,

mismatchFigures] = cgv.CGV.compare(data_set1, data_set2, 'Plot', 'none', 'Signals', signa l_list, 'ToleranceFile', 'file_name.mat')

Description [matchNames, matchFigures, mismatchNames, mismatchFigures]

= cgv.CGV.compare(data_set1, data_set2)

data s ets which have common signal names between both executions. Possible outputs of the names, figure handles to the matched signal names, mismatched signal names, and figure handles to the mismatched signal names. By default,

cgv.CGV.compare looksatallsignalswhichhaveacommonname

betweenbothexecutions.

cgv.CGV.compare function are matched signal

compares data from two

Input Arguments

[matchNames, matchFigures, mism atch Names, mismatchFigures] = cgv.CGV.compare(data_set1, data_set2, 'Plot', 'param_value')

param_value.

[matchNames, matchFigures, mism atch Names, mismatchFigures] = cgv.CGV.compare(data_set1, data_set2, 'Plot', 'none', 'Signals', signal_list, 'ToleranceFile', 'f ile_name.mat')

compares only the given signals and produces no plots.

data_set1, data_set2

Output data from a model. After running the model, use the

cgv.CGV.getOutputData function to get the data. The

cgv.CGV.getOutputData function returns a cell array o f all output signal names.

compares all signals and plots the signals according

3-47

Page 78

cgv.CGV.compare

varargin

Variable number of parameter name and value pairs.

varargin Parameters

You can specify the following argument properties for the

cgv.CGV.compare function using parameter name and value argument

pairs. These parameters are optional.

Plot(optional)

Designates which comparison data to plot. The value of this parameter must be one of the following:

•

'match': plot the comparison of the matched signals from the

two datasets

•

'mismatch'(default): plot the comparison of the mismatched

signals from the two datasets

•

'none': donotproduceaplot

Signals(optional)

A cell array of strings, where each string is a signal name in the

dataset.Usecgv.CGV.getSavedSignals to view the list

of available signal names in the

dataset. signal_list can

contain an individual signal or multiple signals. The syntax for an individual signal name is:

signal_list = {'log_data.subsystem_name.Data(:,1)'}

The syntax for multiple signal names is:

3-48

signal_list = {'log_data.block_name.Data(:,1)',...

'log_data.block_name.Data(:,2)',...

'log_data.block_name.Data(:,3)',... 'log_data.block_name.Data(:,4)'};

If a m odel component contains a space or newline character, MATLAB adds parantheses and a single quote to the name of the component. For example, if a section of the signal has a space,

'block name', MATLAB displays the signal name as:

Page 79

cgv.CGV.compare

log_data.('block name').Data(:,1)

To use the signal name as input to a CGV function, 'block name' must have two single quotes. For example:

signal_list = {'log_data.(''block name'').Data(:,1)'}

If Signals is not present, all signals are compared.

Tolerancefile(optional)

Name for the file created by the function. The file contains the signal names and the associated tolerance parameter name and value pair for comparing the data.

cgv.CGV.createToleranceFile

Output Arguments

Depending on the data and the parameters, any of the following output arguments might be empty.

match_names

Cell array of matching signal names.

match_figures

Array of figure handles for matching signals

mismatch_names

Cell array of mismatching signal names

mismatch_figures

Array of figure handles for mismatching signals

How To • “Verifying Numerical Equivalence of Results with Code Generation

Verification API”

3-49

Page 80

cgv.Config.configModel

Purpose Determine and change configuration parameter values

Syntax cfgObj.configModel()

Description cfgObj.configModel() determines the recommended values for

the configuration parameters in the model.

cgv.Config object. The ReportOnly property of the object determines

whether values.

configModel reports or changes the configuration parameter

Tutorials • “How To Verify a SIL or PIL Configuration”

How To • “Configuring a PIL Simulation”

• “Managing Configuration Sets”

cfgObj isahandletoa

3-50

Page 81

copyConceptualArgsToImplementation

Purpose Copy conceptual argument specifications to matching implementation

arguments for TFL table entry

Syntax copyConceptualArgsToImplementation(hEntry)

Arguments hEntry

Handle to a TFL table entry previously returned by instantiating a TF L entry class, such as

hEntry = RTW.TflCOperationEntry.

Description The copyConceptualArgsToImplementation function provides a

quick way to copy conceptual argument specifications to matching implementation arguments. This function can be used when the conceptual arguments and the implementation arguments are the same for a TFL table entry.

Example In the following example, the copyConceptualArgsToImplementation

function is used to copy conceptual argument specifications to matching implementation arguments for an addition operation.

hEntry = RTW.TflCFunctionEntry or

hLib = RTW.TflTable;

% Create an entry for addition of built-in uint8 data type

op_entry = RTW.TflCOperationEntry;

op_entry.setTflCOperationEntryParameters( ...

'Key', 'RTW_OP_ADD', ...

'Priority', 90, ...

'SaturationMode', 'RTW_SATURATE_ON_OVERFLOW', ...

'RoundingMode', 'RTW_ROUND_UNSPECIFIED', ...

'ImplementationName', 'u8_add_u8_u8', ...

'ImplementationHeaderFile', 'u8_add_u8_u8.h', ...

'ImplementationSourceFile', 'u8_add_u8_u8.c' );

arg = hLib.getTflArgFromString('y1','uint8');

arg.IOType = 'RTW_IO_OUTPUT';

op_entry.addConceptualArg( arg );

3-51

Page 82

copyConceptualArgsToImplementation

arg = hLib.getTflArgFromString('u1','uint8');

op_entry.addConceptualArg( arg );

arg = hLib.getTflArgFromString('u2','uint8');

op_entry.addConceptualArg( arg );

op_entry.copyConceptualArgsToImplementation();

hLib.addEntry( op_entry );

See Also “Creating Function Replacement Tables” in the Real-Time Workshop

Embedded Coder documentation

“Replacing Math Functions and Operators Using Target Function Libraries” in the Real-Time Workshop Embedded Coder documentation

3-52

Page 83

createAndAddConceptualArg

Purpose Create conceptual argument from specified properties and add to

conceptual arguments for TFL table entry

Syntax arg = createAndAddConceptualArg(hEntry, argType, varar gin)

Arguments hEntry

Handle to a TFL table entry previously returned by instantiating a TF L entry class, such as

hEntry = RTW.TflCOperationEntry.

argType

String specifying the argument type to create:

'RTW.TflArgNumeric' for numeric or 'RTW.TflArgMatrix' for

matrix.

varargin

Parameter/value pairs for the conceptual argument. See varargin Parameters.

hEntry = RTW.TflCFunctionEntry or

varargin Parameters

The following argument properties can be specified to the

createAndAddConceptualArg function using param eter/value

argument pairs. For example,

createAndAddConceptualArg(..., 'DataTypeMode', 'double', ...);

Name

String specifying the argument name, for example, 'y1' or 'u1'.

IOType

String specifying the I/O type of the argument: 'RTW_IO_INPUT' for input or 'RTW_IO_OUTPUT' for output. The default is

'RTW_IO_INPUT'.

IsSigned

Boolean value that, when set to true, indicates that the argument is signed. The default is

true.

3-53

Page 84

createAndAddConceptualArg

WordLength

Integer specifying the word length, in bits, of the argument. The default is

CheckSlope

Boolean flag that, when set to true for a fixed-point argument, causes TFL replacement request processing to check that the slope value of the argument exactly matches the call-site slope value. The default is

16.

true.

Specify

true if you are matching a specific [slope bias] scaling

combination or a specific binary-point-only sca li n g combination on fixed-point operator inputs and output. Specify

false if you are

matching relative scaling or relative slope and bias values across fixed-point operator inputs and output.

CheckBias

Boolean flag that, when set to true for a fixed-point argument, causes TFL replacement request processing to check that the bias value of the argument exactly matches the call-site bias value. The default is

Specify

true if you are matching a specific [slope bias] scaling

true.

combination or a specific binary-point-only sca li n g combination on fixed-point operator inputs and output. Specify

false if you are

matching relative scaling or relative slope and bias values across fixed-point operator inputs and output.

DataTypeMode

String specifying the d ata type mode of the argument: 'boolean',

'double', 'single', 'Fixed-point: binary point scaling',

'Fixed-point: slope and bias scaling'. The default is

'Fixed-point: binary point scaling'.

Note You can specify either DataType (with Scaling)or

DataTypeMode, but do not specify both.

3-54

Page 85

createAndAddConceptualArg

DataType

String specifying the data type of the argument: 'boolean',

'double', 'single',or'Fixed'. The default is 'Fixed'.

Scaling

String specifying the data type scaling of the argument:

'BinaryPoint' for binary-point scaling or 'SlopeBias' for slope

and bias scaling. The default is

Slope

Floating-point value specifying the slope of the argument, for example,

15.0. The default is 1.

If you are matching a specific [slope bias] scaling combination on fixed-point operator inputs and output, specify either this parameteroracombinationofthe

FixedExponent parameters

SlopeAdjustmentFactor

Floating-point value specifying the slope adjustment factor (F) part of the slope,

, of the argument. The default is 1.0.

'BinaryPoint'.

SlopeAdjustmentFactor and

If you are matching a specific [slope bias] scaling combination on fixed-point operator inputs and output, specify either the

Slope parameter or a combination of this parameter and the FixedExponent parameter.

FixedExponent

Integer value specifying the fixed exponent (E)partoftheslope,

, of the argument. The default is -15.

If you are matching a specific [slope bias] scaling combination on fixed-point operator inputs and output, specify either the

Slope parameter or a combination of this parameter and the SlopeAdjustmentFactor parameter.

Bias

Floating-point value specifying the bias of the argument, for example,

2.0.Thedefaultis0.0.

3-55

Page 86

createAndAddConceptualArg

Specify this parameter if you are matching a specific [slope bias] scaling combination on fix ed-point operator inputs and output.

FractionLength

Integer value specifying the fraction length for the argument, for example,

Specify this parameter if y ou are matching a specific binary-point-only scaling combination on fixed-point operator inputs and output.

BaseType

String specifying the base data type for which a matrix argument is valid, for example,

DimRange

Dimensions for which a matrix argument is valid, for example,

[2 2]. You can also specify a range of dimensions specified in the

format

... DimNMax]

two-dimensional m atrix of size 2x2 or larger.

3.Thedefaultis15.

[Dim1Min Dim2Min ... DimNMin; Dim1Max Dim2Max

. For example, [2 2; inf inf] means any

'double'.

Returns Handle to the created conceptual argument. Specifying the return

argument in the

createAndAddConceptualArg function call is optional.

Description The createAndAddConceptualArg function creates a conceptual

argument from specified properties and adds the argument to the conceptual arguments for a TFL table entry.

Examples In the following example, thecreateAndAddConceptualArg function

is used to specify conceptual output and input arguments for a TFL operator entry.

op_entry = RTW.TflCOperationEntry;

createAndAddConceptualArg(op_entry, 'RTW.TflArgNumeric', ...

3-56

Page 87

createAndAddConceptualArg

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'IsSigned', true, ...

'WordLength', 32, ...

'FractionLength', 0);

createAndAddConceptualArg(op_entry, 'RTW.TflArgNumeric',...

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT',...

'IsSigned', true,...

'WordLength', 32, ...

'FractionLength', 0 );

createAndAddConceptualArg(op_entry, 'RTW.TflArgNumeric',...

'Name', 'u2', ...

'IOType', 'RTW_IO_INPUT',...

'IsSigned', true,...

'WordLength', 32, ...

'FractionLength', 0 );

The following examples show some common type specifications using

createAndAddConceptualArg.

% uint8:

createAndAddConceptualArg(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT', ...

'IsSigned', false, ...

'WordLength', 8, ...

'FractionLength', 0 );

% single:

createAndAddConceptualArg(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT', ...

'DataTypeMode', 'single' );

3-57

Page 88

createAndAddConceptualArg

% double:

createAndAddConceptualArg(hEntry, 'RTW.TflArgNumeric', ...

% boolean:

createAndAddConceptualArg(hEntry, 'RTW.TflArgNumeric', ...

% Fixed-point using binary-point-only scaling:

createAndAddConceptualArg(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'CheckSlope', true, ...

'CheckBias', true, ...

'DataTypeMode', 'Fixed-point: binary point scaling', ...

'IsSigned', true, ...

'WordLength', 32, ...

'FractionLength', 28);

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'DataTypeMode', 'double' );

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT', ...

'DataTypeMode', 'boolean' );

3-58

% Fixed-point using [slope bias] scaling:

createAndAddConceptualArg(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'CheckSlope', true, ...

'CheckBias', true, ...

'DataTypeMode', 'Fixed-point: slope and bias scaling', ...

'IsSigned', true, ...

'WordLength', 16, ...

'Slope', 15, ...

'Bias', 2);

For examples of fixed-point arguments that use relative scaling or relative slope/bias values, see “Example: Creating Fixed-Point

Page 89

createAndAddConceptualArg

Operator Entries for Relative Scaling (Multiplication and Division)” an d “Example: Creating Fixed-Point Operator Entries for Equal S lope and Zero Net Bias (Addition and Subtraction)” in the Real-Time Workshop Embedded Coder documentation.

See Also “Creating Function Replacement Tables” in the Real-Time Workshop

Embedded Coder documentation

“Replacing Math Functions and Operators Using Target Function Libraries” in the Real-Time Workshop Embedded Coder documentation

3-59

Page 90

createAndAddImplementationArg

Purpose Create implementation argument from specified properties and add to

implementation arguments for TFL table entry

Syntax arg = createAndAddImplementationArg(hEntry, argTyp e,

varargin)

Arguments hEntry

Handle to a TFL table entry previously returned by instantiating a TF L entry class, such as

hEntry = RTW.TflCOperationEntry.

argType

String specifying the argument type to create:

'RTW.TflArgNumeric' for numeric.

varargin

Parameter/value pairs for the implementation argument. See varargin Parameters.

hEntry = RTW.TflCFunctionEntry or

varargin Parameters

3-60

The following argument properties can be specified to the

createAndAddImplementationArg function using parameter/value

argument pairs. For example,

createAndAddImplementationArg(..., 'DataTypeMode', 'double', ...);

Name

String specifying the argument name, for example, 'u1'.

IOType

String specifying the I/O type of the argument: 'RTW_IO_INPUT' for input.

IsSigned

Boolean value that, when set to true, indicates that the argument is signed. The default is

WordLength

Integer specifying the word length, in bits, of the argument. The default is

16.

true.

Page 91

createAndAddImplementationArg

DataTypeMode

String specifying the d ata type mode of the argument: 'boolean',

'double', 'single', 'Fixed-point: binary point scaling',

'Fixed-point: slope and bias scaling'. The default is

'Fixed-point: binary point scaling'.

Note You can specify either DataType (with Scaling)or

DataTypeMode, but do not specify both.

DataType

String specifying the data type of the argument: 'boolean',

'double', 'single',or'Fixed'. The default is 'Fixed'.

Scaling

String specifying the data type scaling of the argument:

'BinaryPoint' for binary-point scaling or 'SlopeBias' for slope

and bias scaling. The default is

'BinaryPoint'.

Slope

Floating-point value specifying the slope of the argument, for example,

15.0. The default is 1.

You can optionally specify either this parameter or a combinatio n of the

SlopeAdjustmentFactor and FixedExponent parameters,

but do not specify both.

SlopeAdjustmentFactor

Floating-point value specifying the slope adjustment factor (F) part of the slope,

You can optionally specify either the combination of this parameter and the

, of the argument. The default is 1.0.

Slope parameter or a

FixedExponent parameter,

but do not specify both.

FixedExponent

Integer value specifying the fixed exponent (E)partoftheslope,

, of the argument. The default is -15.

3-61

Page 92

createAndAddImplementationArg

You can optionally specify either the Slope parameter or a combination of this parameter and the parameter, but do not specify both.

Bias

Floating-point value specifying the bias of the argument, for example,

FractionLength

Integer value specifying the fraction length of the argument, for example,

Value

Constant value specifying the initial value of the argument. The default is 0.

Use this parameter only to set the value of injected constant input arguments, such as arguments that pass fraction-length values or flag values, in an implementation function signature. Do not use it for standard generated input arguments such as and so on. You can place a constant input argument that uses this parameter at any position in the implementation function signature except as the return argument.

2.0.Thedefaultis0.0.

3.Thedefaultis15.

SlopeAdjustmentFactor

u1, u2,

You can inject constant input arguments into the implementation signature for any TFL table entry, but if the argument values or the number of arguments required depends on compile-time information, you should use custom matching. For more information, see “Refining TFL Matching and Replacement Using Custom TFL Table Entries” in the Real-Time Workshop Embedded Coder documentation.

Returns Handle to the created implementation argument. Specifying the return

argument in the optional.

3-62

createAndAddImplementationArg function call is

Page 93

createAndAddImplementationArg

Description The createAndAddImplementationArg function creates an

implementation argument from specified properties and adds the argument to the implementation arguments for a TFL table entry.

Note Implementation arguments must describe fundamental numeric data types, such as

uint16, uint8,orboolean (not fixed point data types).

Example In the following example, thecreateAndAddImplementationArg

function is used along with the createAndSetCImplementationReturn function to specify the output and input arguments for an operator implementation.

op_entry = RTW.TflCOperationEntry;

createAndSetCImplementationReturn(op_entry, 'RTW.TflArgNumeric', ...

double, single, int32, int16, int8, uint32,

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'IsSigned', true, ...

'WordLength', 32, ...

'FractionLength', 0);

createAndAddImplementationArg(op_entry, 'RTW.TflArgNumeric',...

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT',...

'IsSigned', true,...

'WordLength', 32, ...

'FractionLength', 0 );

createAndAddImplementationArg(op_entry, 'RTW.TflArgNumeric',...

'Name', 'u2', ...

'IOType', 'RTW_IO_INPUT',...

'IsSigned', true,...

3-63

Page 94

createAndAddImplementationArg

'WordLength', 32, ...

'FractionLength', 0 );

The following examples show some common type specifications using

createAndAddImplementationArg.

% uint8:

createAndAddImplementationArg(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT', ...

'IsSigned', false, ...

'WordLength', 8, ...

'FractionLength', 0 );

% single:

createAndAddImplementationArg(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT', ...

'DataTypeMode', 'single' );

% double:

createAndAddImplementationArg(hEntry, 'RTW.TflArgNumeric', ...

% boolean:

createAndAddImplementationArg(hEntry, 'RTW.TflArgNumeric', ...

See Also createAndSetCImplementationReturn

“Creating Function Replacement Tables” in the Real-Time Workshop Embedded Coder documentation

3-64

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT', ...

'DataTypeMode', 'double' );

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT', ...

'DataTypeMode', 'boolean' );

Page 95

createAndAddImplementationArg

“Replacing Math Functions and Operators Using Target Function Libraries” in the Real-Time Workshop Embedded Coder documentation

3-65

Page 96

createAndSetCImplementationReturn

Purpose Create implementation return argument from specified properties and

add to implementation for TFL table entry

Syntax arg = createAndSetCImplementationReturn(hEntry, ar gTyp e,

varargin)

Arguments hEntry

Handle to a TFL table entry previously returned by instantiating a TF L entry class, such as

hEntry = RTW.TflCOperationEntry.

argType

String specifying the argument type to create:

'RTW.TflArgNumeric' for numeric.

varargin

Parameter/value pairs for the implementation return argument. See varargin Parameters.

hEntry = RTW.TflCFunctionEntry or

varargin Parameters

3-66

The following argument properties can be specified to the

createAndSetCImplementationReturn function using parameter/value

argument pairs. For example,

createAndSetCImplementationReturn(..., 'DataTypeMode', 'double', ...);

Name

String specifying the argument name, for example, 'y1'.

IOType

String specifying the I/O type of the argument: 'RTW_IO_OUTPUT' for output.

IsSigned

Boolean value that, when set to true, indicates that the argument is signed. The default is

WordLength

Integer specifying the word length, in bits, of the argument. The default is

16.

true.

Page 97

createAndSetCImplementationReturn

DataTypeMode

String specifying the d ata type mode of the argument: 'boolean',

'double', 'single', 'Fixed-point: binary point scaling',

'Fixed-point: slope and bias scaling'. The default is

'Fixed-point: binary point scaling'.

Note You can specify either DataType (with Scaling)or

DataTypeMode, but do not specify both.

DataType

String specifying the data type of the argument: 'boolean',

'double', 'single',or'Fixed'. The default is 'Fixed'.

Scaling

String specifying the data type scaling of the argument:

'BinaryPoint' for binary-point scaling or 'SlopeBias' for slope

and bias scaling. The default is

'BinaryPoint'.

Slope

Floating-point value specifying the slope for a fixed-point argument, for example,

15.0. The default is 1.

You can optionally specify either this parameter or a combinatio n of the

SlopeAdjustmentFactor and FixedExponent parameters,

but do not specify both.

SlopeAdjustmentFactor

Floating-point value specifying the slope adjustment factor (F) part of the slope,

You can optionally specify either the combination of this parameter and the

, of the argument. The default is 1.0.

Slope parameter or a

FixedExponent parameter,

but do not specify both.

FixedExponent

Integer value specifying the fixed exponent (E)partoftheslope,

, of the argument. The default is -15.

3-67

Page 98

createAndSetCImplementationReturn

You can optionally specify either the Slope parameter or a combination of this parameter and the parameter, but do not specify both.

Bias

Floating-point value specifying the bias of the argument, for example,

FractionLength

2.0.Thedefaultis0.0.

Integer value specifying the fraction length of the argument, for example,

3.Thedefaultis15.

Returns Handle to the created implementation return argument. Specifying

the return argument in the function call is optional.

createAndSetCImplementationReturn

Description The createAndSetCImplementationReturn function creates an

implementation return argument from specified properties and adds the argument to the implementation for a TFL table.

SlopeAdjustmentFactor

Note Implementation return arg uments must describe fundamental numeric data types, such as

uint32, uint16, uint8,orboolean (not fixed point data types).

double, single, int32, int16, int8,

Example In the following example, the createAndSetCImplementationReturn

function is used along with the createAndAddImplementationArg function to specify the output and input arguments for an operator implementation.

op_entry = RTW.TflCOperationEntry;

createAndSetCImplementationReturn(op_entry, 'RTW.TflArgNumeric', ...

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

3-68

Page 99

createAndSetCImplementationReturn

'IsSigned', true, ...

'WordLength', 32, ...

'FractionLength', 0);

createAndAddImplementationArg(op_entry, 'RTW.TflArgNumeric',...

'Name', 'u1', ...

'IOType', 'RTW_IO_INPUT',...

'IsSigned', true,...

'WordLength', 32, ...

'FractionLength', 0 );

createAndAddImplementationArg(op_entry, 'RTW.TflArgNumeric',...

'Name', 'u2', ...

'IOType', 'RTW_IO_INPUT',...

'IsSigned', true,...

'WordLength', 32, ...

'FractionLength', 0 );

The following examples show some common type specifications using

createAndSetCImplementationReturn.

% uint8:

createAndSetCImplementationReturn(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'IsSigned', false, ...

'WordLength', 8, ...

'FractionLength', 0 );

% single:

createAndSetCImplementationReturn(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'DataTypeMode', 'single' );

% double:

createAndSetCImplementationReturn(hEntry, 'RTW.TflArgNumeric', ...

3-69

Page 100

createAndSetCImplementationReturn

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'DataTypeMode', 'double' );

% boolean:

createAndSetCImplementationReturn(hEntry, 'RTW.TflArgNumeric', ...

'Name', 'y1', ...

'IOType', 'RTW_IO_OUTPUT', ...

'DataTypeMode', 'boolean' );

Mathworks REAL-TIME WORKSHOP EMBEDDED CODER 5 Reference

Specifications and Main Features

Frequently Asked Questions

User Manual

Function Reference

AUTOSAR

AUTOSAR Component Import

AUTOSAR Configuration

C++ Encapsulation Interface Control

Code Generation Objectives Customization

Code Generation Verification

Function Prototype Control

Model Entry Points

Processor-in-the-Loop

Connectivity Configuration

Host-Side Communications

Target-Side Communications

System Target File Callback Interface

Target Function Library Table Creation

Class Reference

AUTOSAR

AUTOSAR Component Import

AUTOSAR Configuration

C++ Encapsulation Interface Control

Code Generation Objectives Customization

Code Generation Verification

Function Prototype Control

Alphabetical List