Main Content

getOutport

Get code and calibration configuration from code mappings for root-level outport

    Description

    example

    propertyValue = getOutport(myCodeMappingObj,outportBlock,property) 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

    collapse all

    From the model code mappings for model rtwdemo_configrpinterface, get the name of the storage class that is configured for root-level outport Out1.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    scOut1 = getOutport(cm,'Out1','StorageClass');
    

    From the model code mappings for model rtwdemo_configrpinterface, get the code identifier configured for root-level outport Out1.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    idOut1 = getOutport(cm,'Out1','Identifier');
    

    From the model code mappings for model rtwdemo_configrpinterface, get the calibration properties such as calibration access and display identifier configured for root-level outport Out1.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    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

    collapse all

    Code mapping object (model code mappings) returned by a call to function coder.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 ReturnProperty Name
    Name of storage classStorageClass
    Name of variable for root-level outport in the generated codeIdentifier
    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 toolBitMask
    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 propertyCalibrationAccess
    Name of the conversion method used during the calibrationCompuMethod
    Optional display name of the outport for calibrationDisplayIdentifier
    Specifies the display format of the outport being measured in a calibration toolFormat

    Example: 'StorageClass'

    Example: 'CalibrationAccess'

    Output Arguments

    collapse all

    Name or value of the property configured for the specified root-level outport.

    Data Types: char | logical

    Introduced in R2020b