Real-Time Workshop

Symbolic Names for Block States

To determine the variable or field name generated for a block's state, you can either:

• Use a default name generated by Real-Time Workshop.

or

• Define a symbolic name via the State Name field of the State Properties dialog box.

Default Block State Naming Convention

If you do not define a symbolic name for a block state, Real-Time Workshop uses the following default naming convention:

• BlockType#_DSTATE
  

where

• BlockType is the name of the block type (e.g., Discrete_Filter).
• # is a unique ID number (#) assigned by Real-Time Workshop if multiple instances of the same block type appear in the model. The ID number is appended to BlockType.
• _DSTATE is a string that is always appended to the block type and ID number.

For example, consider the model shown in Figure 5-15.

Figure 5-15: Model with Two Discrete Filter Block States

We will examine code generated for the states of the two Discrete Filter blocks. Assume that:

• Neither block's state has a user-defined name.
• The upper Discrete Filter block has Auto storage class (and is therefore stored in the DWork vector).
• The lower Discrete Filter block has ExportedGlobal storage class.

The initialization code for the states of the two Discrete Filter blocks would be as shown in the following code fragment.

• /* DiscreteFilter Block: <Root>/Discrete Filter */
  rtDWork.Discrete_Filter_DSTATE = 0.0;
  
  /* DiscreteFilter Block: <Root>/Discrete Filter1 */
  Discrete_Filter1_DSTATE = 0.0;
  

User-Defined Block State Names

Using the State Properties dialog box, you can define your own symbolic name for a block state. To do this:

1. Select the desired block. Then select State properties from the Edit menu of your model. This opens the State Properties dialog box.

1. Alternatively, you can right-click on the block, and select State properties from the pull-down menu.

2. Enter the symbolic name into the State name field of the State Properties dialog box. In this picture, the state name Top_filter is entered.

3. Click Apply and close the dialog box.

The following state initialization code was generated from the example model shown in Figure 5-7, under the following conditions:

• The upper Discrete Filter block has the state name Top_filter, and Auto storage class (and is therefore stored in the DWork vector.)
• The lower Discrete Filter block has the state name Lower_filter, and ExportedGlobal storage class.

• /* DiscreteFilter Block: <Root>/Discrete Filter */
    rtDWork.Top_filter = 0.0;
  
    /* DiscreteFilter Block: <Root>/Discrete Filter1 */
    Lower_filter = 0.0;
  

Using the State Properties Dialog Box to Interface States to External Code

Block States and Simulink Signal Objects