getDictionaryDefault
Class: coder.Dictionary
Namespace: coder
Return default service for service interface section or default property value for data interface category
Since R2023b
Syntax
Description
returns the default entry of the service interface section
defaultEntry
= getDictionaryDefault(serviceDict
,sectionName
)sectionName
in the service interfaces coder dictionary
serviceDict
.
returns the default value of the property defaultPropVal
= getDictionaryDefault(dataDict
,categoryName
,propName
)propName
of the category
categoryName
in the data interfaces coder dictionary
dataDict
.
Input Arguments
serviceDict
— Embedded Coder Dictionary with service interfaces configuration
coder.Dictionary
object
Embedded Coder® Dictionary that contains a service interface configuration, specified as a
coder.Dictionary
object.
sectionName
— Service interface section name
"DataReceiverInterfaces"
| "DataSenderInterfaces"
| ...
Service interface section name, specified as a string scalar or character vector that corresponds to a section of the service interface definitions in the dictionary. Sections include:
"DataReceiverInterfaces"
"DataSenderInterfaces"
"DataTransferInterfaces"
"InitTermFunctions"
"MeasurementInterfaces"
"ParameterArgumentTuningInterfaces"
"ParameterTuningInterfaces"
"PeriodicAperiodicFunctions"
"SharedUtilityFunctions"
"SubcomponentInitTermFunctions"
"SubcomponentPeriodicAperiodicFunctions"
"TimerInterfaces"
dataDict
— Embedded Coder Dictionary with data interfaces configuration
coder.Dictionary
object
Embedded Coder Dictionary that contains a data interface configuration, specified as a
coder.Dictionary
object.
categoryName
— Data interface category name
"InitializeTerminate"
| "Execution"
| "SharedUtility"
| "Inports"
| "Outports"
| ...
Data interface category name, specified as a string scalar or character vector that
corresponds to a category in one of the category groups in the dictionary,
Function Defaults
and Data Defaults
.
Function Defaults
categories are:
"InitializeTerminate"
"Execution"
"SharedUtility"
Data Defaults
categories are:
"Inports"
"Outports"
"ModelParameters"
"ModelParameterArguments"
"ExternalParameters"
"SharedLocalDataStores"
"GlobalDataStores"
"InternalData"
"Constants"
propName
— Name of category property
"FunctionCustomizationTemplate"
| "StorageClass"
Name of category property for which to retrieve the dictionary default value, specified as a string scalar or character vector. The list of available properties to use with this method depends on the category type and its specific configuration.
For categories within Function Defaults
, the
FunctionCustomizationTemplate
property is available for use with
this method. When the FunctionCustomizationTemplate
is set to
Default
, an additional property, MemorySection
,
becomes available for use with this method for these categories.
Data Defaults
categories have the StorageClass
property available for use with this method. The set of available properties is dynamic
and varies based on the assigned value of the StorageClass
property.
For example, when the StorageClass
property is assigned the value
ExportToFile
, which is allowed for certain categories, these
additional properties become available for use with this method:
"HeaderFile"
"DefinitionFile"
"Owner"
"PreserveDimensions"
To learn more about storage classes and their properties, see Choose Storage Class for Controlling Data Representation in Generated Code.
Output Arguments
defaultEntry
— Default entry
coder.dictionary.Entry
object
Default entry for the specified service interface section, returned as a
coder.dictionary.Entry
object.
defaultPropVal
— Default property value
character vector
Default property value, returned as a character vector.
Examples
Determine Default Entry for Measurement Interfaces
Create a Simulink data dictionary that contains an Embedded Coder Dictionary. Create the Embedded Coder Dictionary so that it represents a service interface configuration.
dictionaryFile = Simulink.data.dictionary.create("codeDefinitions.sldd"); codeDictionary = coder.dictionary.create("codeDefinitions.sldd","ServiceInterface");
Get the default measurement interface entry.
meas = getDictionaryDefault(codeDictionary,"MeasurementInterfaces")
meas = Entry with properties: Name: 'MeasurementExample1' DataSource: 'C:\work\serviceDefinitions.sldd' StorageClass: 'MeasurementStruct'
For this example, the default measurement interface is
MeasurementExample1
.
Get and Set Default Outports Properties in Data Interface Coder Dictionary
Create a Simulink data dictionary, then create the Embedded Coder Dictionary to represent a data interface configuration.
dictFileName = "dataDict.sldd"; dataDict = Simulink.data.dictionary.create(dictFileName); coderDataDict = coder.dictionary.create(dataDict,"DataInterface");
Use the getDictionaryDefault
method to see the default StorageClass
of the Outports
category.
getDictionaryDefault(coderDataDict,"Outports","StorageClass")
ans = 'Default'
Set the default StorageClass
of the Outports
category to GetSet
. Then specify GetFunction
(the naming rule of the get function) as get_outports_$N
and specify SetFunction
(the naming rule of the set function) as set_outports_$N
.
setDictionaryDefault(coderDataDict,"Outports","StorageClass","GetSet") setDictionaryDefault(coderDataDict,"Outports","GetFunction","get_outports_$N") setDictionaryDefault(coderDataDict,"Outports","SetFunction","set_outports_$N")
Discard and close the dictionary, then delete the dictionary file. This allows you to run this example more than once without getting an error while attempting to create the dictionary.
discardChanges(dataDict)
Simulink.data.dictionary.closeAll("-save")
delete(dictFileName)
Version History
Introduced in R2023bR2024a: Changes in service interfaces dictionary sections
The dictionary sections SubcomponentInitTermFunctions
and
SubcomponentPeriodicAperiodicFunctions
replace the section
SubcomponentEntryFunctions
.
See Also
MATLAB 命令
您点击的链接对应于以下 MATLAB 命令:
请在 MATLAB 命令行窗口中直接输入以执行命令。Web 浏览器不支持 MATLAB 命令。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)