-
Matlab/Simulink/Stateflow
控制算法建模规
范
3.0
版
Mathworks
汽车咨询委员会
(
MAAB
)
1
修订历史
日期
修订
2001.02.04
初始版本
p>
1.0
版发布
2007.04.27
更新版本
p>
2.0
版发布
2011.07.30
更新版本
p>
3.0
版发布
2012.08.31
更新版本
p>
4.0
版发布
2
介绍
2.1
动机
MAAB
建模规范无论是在组织内部还是在与合作伙伴和分包商
合作时
都是项目成功与团队协作的重要基础。
遵守建模规范是实现以下目标的
重要前提:
无问题的系统集成
明确定义的界面
统一的模型外观、编码及文件编制
可重用模型
可读的模型
无问题的模型交换
简单高效的过程
专业的文件编制
清晰易懂的展示
快速的软件变更
与分包商的合作
将研究或重建项目移交给产品开发
2.2
对
3
.0
版的批注
本规范的现行版本
p>
3.0
版支持
MATLAB
算法,
包括其
R2007b
至
R2011b
版。
3.0
版参考了《美国国家航空航天局猎户座指南》中的部分规则。参
考的规则均在
“参见”部分中标明了该规则在《美国国家航空航天局猎户
座指南》中的编号。
2.3
规范模板
规范描述采用下列模板出具
。建议想要附加其他规范的公司也采用下
列模板进行添加。
ID
:标题
XX_nnnn:
规范的标题
(
p>
须唯一且简短
)
优先级
强制要求
/
强烈建议
/
建议之一
适用范围
MAAB,
NA-MAAB,
J-MAAB
,特定公司
(
本地公司可选使
用
)
MATLAB
版本
全部
RX, RY, RZ
RX
及其之前的版本
RX
及其之后的版本
< br>RX
至
RY
的版本
前提
到规范的链接,这
是本规范的前提(
ID+
标题)
描述
对规范的描述(文本,图像)
理由
制定规范的动机
最终更改
最终更改版本编号
注:本模板的各项
元素是为使规范得到合理的理解与交流所必须提供
的最小项。允许对本模板的项目或卖主
部分进行补充,只要补充的部分不
与原有部分在意义上重合即可。事实上,如果上述补充
能有助于整合其他
规范模板并促使核心模板本身达到更广泛的接收度,这样的补充是受到
鼓
励的。
2.3.1
规范
ID
规范的
ID
由两个小写字母(表示规则
的出处)和四位数字组成,
中间用一段下划线隔开。
一旦一份新规范有了
ID
,该
ID
将不再改变。
ID
用来指代相应的规范。
以“
na
”
、
“
jp
”<
/p>
、
“
jc
”
p>
、
“
eu
”开头的
ID
预留给未来的
MAAB
规范
使用。
保留以“
db
”
、
p>
“
jm
”
、
“
hd
”
、
“
ar
”开头的
ID<
/p>
。
新规则的
ID
不得以上述字母开头。
2.3.2
规范标题
规范的标题应对该规范的应用领域进行简短且唯一的描述
(例如,
名字的长度)
。
规范的标题适用于前提条件部分及定制检测工具。
规范的标题应与到该规范的超链接同时写出。
注:标题不应为对规范内容的多余的简要描述。对规范内容的描述未
来可能发生
改变,但规范的标题始终不得更改。
2.3.3
优先级
每条规范都须根据下列优先顺序进行评级:
强制要求
强烈建议
建议
优先级描述该规范的重要程度并
决定违反该规范的后果严重程度:
强制要求
强烈建议
建议
定义
所有公司一致
认定为绝对必
不可少的规范
所<
/p>
有
公
司
都
被
一
致
认
定
为
良
好做法,但遗留模
型
阻
碍
p>
了
公
司
对
该规范
100%
的遵
守
为改进模型图
的外观建议遵
守的规范,
但该
规范
对于模型
的运行并非起
决定作用
p>
100%
遵
守
的<
/p>
规
范
模
型
须
以
可
能
的
最
大
程
度
遵
守
该
规范,但并未要求
对其
100%
的遵守
如果遵守会更
好,
但并非必要
的规范
后果
如果违反了该规范
必
要
的
项
目
出
现
缺
失
质量和外观劣
化
可能对可维修
外
观
可
能
与
其
他
项
目不
一致
模
型
无
法
正常工作
性、可携带型
及可重用性产
生不利影响
豁免政策
如果有意地忽略该规范
原因须备有文
件证明
2.3.4
适用范围
适用范围可以是以下三者之一:
MAAB (MathWorks
汽车咨询委员会
)
J-MAAB
(
日本
MAAB)
NA-MAAB
(
北美
MAAB)
< br>“
MAAB
”是一个与
Math
sWorks
紧密合作的汽车制造商及供应商的团
队。
MAAB
包括两个子团队,即日本
MAAB
p>
及北美
MAAB
。
“
J-MAAB
”是
< br>MAAB
的子团队,包括与
MathsWorks
紧密合作的日本汽
车制造商及供应商。
J-M
AAB
规则的适用范围为日本当地。
“
NA-
MAAB
”
是
MAAB
的子团队,包括与
MathsWorks
紧密合作的美国
及欧洲的汽车制造商及供应商。该规则是美国及欧洲当地的
规则。覆盖范
围为美国和欧洲。
2.3.5
MATLAB
版本
< br>本规范适用于
MATLAB
及
S
imulink
所有版本的产品。如果一条规则仅
适用于
MATLAB
的某一个或某几个版本,则适用版本的信息应在
MATLAB
版
本部分进行说明,说明格式为下
列格式中的一种:
全部:
MATLAB
的所有版本
RX, RY, RZ
:
MATLAB
的某一特定版本
RX
及其之前的版本:
RX
发布之前的
MATLAB
版本
RX
及其之后的版本:
RX
发布之后直至现行版本发布期间的<
/p>
MATLAB
版本
RX
至
RY
的版本
: RX
至
RY
之间的
MATLAB
版本
p>
2.3.6
前提
该部
分是到其他规范的链接,链接的规范均为本规范的前提(逻
辑关联)
。
每个链接须注明相应规范的
ID
(为了一致性)和标题(为了可读
性)
。
“前提”部分不应包括任何其他文本。
< br>
2.3.7
描述
该部分包括对规范的详细描述。
如有需要,可添加图像和表格。
注:
如果正式表达(数学符号、正规表达式、语法图及精确数值
/
范
围)可用,应使用正式表达对规范进行清楚明白的描述并指定一项自
动检测。此外,为了日常参考,还须提供一份人性化的、可理解的、
非正式的描述。
2.3.8
理由
规范的建议可出于以下一种或多种原因:
可读性:易于理解的算法
可读的模型
统一的模型外观、编码及文件编制
清洁的界面
专业的文件编制
工作流:高效的发展进程及工作流
易于维护
迅速的改型设计
可重复使用的部件
无问题的模型交换
模型可携带型
模拟:高效的模拟与分析
模拟速率
模拟内存
模型检测
验证
&
确认:有能力对模型及生成的代码就下列因素进行验证和
确认:
需求的可追溯性
测试
无问题的系统集成
清洁的界面
代码生成:生成对内嵌系统有效的代码
快速的软件变更
生成的代码的稳健性
2.3.9
最终更改
“最终更改部分”包括文件版本编号。
2.4
文件使用
以下段落提供的信息是关于
使用本文件作为参考以及参照本文件编
写具体项目的规范文件的。附件
< br>A
中可以找到关于对本规范进行自动校核
的信息。
2.4.1
规范交互作用语义
本文件的起始段“命名规范与模型架构”提供了适用于各种模型的基
本
规范。其后的
“
Simulink<
/p>
与
Stateflow
”部分提供上述环
境中的具体
规则。某些规范是依赖于其他规范的,模板中自始至终都对其作了明确说
p>
明。
2.4.2
隐匿的子系统及可读性规则
如果用户没有查看模型内部隐匿子系统的内容,则关于可读性的规范
不再适
3
软件环境
3.1
总则
3.1.1
na_0026:
一致的软件环境
ID
:标题
na_0026:
一致的软件环境
优先级
建议
适用范围
北美
MAAB
MATLAB
版本
见“描述”
前提
描述
在软件开发过程中,
建议在整个项目中始终使用一致
的软件开发环境。此处所说的软件包括但不仅限于:
MATLAB
Simulink
C Compiler
(
供模拟
)
C Compiler
(
供目标硬件
)
理由
?
可读性
□工作流
□模拟
□验证
&
确认
?
代码生成
参见
jh_0042
:必需的软件
最终更改
3.00
版
3.1.2
na_0027:
仅有标准库模块的使用
ID
:标题
na_0027:
仅有标准库模块的使用
优先级
建议
适用范围
北美
MAAB
MATLAB
版本
全部
前提
描述
公司在开发模型时应指定
Simulink
的一个子集以供
使用。
模块列表可包括由公司或第三方开发
的自定义
模块库。模型应仅由这些模块构成。
开发过程中可使用非兼容性模块。
如果使用了非兼容
性
模块,须用一种颜色
/
图标和
/
或注释进行标记。这
些非兼容性模块在用于生成生产代码之前必须移除
。
理由
?
可读性
□工作流
?
模拟
?<
/p>
验证
&
确认
?
代码生成
参见
hyl_0201:
只使用标准库模块
最终更改
3.00
版
4
命名规范
4.1
总则
4.1.1ar_0001
:文件名
ID
:标题
ar_0001
:文件名
优先级
强制要求
适用范围
MAAB
MATLAB
版本
全部
前提
描述
文件名应符合以下约束条件:
形式
文件名
=
文件名称
.
扩展
名称
:无前导位数,无空格符号
扩展
:无空格符号
唯一性
□上级项目目录内的所有文件名
□不
得与
C/C++
或
MATLAB
关键词冲突
允许的字符
名称
:
a
b c d e f g h i j k l m n o p q
r s t u
v w x y z A B C D E F G H
I J K L M N O
P Q R S T U V W X Y
Z 0 1 2 3 4 5 6 7 8
9 _
扩展
:
a
b c d e f g h i j k l m n o p q
r s t u
v w x y z A B C D E F G H
I J K L M N O
P Q R S T U V W X Y
Z 0 1 2 3 4 5 6 7 8
9
下划线
名称
:
可使用下划线分离各个部分
不得连续使用一个以上的下划线
不得以下划线开头
不得以下划线结尾
扩展
:
不得使用下划线
理由
?
可读性
?
工作流
?
模拟
□验证
&
确认
?
代码生成
最终更改
3.00
版
4.1.2ar_0002
:目录名
ID
:标题
ar_0002
:目录名
优先级
强制要求
适用范围
MAAB
-
-
-
-
-
-
-
-
-
上一篇:高考英语新题型写作技巧八 强调倒装虚拟语气句型和丰富细节的手段
下一篇:英语趣事