Main Content

getInport

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

    Description

    example

    propertyValue = getInport(myCodeMappingObj,inportBlock,property) returns the value of a code mapping property or calibration property for the specified root-level Inport block. For example, use this function to return the storage class or the value of a storage class property configured for a root-level inport in a model, or to return the calibration access of the inport.

    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 inport In1.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    scIn1 = getInport(cm,'In1','StorageClass');
    

    From the model code mappings for model rtwdemo_configrpinterface, get the code identifier configured for root-level inport In1.

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

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    prop_export = getInport(cm,'In1','Export');
    prop_bitmask = getInport(cm,'In1','BitMask');
    prop_calaccess = getInport(cm,'In1','CalibrationAccess');
    prop_compname = getInport(cm,'In1','CompuMethod');
    prop_dispid = getInport(cm,'In1','DisplayIdentifier');
    prop_format = getInport(cm,'In1','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 inport for which to return the code mapping information.

    Example: 'In1'

    Data Types: char | string | block_handle

    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 inport in the generated codeIdentifier
    Name of source definition file that contains definitions for global data that is read by the inport and external codeDefinitionFile
    Name of get function called by code generated for the inport GetFunction
    Name of source header file that contains declarations for global data that is read by the inport and external codeHeaderFile
    Name of model for which the code generator places the definition for an inport shared by multiple models in a model hierarchy Owner
    Boolean value indicating whether the code generator preserves dimensions of an inport that is represented as a multidimensional arrayPreserveDimensions
    Name of set function called by code generated for an inportSetFunction
    Name of structure in generated code for an inport StructName
    Boolean value indicating whether to export the selected inport to a calibration file (a2l)Export
    Mask value in hexadecimal format to extract single bits from the inport in a calibration toolBitMask
    Enumeration value indicating the access of calibration. Calibration for an inport indicates that the inport can be calibrated. NoCalibration indicates that the inport 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 inport for calibrationDisplayIdentifier
    Specifies the display format of the inport 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 inport.

    Data Types: char | logical

    Introduced in R2020b