Learn more about Real-Time Workshop Embedded Coder

Configuring Model Function Prototypes Programmatically

You can use the function prototype control functions (listed in Function Prototype Control Functions), to programmatically control model function prototypes. Typical uses of these functions include:

• Create and validate a new function prototype

  1. Create a model-specific C function prototype with obj = RTW.ModelSpecificCPrototype, where obj returns a handle to a newly created, empty function prototype.

  2. Add argument configuration information for your model ports using RTW.ModelSpecificCPrototype.addArgConf.

  3. Attach the function prototype to your loaded ERT-based Simulink model using RTW.ModelSpecificCPrototype.attachToModel.

  4. Validate the function prototype using RTW.ModelSpecificCPrototype.runValidation.

  5. If validation succeeds, save your model and then generate code using the rtwbuild function.

• Modify and validate an existing function prototype

  1. Get the handle to an existing model-specific C function prototype that is attached to your loaded ERT-based Simulink model with obj = RTW.getFunctionSpecification(modelName), where modelName is a string specifying the name of a loaded ERT-based Simulink model, and obj returns a handle to a function prototype attached to the specified model.

     You can use other function prototype control functions on the returned handle only if the test isa(obj,'RTW.ModelSpecificCPrototype') returns 1. If the model does not have a function prototype configuration, the function returns []. If the function returns a handle to an object of type RTW.FcnDefault, you cannot modify the existing function prototype.

  2. Use the Get and Set functions listed in Function Prototype Control Functions to test and reset such items as the function names, argument names, argument positions, argument categories, and argument type qualifiers.

  3. Validate the function prototype using RTW.ModelSpecificCPrototype.runValidation.

  4. If validation succeeds, save your model and then generate code using the rtwbuild function.

• Create and validate a new function prototype, starting with default configuration information from your Simulink model

  1. Create a model-specific C function prototype using obj = RTW.ModelSpecificCPrototype, where obj returns a handle to a newly created, empty function prototype.

  2. Attach the function prototype to your loaded ERT-based Simulink model using RTW.ModelSpecificCPrototype.attachToModel.

  3. Get default configuration information from your model using RTW.ModelSpecificCPrototype.getDefaultConf.

  4. Use the Get and Set functions listed in Function Prototype Control Functions to test and reset such items as the function names, argument names, argument positions, argument categories, and argument type qualifiers.

  5. Validate the function prototype using RTW.ModelSpecificCPrototype.runValidation.

  6. If validation succeeds, save your model and then generate code using the rtwbuild function.

Note   You should not use the same model-specific C function prototype object across multiple models. If you do, changes that you make to the step and initialization function prototypes in one model are propagated to other models, which is usually not desirable.

Function Prototype Control Functions

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

Model Function Prototypes Example

Sample M-Script for Configuring Model Function Prototypes

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