MaabSimulinkSteflow控制算法建模规范中文

1、Matlab/Simulink/Stateflow控制算法建模规范 3.0版 Mathworks汽车咨询委员会 （MAAB） 修订历史1 日期 MAAB, NA-MAAB, J-MAAB，特定公司适用范围 (本地公司可选使 )用 版本MATLAB全部 RX, RY, RZ 描述 修订 对规范的描述（文本，图像） 定义 2001.02.04 理由 所有公司一致 版发布1.0初始版本 制定规范的动机 被一致认定为良 为改进模型图 2007.04.27 最终更改认定为绝对必不可少的规范 版发布更新版本2.0 最终更改版本编号的外观建议遵好做法，但遗留模守的规范，司对但该阻型碍了公 2011.07.3

2、0 ID：标题有 所 版发布3.0更新版本 )(须唯一且简短XX_nnnn: 规范的标题规范对于模型的遵该规范100%都公司的运行并非起守 2012.08.31 优先级100%范 版发布4.0更新版本 建议之一/强制要求/强烈建议遵守的规决定作用 模型须以可能的最大程度遵守该 如果遵守会更 介绍2 动机 2.1建模规范无论是在组织内部还是在与合作伙伴和分包商合作时MAAB遵守建模规范是实现以下目标的都是项目成功与团队协作的重要基础。 重要前提： 无问题的系统集成 明确定义的界面 统一的模型外观、编码及文件编制 可重用模型 可读的模型 无问题的模型交换 简单高效的过程 专业的文件编制 清晰易懂的

3、展示 快速的软件变更 与分包商的合作 将研究或重建项目移交给产品开发 版的批注 2.2对3.0R2011b至算法，包括其R2007bMATLAB本规范的现行版本3.0版支持版参考了美国国家航空航天局猎户座指南中的部分规则。参3.0版。考的规则均在“参见”部分中标明了该规则在美国国家航空航天局猎户 座指南中的编号。 规范模板2.3 规范描述采用下列模板出具。建议想要附加其他规范的公司也采用下 列模板进行添加。 RX及其之前的版本 及其之后的版本RX 的版本RYRX至 标题）到规范的链接，这是本规范的前提（ID+前提注：本模板的各项元素是为使规范得到合理的理解与交流所必须提供的最小项。允许对本模板

4、的项目或卖主部分进行补充，只要补充的部分不与原有部分在意义上重合即可。事实上，如果上述补充能有助于整合其他规范模板并促使核心模板本身达到更广泛的接收度，这样的补充是受到鼓 励的。 ID规范2.3.1 规范的ID由两个小写字母（表示规则的出处）和四位数字组成， 中间用一段下划线隔开。 将不再改变。，该ID 一旦一份新规范有了ID 用来指代相应的规范。 ID规范MAAB”开头的、“jc”、“euID预留给未来的” 以“na、“jp 使用。 。ID“ar”开头的、 保留以“db”“jm”“hd” 不得以上述字母开头。ID 新规则的 规范标题2.3.2 （例如， 规范的标题应对该规范的应用领域进行简短

5、且唯一的描述 。名字的长度） 规范的标题适用于前提条件部分及定制检测工具。 规范的标题应与到该规范的超链接同时写出。 注：标题不应为对规范内容的多余的简要描述。对规范内容的描述未 来可能发生改变，但规范的标题始终不得更改。 优先级2.3.3 每条规范都须根据下列优先顺序进行评级： 强制要求 强烈建议 建议 优先级描述该规范的重要程度并决定违反该规范的后果严重程度： 建议强制要求强烈建议 好，但并非必要规范，但并未要求的规范的遵守100%对其 后果 如果违反了该规范项 必要的目出现缺失 法模型无 正常工作 ：标题na_0026:ID 建议优先级MATLAB 质量和外观劣化 可能对可维修 性、可携

6、带型及可重用性产生不利影响 一致的软件环境 能观可 外项其他与目不一致 MAAB北美适用范围 见“描述”版本 前提 豁免政策如果有意地忽略该规范 原因须备有文件证明 适用范围 2.3.4 适用范围可以是以下三者之一： )MAAB (MathWorks汽车咨询委员会 MAAB) 日本J-MAAB ( MAAB)NA-MAAB (北美紧密合作的汽车制造商及供应商的团MathsWorks”是一个与MAAB“ 。MAABMAAB队。MAAB包括两个子团队，即日本及北美紧密合作的日本汽MathsWorks的子团队，包括与”是“J-MAABMAAB 规则的适用范围为日本当地。J-MAAB车制造商及供应商。

7、紧密合作的美国MathsWorks 是MAAB的子团队，包括与”“NA-MAAB及欧洲的汽车制造商及供应商。该规则是美国及欧洲当地的规则。覆盖范 围为美国和欧洲。 版本2.3.5 MATLAB所有版本的产品。如果一条规则仅及Simulink本规范适用于MATLABMATLAB版的某一个或某几个版本，则适用版本的信息应在适用于MATLAB 本部分进行说明，说明格式为下列格式中的一种： 的所有版本MATLAB 全部： 的某一特定版本MATLABRX, RY, RZ： 版本发布之前的MATLAB RX及其之前的版本：RX RX 及其之后的版本：RX发布之后直至现行版本发布期间的MATLAB 版本 版

8、本之间的MATLABRY: RXRYRX 至的版本至 前提 2.3.6 该部分是到其他规范的链接，链接的规范均为本规范的前提（逻 。辑关联）（为了一致性）和标题（为了可读每个链接须注明相应规范的ID “前提”部分不应包括任何其他文本。性）。 描述2.3.7 该部分包括对规范的详细描述。 如有需要，可添加图像和表格。 范注：如果正式表达（数学符号、正规表达式、语法图及精确数值/围）可用，应使用正式表达对规范进行清楚明白的描述并指定一项自动检测。此外，为了日常参考，还须提供一份人性化的、可理解的、 非正式的描述。 理由2.3.8 规范的建议可出于以下一种或多种原因： 可读性：易于理解的算法 可读的

9、模型 统一的模型外观、编码及文件编制 清洁的界面 专业的文件编制 工作流：高效的发展进程及工作流 易于维护 迅速的改型设计 可重复使用的部件 无问题的模型交换 模型可携带型 模拟：高效的模拟与分析 模拟速率 模拟内存 模型检测 确认：有能力对模型及生成的代码就下列因素进行验证和确认：& 验证 需求的可追溯性 测试 无问题的系统集成 清洁的界面 代码生成：生成对内嵌系统有效的代码 快速的软件变更 生成的代码的稳健性 最终更改 2.3.9 “最终更改部分”包括文件版本编号。 文件使用2.4 以下段落提供的信息是关于使用本文件作为参考以及参照本文件编写具体项目的规范文件的。附件A中可以找到关于对本规

10、范进行自动校核 的信息。 规范交互作用语义2.4.1本文件的起始段“命名规范与模型架构”提供了适用于各种模型的基本规范。其后的 “Simulink与Stateflow”部分提供上述环境中的具体规则。某些规范是依赖于其他规范的，模板中自始至终都对其作了明确说 明。 隐匿的子系统及可读性规则2.4.2如果用户没有查看模型内部隐匿子系统的内容，则关于可读性的规范不再适 软件环境3 总则3.1 一致的软件环境na_0026:3.1.1 在软件开发过程中，描述建议在整个项目中始终使用一致 的软件开发环境。此处所说的软件包括但不仅限于： MATLAB Simulink )供模拟C Compiler ( C

11、 Compiler 供目标硬 ?可读性理由 工作流 模拟 验证&确认 ?代码生成 ：必需的软件jh_0042参见 版3.00最终更改 仅有标准库模块的使用na_0027: 3.1.2 仅有标准库模块的使用na_0027: ID：标题 建议优先级 MAAB北美适用范围 全部MATLAB版本 前提 描述公司在开发模型时应指定Simulink的一个子集以供使用。模块列表可包括由公司或第三方开发的自定义 模块库。模型应仅由这些模块构成。开发过程中可使用非兼容性模块。如果使用了非兼容性模块，须用一种颜色/图标和/或注释进行标记。这 些非兼容性模块在用于生成生产代码之前必须移除。 理由?可读性 工作流 ?

12、模拟 ?验证&确认 ?代码生成 参见 只使用标准库模块hyl_0201: 最终更改 版3.00 命名规范4 总则 4.1 ：文件名4.1.1ar_0001 ：标题ar_0001ID ：文件名 强制要求优先级 MAAB适用范围 全部版本MATLAB 前提 文件名应符合以下约束条件：描述 扩展.文件名=文件名称形式 ：无前导位数，无空格符号名称 ：无空格符号扩展 上级项目目录内的所有文件名唯一性 关键词冲突MATLABC/C+或不得与 ：名称允许的字a b c d e f g h i j k l m n o p qr s t u v w x y z A B C D E F G HI J K L M

13、 N O P Q R S T U V W X YZ 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 qr s t u v w x y z A B C D E F G HI J K L M N O P Q R S T U V W X YZ 0 1 2 3 4 5 6 7 8 ：名称下划线 可使用下划线分离各个部分 不得连续使用一个以上的下划线 不得以下划线开头 不得以下划线结尾 ：扩展不得使用下划线可读理工作模 验证&确认 ?代码生成 版最终更改3.00 ：目录名4.1.2ar_0002 ：标题ID 优先级 适用范围：目录名ar_0002

14、 强制要求 MAAB 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 _ ：下划线名称 可使用下划线分离各个部分 不得连续使用一个以上的下划线 不得以下划线开头 不得以下划线结尾 ?可读性理由 ?工作流 ?模拟 验证&确认 ?代码生成 版

15、1.00最终更改 ：命名规范的采用4.1.3na_0035 ：标题ID 优先级 适用范围 版本MATLAB：命名规范的采用na_0035 建议 MAAB北美 全部 前提 建议采用命名规范。命名规范为模块、信号、参数和数描述 命名规范经常涉及下列问题：据类型的命名提供了规范。 符合程序设计语言及下游工具 长度 符号的使用 可读性 使用下划线 使用大写字母 编码信息使用“有意义”的名标准的缩写和简数据类工程单数据谱系关 存储器类型 ?理由可读性 ?工作流 ?模拟 验证&确认 ?代码生成 版3.00最终更改 模型内容规范4.2 子系统名称可用字符4.2.1jc_0201子系统名称可用字：标jc_02

16、01I强烈建优先MAA适用范全版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 YZ 0 1 2 3 4 5 6 7 8 9 下划名可使用下划线分离各个部 不得连续使用一个以上的下划线 不得以下划线开头 不得以下划线结尾 ?可读性理由 工作流 模拟 验证&确认 代码生成 版2.20最终更改 输入模块与

17、输出模块名称可用字符4.2.2 jc_0211输入模块与输出模块名称可用字：标jc_0211I强烈建优先MAA适用范全版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 HI J K L M N O P Q R S T U V W X YZ 0 1 2 3 4 5 6 7 8 9 下划名称 可使用下划线分离各个部分 不得连续使用一个以上的下划线 不得以下划线开

18、头 不得以下划线结尾 ?可读性理由 工作流 模拟 验证&确认 代码生成 版2.20最终更改 ：信号线名称可用字符4.2.3jc_022：信号线名称可用字：标jc_022I强烈建优先MAA适用范全版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 YZ 0 1 2 3 4 5 6 7 8 9 下划名可使用下划线

19、分离各个部 不得连续使用一个以上的下划线 不得以下划线开头 不得以下划线结尾 ?可读性理由 工作流 模拟 验证&确认 代码生成 版2.20最终更改 公交车名称可用字符：Simulink4.2.4 na_003公交车名称可用字Simulinna_003：标I强烈建优先MAA适用范北全版MATLAB 前提 公交车名称均应符合以下约束条件：Simulink所有描述 ：形式名称 不得以数字开头 不得出现空白间隔 不得出现回车符 ：允许的字符名称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

20、O P Q R S T U V W X YZ 0 1 2 3 4 5 6 7 8 9 下划名可使用下划线分离各个部 不得连续使用一个以上的下划线 不得以下划线开头 不得以下划线结尾 ?可读性理由 工作流 模拟 验证&确认 代码生成 公交车名称可用字符：参见Simulinkjh_0040 版最终更改3.00 ：模块名称可用字符4.2.5 jc_023：模块名称可用字：标Ijc_023强烈建优先级 MAAB适用范围 MATLAB版本 全部 子系统名称可用字符前提jc_0201: 描述 所有模块名称均应符合以下约束条件： ：名称形式 不得以数字开头 不得出现空白间隔 不得出现回车符 ：名称允许的字符

21、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 _ 注：本规则不适用于子系统模块。 ?理由可读性工作模验确代码生最终更2.00 的本地语言StateflowSimulink及4.2.6 na_0014：使用 的本地语言及Stateflowna_0014：使用SimulinkID：标题 强烈建议优先级 MAAB适用范围日本 全部MATLAB版本 前提 本地语言只能在描述字段使用。描述字段是不影响代码描述 生成及模拟的文本切入点。描述字段示例包括 示例：Simulink 模块属性的描述字段 直接进入模型的文本注释 示例Stateflow 图表或状态参数的描述字段 使用“添加注释”添加的注释 注：如果一个模型包含关于不同字符编码系统的本地言可能会出Simulin无法打开该模型的状况因此当跨越国界进行模型交换时应留意本地字符的使用，是非常重要的理可读工作模验确代码生 版2.00最终更改 模型