1、控制算法建模規(guī)范Matlab/Simulink/Stateflow3.0版Mathworks汽車咨詢委員會(MAAB1修訂歷史日期修訂2001.02.04初始版本1.0版發(fā)布2007.04.27更新版本2.0版發(fā)布2011.07.30更新版本3.0版發(fā)布2012.08.31更新版本4.0版發(fā)布2介紹2.1 動機MAAB建模規(guī)范無論是在組織內(nèi)部還是在與合作伙伴和分包商合作時都是項目成功與團隊協(xié)作的重要基礎(chǔ)。遵守建模規(guī)范是實現(xiàn)以下目標的重要前提：無問題的系統(tǒng)集成明確定義的界面統(tǒng)一的模型外觀、編碼及文件編制可重用模型可讀的模型無問題的模型交換簡單高效的過程專業(yè)的文件編制清晰易懂的展示快速的軟件變更

2、與分包商的合作將研究或重建項目移交給產(chǎn)品開發(fā)2.2 對3.0版的批注本規(guī)范的現(xiàn)行版本 3.0版支持MATLAB!,包括其R2007b至R2011b版。3.0版參考了美國國家航空航天局獵戶座指南中的部分規(guī)則。參 考的規(guī)則均在“參見”部分中標明了該規(guī)則在美國國家航空航天局獵戶 座指南中的編號。2.3 規(guī)范模板規(guī)范描述采用下列模板出具。建議想要附加其他規(guī)范的公司也采用下列模板進行添加。ID:標題XX_nnnn:規(guī)范的標題（須唯一且簡短）優(yōu)先級強制要求/強烈建議/建議之一適用范圍MAAB,NA-MAAB,J-MAAB 特定公司（本地公司可選使用）MATLA皈本全部RX, RY, RZRX及其之前的版本

3、RX及其之后的版本RX至RY的版本前提到規(guī)范的鏈接，這是本規(guī)范的前提（ID+標題）描述對規(guī)范的描述（文本，圖像）理由制定規(guī)范的動機最終更改最終更改版本編號注：本模板的各項元素是為使規(guī)范得到合理的理解與交流所必須提供 的最小項。允許對本模板的項目或賣主部分進行補充，只要補充的部分不 與原有部分在意義上重合即可。事實上，如果上述補充能有助于整合其他 規(guī)范模板并促使核心模板本身達到更廣泛的接收度，這樣的補充是受到鼓 勵的。2.3.1 規(guī)范 ID規(guī)范的ID由兩個小寫字母（表示規(guī)則的出處）和四位數(shù)字組成, 中間用一段下劃線隔開。一旦一份新規(guī)范有了 ID,該ID將不再改變。ID用來指代相應(yīng)的規(guī)范。以“na

4、”、“jp”、“jc”、“eu”開頭的ID預(yù)留給未來的MAA覬范 使用。保留以 “db”、“jm”、“hd”、“ar” 開頭的 ID。新規(guī)則的ID不得以上述字母開頭。2.3.2 規(guī)范標題規(guī)范的標題應(yīng)對該規(guī)范的應(yīng)用領(lǐng)域進行簡短且唯一的描述（例如，名字的長度）。規(guī)范的標題適用于前提條件部分及定制檢測工具。規(guī)范的標題應(yīng)與到該規(guī)范的超鏈接同時寫出。注：標題不應(yīng)為對規(guī)范內(nèi)容的多余的簡要描述。對規(guī)范內(nèi)容的描述未來可能發(fā)生改變，但規(guī)范的標題始終不得更改。2.3.3 優(yōu)先級每條規(guī)范都須根據(jù)下列優(yōu)先順序進行評級：強制要求強烈建議建議優(yōu)先級描述該規(guī)范的重要程度并決定違反該規(guī)范的后果嚴重程度:強制要求強烈建議建議定

5、義所有公司一致被一致認定為良為改進模型圖認定為絕對必好做法，但遺留模的外觀建議遵不可少的規(guī)范型阻礙了公司對守的規(guī)范，但該該規(guī)范 100%勺遵規(guī)范對于模型所有公司都守的運行并非起100%遵守的規(guī)決定作用范模型須以可能的最大程度遵守該如果遵守會更規(guī)范，但并未要求好，但并非必要對其100%勺遵守的規(guī)范后果如果違反了該規(guī)范必要的項質(zhì)量和外觀劣外觀可能目出現(xiàn)缺化與其他項失可能對可維修目不T模型無法性、可攜帶型正常工作及可重用性產(chǎn)生不利影響豁免政策如果啟意地忽略該規(guī)范原因須備有文件證明2.3.4 適用范圍適用范圍可以是以下三者之一：MAAB （MathWorks汽車咨詢委員會）J-MAAB （日本 MAA

6、B）NA-MAAB d匕美 MAAB）“MAAB是一個與 MathsWorks|緊密合作的汽車制造商及供應(yīng)商的團隊。MAA電括兩個子團隊，即日本 MAA吸北美MAAB“J-MAAE?是MAAB勺子團隊，包括與 .athsWorks|緊密合作的日本汽 車制造商及供應(yīng)商。J-MAAB規(guī)則的適用范圍為日本當?shù)亍！癗A-MAAB 是MAAB勺子團隊，包括與 MathsWorks緊密合作的美國 及歐洲的汽車制造商及供應(yīng)商。該規(guī)則是美國及歐洲當?shù)氐囊?guī)則。覆蓋范 圍為美國和歐洲。2.3.5 MATLA甄本本規(guī)范適用于MATLABS Simulink所有版本的產(chǎn)品。如果一條規(guī)則僅 適用于MATLAB勺某一個或

7、某幾個版本，則適用版本的信息應(yīng)在MATLA甑本部分進行說明，說明格式為下列格式中的一種：全部：MATLAB勺所有版本RX, RY, RZ : MATLAB勺某一特定版本RX及其之前的版本：RX發(fā)布之前的MATLA班本RX及其之后的版本：RX發(fā)布之后直至現(xiàn)行版本發(fā)布期間的MATLAB版本RX至RY的版本：RX至RY之間的MATLABS本2.3.6 前提該部分是到其他規(guī)范的鏈接，鏈接的規(guī)范均為本規(guī)范的前提（邏輯關(guān)聯(lián)）。每個鏈接須注明相應(yīng)規(guī)范的ID （為了一致性）和標題（為了可讀 性）。“前提”部分不應(yīng)包括任何其他文本。2.3.7 描述該部分包括對規(guī)范的詳細描述。如有需要，可添加圖像和表格。注：如果

8、正式表達（數(shù)學符號、正規(guī)表達式、語法圖及精確數(shù)值/范圍）可用，應(yīng)使用正式表達對規(guī)范進行清楚明白的描述并指定一項自動檢測。止匕外，為了日常參考，還須提供一份人性化的、可理解的、非正式的描述。2.3.8 理由規(guī)范的建議可出于以下一種或多種原因：可讀性：易于理解的算法可讀的模型統(tǒng)一的模型外觀、編碼及文件編制清潔的界面專業(yè)的文件編制工作流：高效的發(fā)展進程及工作流易于維護迅速的改型設(shè)計可重復(fù)使用的部件無問題的模型交換模型可攜帶型模擬：高效的模擬與分析模擬速率模擬內(nèi)存模型檢測驗證&確認：有能力對模型及生成的代碼就下列因素進行驗證和確認:需求的可追溯性測試 無問題的系統(tǒng)集成清潔的界面代碼生成：生成對

9、內(nèi)嵌系統(tǒng)有效的代碼快速的軟件變更生成的代碼的穩(wěn)健性2.3.9 最終更改“最終更改部分”包括文件版本編號。2.4 文件使用以下段落提供的信息是關(guān)于使用本文件作為參考以及參照本文件編 寫具體項目的規(guī)范文件的。附件 A中可以找到關(guān)于對本規(guī)范進行自動校核 的信息。2.4.1 規(guī)范交互作用語義本文件的起始段“命名規(guī)范與模型架構(gòu)”提供了適用于各種模型的基本規(guī)范。其后的 “Simulink與Stateflow ”部分提供上述環(huán)境中的具體 規(guī)則。某些規(guī)范是依賴于其他規(guī)范的，模板中自始至終都對其作了明確說 明。2.4.2 隱匿的子系統(tǒng)及可讀性規(guī)則如果用戶沒有查看模型內(nèi)部隱匿子系統(tǒng)的內(nèi)容，則關(guān)于可讀性的規(guī)范不再適

10、3軟件環(huán)境3.1 總則3.1.1 na_0026: 一致的軟件環(huán)境ID :標題na_0026: 一致的軟件環(huán)境優(yōu)先級建議適用范圍北美MAABMATLA甑本見“描述”前提描述在軟件開發(fā)過程中，建議在整個項目中始終使用一致的軟件開發(fā)環(huán)境。此處所說的軟件包括但不僅限于：MATLABSimulinkC Compiler （供模擬）C Compiler （供目標硬件）理由?可讀性工作流模擬驗證&確認?代碼生成參見jh_0042 :必需的軟件最終更改3.00 版3.1.2 na_0027:僅有標準庫模塊的使用ID :標題na_0027:僅有標準庫模塊的使用優(yōu)先級建議適用范圍北美MAABMATLA甑

11、本全部前提描述公司在開發(fā)模型時應(yīng)指定 Simulink的一個子集以供 使用。模塊列表可包括由公司或第三方開發(fā)的自定義 模塊庫。模型應(yīng)僅由這些模塊構(gòu)成。開發(fā)過程中可使用非兼容性模塊。 如果使用了非兼容 性模塊，須用一種顏色/圖標和/或注釋進行標記。這 些非兼容性模塊在用于生成生產(chǎn)代碼之前必須移除。理由?可讀性工作流?模擬?驗證蝴認?代碼生成參見hyl_0201:只使用標準庫模塊最終更改3.00 版4命名規(guī)范4.1 總則4.1.1ar_0001 :文件名ID:標題ar_0001 :文件名優(yōu)先級強制要求適用范圍MAABMATLA皈本全部前提描述文件名應(yīng)符合以下約束條件：形式文件名=文件名稱.擴展名稱

12、：無前導(dǎo)位數(shù)，無空格符號擴展：無空格符號唯一性上級項目目錄內(nèi)的所有文件名不得與C/C+或MATLA關(guān)鍵詞沖突允許的字符名稱：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 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

13、6 7 8 9下劃線名稱：可使用下劃線分離各個部分不得連續(xù)使用一個以上的下劃線不得以下劃線開頭不得以下劃線結(jié)尾擴展：不得使用卜劃線理由?可讀性?工作流?模擬驗證&確認?代碼生成最終更改3.00 版4.1.2ar_0002 :目錄名ID:標題ar_0002 :目錄名優(yōu)先級強制要求適用范圍MAABMATLAB全部前提描述目錄名應(yīng)符合以下約束條件:形式目錄名=名稱名稱：無前導(dǎo)位數(shù)，無空格符號唯一性上級項目目錄內(nèi)的所有文件名允許的字符名稱：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

14、O P Q R S T U V W X YZ 0 1 2 3 4 5 6 7 8 9 _下劃線名稱：可使用卜劃線分離各個部分不得連續(xù)使用一個以上的下劃線不得以下劃線開頭不得以下劃線結(jié)尾理由?可讀性?工作流?模擬驗證&確認?代碼生成最終更改1.00 版4.1.3na_0035 :命名規(guī)范的采用ID:標題na_0035:命名規(guī)范的米用優(yōu)先級建議適用范圍北美MAABMATLA皈本全部前提描述建議采用命名規(guī)范。命名規(guī)范為模塊、信號、參數(shù)和數(shù)據(jù)類型的命名提供了規(guī)范。命名規(guī)范經(jīng)常涉及下列問題：符合程序設(shè)計語言及下游工具。長度。符號的使用可讀性。使用卜劃線。使用大寫字母編碼信息。使用“后意義”的名稱

15、。標準的縮寫和簡稱。數(shù)據(jù)類型。工程單位。忸據(jù)譜系關(guān)系0存儲器類型理由?可讀性?工作流?模擬驗證&確認?代碼生成最終更改3.00 版4.2 模型內(nèi)容規(guī)范4.2.1jc_0201:子系統(tǒng)名稱可用字符ID:標題jc_0201:子系統(tǒng)名稱可用字符優(yōu)先級強烈建議適用范圍MAABMATLA皈本全部前提描述所有子系統(tǒng)模塊的名稱均應(yīng)符合以下約束條件:形式名稱：不得以數(shù)字開頭不得出現(xiàn)空白間隔不得出現(xiàn)回車符允許的字符名稱：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

16、 W X YZ 0 1 2 3 4 5 6 7 8 9 _下劃線名稱：可使用卜劃線分離各個部分不得連續(xù)使用一個以上的下劃線不得以下劃線開頭不得以下劃線結(jié)尾理由?可讀性工作流模擬驗證&確認口代碼生成最終更改2.20 版4.2.2 jc_0211:輸入模塊與輸出模塊名稱可用字符ID:標題jc_0211:輸入模塊與輸出模塊名稱可用字符優(yōu)先級強烈建議適用范圍MAABMATLA皈本全部前提描述所有輸入模塊與輸出模塊的名稱均應(yīng)符合以下約束條件：形式名稱：不得以數(shù)字開頭不得出現(xiàn)空白間隔不得出現(xiàn)回車符允許的字符名稱：a b c d e f g h i j k l m n o p qr s t u v

17、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 _下劃線名稱：可使用卜劃線分離各個部分不得連續(xù)使用一個以上的下劃線不得以下劃線開頭不得以下劃線結(jié)尾理由?可讀性工作流模擬驗證&確認口代碼生成最終更改2.20 版4.2.3jc_0221 :信號線名稱可用字符ID:標題jc_0221 :信號線名稱可用字符優(yōu)先級強烈建議適用范圍MAABMATLA皈本全部前提描述所有信號線名稱均應(yīng)符合以下約束條件:形式名稱：不得以數(shù)字開頭不得出現(xiàn)空白間隔不得出現(xiàn)回車符允許的字符名稱：a b c d e f

18、 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 9 _下劃線名稱：可使用卜劃線分離各個部分不得連續(xù)使用一個以上的下劃線不得以下劃線開頭不得以下劃線結(jié)尾理由?可讀性工作流模擬驗證&確認口代碼生成最終更改2.20 版4.2.4 na_0030 : Simulink公交車名稱可用字符ID:標題na_0030: Simulink公交車名稱可用字符優(yōu)先級強烈建議適用范圍北美MAABMATLA皈本全部前提描述所有Simulink公交

19、車名稱均應(yīng)符合以下約束條件：形式名稱：不得以數(shù)字開頭不得出現(xiàn)空白間隔不得出現(xiàn)回車符允許的字符名稱：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 9 _下劃線名稱：可使用卜劃線分離各個部分不得連續(xù)使用一個以上的下劃線不得以下劃線開頭不得以下劃線結(jié)尾理由?可讀性工作流模擬驗證&確認口代碼生成參見jh_0040 : Simulink公交車名稱可用字符最終更改3.00 版4.2.5 jc_0231:模塊名

20、稱可用字符ID:標題jc_0231 :模塊名稱可用字符優(yōu)先級強烈建議適用范圍MAABMATLA皈本全部前提jc_0201:子系統(tǒng)名稱可用字符描述所有模塊名稱均應(yīng)符合以下約束條件:形式名稱：不得以數(shù)字開頭不得出現(xiàn)空白間隔不得出現(xiàn)回車符允許的字符名稱：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 9 _注：本規(guī)則不適用于子系統(tǒng)模塊。理由口工作流口模擬口驗證&確認口代碼生成最終更改2.00 版4.2.6

21、 na_0014 :使用 Simulink 及 Stateflow 的本地語言ID:標題na_0014：使用 Simulink 及 Stateflow 的本地語言優(yōu)先級強烈建議適用范圍日本MAABMATLA皈本全部前提描述本地語言只能在描述字段使用。描球字段是不影響代碼生成及模擬的文本切入點。描述字段不例包括Simulink 示例:模塊屬性的描述字段直接進入模型的文本注釋Stateflow 示例圖表或狀態(tài)參數(shù)的描述字段使用“添加注釋”添加的注釋注：如果一個模型包含關(guān)于不同字符編碼系統(tǒng)的本地語言，可能會出現(xiàn)Simulink無法打開該模型的狀況；因此, 當跨越國界進行模型交換時應(yīng)留意本地字符的使用，這 是非常重要的。理由?可讀性工作流模擬驗證&確認口代碼生成最終更改2.00 版5模型架構(gòu)基本模塊本文件使用“基本模塊”指代基礎(chǔ)Simulink庫中的模塊。基本模塊舉例：5.1