getOutport - Get code and calibration configuration from code mappings for root-level
outport - MATLAB ([original](https://in.mathworks.com/help/ecoder/ref/getoutport.html)) ([raw](?raw))
Get code and calibration configuration from code mappings for root-level outport
Since R2020b
Syntax
Description
[propertyValue](#mw%5F57a096ac-d2e1-445f-8018-3086fe8b4d9c) = getOutport([myCodeMappingObj](#mw%5F63903b00-a386-4d2b-be89-03d1b350e582),[outportBlock](#mw%5F348e78f4-8571-4761-b437-ee9fd2d26fad),[property](#mw%5Fad1bc288-951c-4603-a78f-ca4dbc610610))
returns the value of a code mapping property or calibration property for the specified root-level Outport block. For example, use this function to return the storage class or the value of a storage class property configured for a root-level outport in a model, or to return the calibration access of the outport.
Examples
From the model code mappings for modelConfigurationRapidPrototypingInterface
, get the name of the storage class that is configured for root-level outport Out1
.
openExample("ConfigurationRapidPrototypingInterface"); cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface"); scOut1 = getOutport(cm,"Out1","StorageClass");
From the model code mappings for modelConfigurationRapidPrototypingInterface
, get the code identifier configured for root-level outport Out1
.
openExample("ConfigurationRapidPrototypingInterface"); cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface"); idOut1 = getOutport(cm,"Out1","Identifier");
From the model code mappings for modelConfigurationRapidPrototypingInterface
, get the calibration properties such as calibration access and display identifier configured for root-level outport Out1
.
openExample("ConfigurationRapidPrototypingInterface"); cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface"); prop_export = getOutport(cm,"Out1","Export"); prop_bitmask = getOutport(cm,"Out1","BitMask"); prop_calaccess = getOutport(cm,"Out1","CalibrationAccess"); prop_compname = getOutport(cm,"Out1","CompuMethod"); prop_dispid = getOutport(cm,"Out1","DisplayIdentifier"); prop_format = getOutport(cm,"Out1","Format");
Input Arguments
Code mapping object (model code mappings) returned by a call to functioncoder.mapping.api.get
.
Example: myCM
Name, path, or handle of the root-level outport for which to return the code mapping information.
Example: "Out1"
Data Types: char
| string
Code mapping property for which to return a value. For a storage class defined in the Embedded Coder Dictionary associated with the model, specify a property name or one of these property names.
Information to Return | Property Name |
---|---|
Name of storage class | StorageClass |
Name of variable for root-level outport in the generated code | Identifier |
Name of source definition file that contains definitions for global data that is read by the root-level outport and external code | DefinitionFile |
Name of get function called by code generated for the root-level outport | GetFunction |
Name of source header file that contains declarations for global data that is read by the root-level outport and external code | HeaderFile |
Name of model for which the code generator places the definition for root-level outport shared by multiple models in a model hierarchy | Owner |
Boolean value indicating whether the code generator preserves dimensions of a root-level outport that is represented as a multidimensional array | PerserveDimensions |
Name of set function called by code generated for root-level outport | SetFunction |
Name of structure in generated code for root-level outport | StructName |
Boolean value indicating whether to export the selected outport to a calibration file (a2l) | Export |
Mask value in hexadecimal format to extract single bits from the outport in a calibration tool | BitMask |
Enumeration value indicating the access of calibration.Calibration for an outport indicates that the outport can be calibrated. NoCalibration indicates that the outport can be read-only but cannot be calibrated. NoCalibration is the default value for the property | CalibrationAccess |
Name of the conversion method used during the calibration | CompuMethod |
Optional display name of the outport for calibration | DisplayIdentifier |
Specifies the display format of the outport being measured in a calibration tool | Format |
Name of sender service defined in Embedded Coder Dictionary | SenderService |
Example: "StorageClass"
Example: "CalibrationAccess"
Output Arguments
Name or value of the property configured for the specified root-level outport.
Data Types: char
| logical
Version History
Introduced in R2020b