枚举量是Simulink数据字典中的一种对象。本文研究在数据字典中配置枚举量以及生成的代码。

文章目录

1 问题引入
2 在sldd中创建枚举量
3 在m文件中创建枚举量
4 总结

1 问题引入

博主对枚举量的理解是，通过字母而不是数字来清晰地表达某种状态。

举个例子，假如我们有一个灯泡，它有两种状态：“亮”和“灭”。在外接电压为5V的时候，灯泡亮；外接电压为0V的时候，灯泡灭。

化为一个简单的模型的话，模型的输入接口就是电压，输出就是灯泡状态，可以建模如下。
在这里插入图片描述
Inport1是电压值，当电压等于5的时候，输出的是上路的浮点数1；电压不为5时，输出的是下路的浮点数0。这里用数字1和0来标志灯泡是亮还是灭的状态，后面的模型可以根据Switch模块的输出来做进一步的策略。

这样的做法在功能上没有问题，但是数字看起来很不直观，也就是所谓的“魔法数字”。假如状态有十几个，就要用十几个数字来表示，时间长了还能回忆起谁是谁吗？把数字换成字母，也就是枚举量，就可以解决这个问题。

2 在sldd中创建枚举量

2.1 枚举量的创建

1）新建一个模型、一个数据字典文件，并将两者关联。如何建立数据字典可以参考博主另一篇博客《Simulink代码生成：数据字典的建立、关联模型》。
在这里插入图片描述
2）在Model Explorer界面中，选中Design Data–>点击Add–>点击Simulink Enumerated Type

3）将新建的枚举量名字改为BulbStatus，意为表示灯泡状态的枚举量。

4）选中这个枚举量，在右侧的窗口添加两个成员变量On和Off，并将数值设为0，1。
在这里插入图片描述
5）将Default选为Off，表示这个枚举量的默认值是Off；StorageType选为uint8；DataScope选为Auto，最后Apply。

6）最后右键保存数据字典。

7）然后回到模型，把Switch模块上下路的常数值替换成枚举量成员变量。用法是先写上枚举量名称BulbStatus，再加个点，再加上成员变量名称。
在这里插入图片描述
运行一下模型后，在图中可以看到，信号线上的类型变成了枚举量名称，也就是说，枚举量是个类型，枚举成员的背后才是个数值。

2.2 代码生成

Ctrl + B生成下代码看看。
在这里插入图片描述
由上图可以看出，在demo.c中的if条件中，把On或者Off这个枚举量成员赋值给了输出变量。那么这个On和Off又是在哪儿定义的呢？打开demo_types.h文件看看。

首先把BulbStatus这个枚举量定义为了uint8类型，然后再用宏定义定义了枚举成员变量，数值和类型都和数据字典中的配置相对应。

2.3 其他配置

枚举量配置也有一定的操作空间，不只是上文所说的配置。
1）Storage Class可以配置成其他的类型，会影响到typedef那个语句。

2）DataScope改成Exported并加上头文件，可以把枚举量配置在特定的头文件中。
在这里插入图片描述

3）勾选Add Class Name To Enum Names，可以将枚举量名称作为前缀表现在成员变量名字里。这一点比较实用，可以看出成员属于哪个枚举量。

3 在m文件中创建枚举量

3.1 枚举量的创建

1）在当前目录（或者matlab搜索路径中）创建一个类文件BulbStatus.m，粘贴如下枚举量定义的类；

classdef BulbStatus < uint8
   enumeration
     On(0)
     Off(1)
   end
end
1
2
3
4
5
6

这里的classdef后面的类名要和文件名一致，<号后面是类型；

2）不用做任何引入，只要该文件在Matlab的搜索路径中，2.1的模型就可以引用到该处的枚举量定义；

3.2 代码生成

按照3.1中的定义，代码生成和上文一致。

另外，如果将类定义改成如下所示，即类型从uint改成Simulink.IntEnumType，生成的代码就会有所不同。

classdef BulbStatus < Simulink.IntEnumType
   enumeration
     On(0)
     Off(1)
   end
end
1
2
3
4
5
6

Ctrl+B生成代码后，可以看到定义枚举量的方式从宏定义的方式变成了typedef的方式。

在这里插入图片描述

这种方式更符合学校里学到的C语言的枚举量定义习惯。博主没有研究出在sldd中定义枚举量，怎样生成这种typedef的形式，所以如果有需要这种形式的话，可以在m文件中定义。

3.3 其他配置

用m文件的方式定义枚举量也可以定义头文件等配置。例如将类文件改为如下所示；

classdef BulbStatus < Simulink.IntEnumType
    enumeration
        On(0)
        Off(1)
    end
    methods (Static)
        function retVal = getDefaultValue()
            % 定义默认值
            retVal  = BulbStatus.On;
        end        
        function retVal = getDescription()
            % 描述信息
            retVal = '灯泡的状态';
        end        
        function retVal = getHeaderFile()
            % 头文件
            retVal = 'BulbStatusDef.h';
        end        
        function retVal = getDataScope()
            % DataScope
            retVal = 'Exported';
        end        
        function retVal = addClassNameToEnumNames()
            % 将枚举量名称作为前缀表现在成员变量名字里
            retVal = true;
        end
    end
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

methods下的每个函数都对应了在sldd中手动配置的方法，这里就不再生成代码演示。

4 总结

枚举量在建模的过程中十分常用，所以应该熟练地掌握枚举量的创建方法，并对代码了如指掌。

>>返回个人博客总目录

Simulink配置：枚举量配置