getState

Get code configuration from code mappings for block state

Syntax

propertyValue = getState(myCodeMappingObj,block,property)

Description

propertyValue = getState(myCodeMappingObj,block,property) returns the value of a code mapping property for the state of the specified block. Use this function to return the storage class or the value of a storage class property configured for a block state.

Examples

Get Storage Class Configured for Block State

From the model code mappings for model myConfigModel, get the name of the storage class that is configured for state X of Unit Delay block Delay.

cm = coder.mapping.api.get('myConfigModel');
scX = getState(cm,'myConfigModel/Delay','StorageClass');

Get Code Identifier Configured for State of Unit Delay Block

From the model code mappings for model myConfigModel, get the code identifier that is configured for state X of Unit Delay block Delay.

cm = coder.mapping.api.get('myConfigModel');
scX = getState(cm,blockHandle,'Identifier');

Input Arguments

myCodeMappingObj — Code mapping object

CodeMapping object

Code mapping object (model code mappings) returned by a call to function coder.mapping.api.get.

Example: myCM

block — Path or handle of block

character vector | string scalar | block handle

Path of the block for which to return the state code mapping information, specified as a character vector or string scalar. Alternatively, you can specify a block handle.

Example: blockHandle

Data Types: char | string | block_handle

property — Code mapping property value to return

StorageClass | Identifier | | | |

Code mapping property for which to return a value. Specify one of these property names.

Information to Return	Property Name
Name of storage class	StorageClass
Name of variable for state in the generated code	Identifier

Example: 'StorageClass'

Output Arguments

propertyValue — Name of storage class or value of storage class property

character vector

Name of the storage class or value of the specified storage class property configured for the specified block state, returned as a character vector.

Data Types: char