Main Content

getDataDefault

Get default code settings for data category

    Description

    example

    value = getDataDefault(myCoderDictionaryObj, category, property) returns the value from the code mappings of the specified property for the specified data category.

    Examples

    collapse all

    Use the coder.mapping.api.get function to access the CoderDictionary object associated with the data dictionary.

    cm = coder.mapping.api.get('codeDefinitions.sldd');

    To see the storage class of root-level inports for the dictionary, use the getDataDefault function.

    value = getDataDefault(cm, 'Inports', 'StorageClass')
    value =
    
        'Default'

    The dictionary uses the default storage class for inports.

    To configure the storage class, use the setDataDefault function.

    setDataDefault(cm, 'Inports', 'StorageClass', 'ExportedGlobal')

    To verify that the storage class of inports is now set to ExportedGlobal, use the getDataDefault function.

    value = getDataDefault(cm, 'Inports', 'StorageClass')
    value =
    
        'ExportedGlobal'

    Input Arguments

    collapse all

    Coder dictionary object returned by a call to function coder.mapping.api.get.

    Category of data elements to return a property value for.

    Example: 'Inports'

    Code mapping property that you return a value for. Specify one of these property names or a property name for a storage class defined in the Embedded Coder Dictionary .

    Information to ReturnProperty Name
    Name of storage classStorageClass
    Name of variable for data element in the generated codeIdentifier
    Name of source definition file that contains definitions for global data that is read by the data element and external codeDefinitionFile
    Name of get function called by code generated for the data elementGetFunction
    Name of source header file that contains declarations for global data that is read by the model data element and external codeHeaderFile
    Character vector or string scalar that names a memory section for a model defined in the Embedded Coder Dictionary.MemorySection
    Name of model for which the code generator places the definition for data element shared by multiple models in a model hierarchy Owner
    Boolean value indicating whether code generator preserves dimensions of data that is represented as a multidimensional arrayPerserveDimensions
    Name of set function called by code generated for data elementSetFunction
    Name of structure in generated code for data elementStructName

    Example: 'Identifier'

    Output Arguments

    collapse all

    The code mapping property value of the specified category, returned as a character vector.

    Introduced in R2021a