CN112579153A - 软件模型设计说明的生成方法 - Google Patents

软件模型设计说明的生成方法 Download PDF

Info

Publication number
CN112579153A
CN112579153A CN202011473280.XA CN202011473280A CN112579153A CN 112579153 A CN112579153 A CN 112579153A CN 202011473280 A CN202011473280 A CN 202011473280A CN 112579153 A CN112579153 A CN 112579153A
Authority
CN
China
Prior art keywords
design
model
information
design description
generating
Prior art date
Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
Pending
Application number
CN202011473280.XA
Other languages
English (en)
Inventor
朱理化
周彰毅
张春
黄浩
Current Assignee (The listed assignees may be inaccurate. Google has not performed a legal analysis and makes no representation or warranty as to the accuracy of the list.)
AECC Aero Engine Control System Institute
Original Assignee
AECC Aero Engine Control System Institute
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by AECC Aero Engine Control System Institute filed Critical AECC Aero Engine Control System Institute
Priority to CN202011473280.XA priority Critical patent/CN112579153A/zh
Publication of CN112579153A publication Critical patent/CN112579153A/zh
Pending legal-status Critical Current

Links

Images

Classifications

    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F40/00—Handling natural language data
    • G06F40/10—Text processing
    • G06F40/166—Editing, e.g. inserting or deleting
    • G06F40/186—Templates
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F8/00—Arrangements for software engineering
    • G06F8/70—Software maintenance or management
    • G06F8/73—Program documentation

Landscapes

  • Engineering & Computer Science (AREA)
  • Theoretical Computer Science (AREA)
  • General Engineering & Computer Science (AREA)
  • Physics & Mathematics (AREA)
  • General Physics & Mathematics (AREA)
  • Software Systems (AREA)
  • Computational Linguistics (AREA)
  • General Health & Medical Sciences (AREA)
  • Health & Medical Sciences (AREA)
  • Audiology, Speech & Language Pathology (AREA)
  • Artificial Intelligence (AREA)
  • Library & Information Science (AREA)
  • Stored Programmes (AREA)

Abstract

本发明公开了一种软件模型设计说明的生成方法，具体包括如下步骤步骤100：加载指定路径下的模型并获取模型的设计信息；步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。根据上述软件模型设计说明的生成方法，可以根据模型的设计信息生成符合指定标准的设计说明文件，便于设计信息的交流，并降低了开发人员的工作量。

Description

软件模型设计说明的生成方法
技术领域
本发明涉及计算机软件领域，特别涉及一种软件模型设计说明的生成方法。
背景技术
在航空发动机全权限数字电子控制系统(FADEC)控制软件中越来越多地使用基于模型的开发方法(MBD)。在传统软件开发中，软件设计人员根据软件需求完成软件设计，在根据设计结果开展编码。而在MBD开发方法中，软件设计人员根据软件需求规格说明构建模型，之后由模型自动生成代码。因此，在基于模型的软件开发中，模型即为软件设计的结果。但是为了满足行业标准及与利益相关方交流的需要，仍需完成软件设计说明文档的编制，现有的基于模型的软件开发工具虽然支持设计说明文档的自动生成，但是其格式不能定制，无法满足一些行业的需求。
发明内容
发明目的：本发明的目的是提出一种软件模型设计说明的生成方法，可以生成符合标准的软件设计文档，节省开发人员时间。
技术方案：本发明所述软件模型设计说明的生成方法，具体包括如下步骤：
步骤100：加载指定路径下的模型并获取模型的设计信息；
步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；
步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。
进一步的，所述步骤100包括：
步骤110：加载指定路径下的模型的顶层模型；
步骤120：根据模型的工程文件中的引用关系，获取所有被顶层模型调用的子模型，并加载所有子模型；
步骤130：遍历顶层模型及所有子模型，获取顶层模型及子模型的设计信息。
进一步的，所述设计信息包括模型的全局信息及模型中所有模块的名称、组成及调用关系、执行时序、输入接口、输出接口、内部变量、模块注释及需求跟踪关系。
进一步的，所述全局信息包括常量、枚举类型、结构体类型定义。
进一步的，所述步骤300包括：
步骤310：根据设计信息中的模块的组成及调用关系信息生成设计说明文件中的“CSCI部件”章节内容；
步骤320：根据设计信息中的模块的执行时序生成设计说明文件中的“执行方案”章节内容；
步骤330：根据设计信息中的模块的名称、输入接口、输出接口、内部变量模块注释生成设计说明文件中的“CSCI详细设计”章节内容；
步骤340：根据设计信息中的模块的需求跟踪信息生成设计说明中的“软件需求跟踪矩阵”内容；
步骤350：更新设计文件目录信息，保存及关闭设计说明文件。
进一步的，所述步骤310中模块的组成及调用关系信息以树状图的形式记录于“CSCI部件”章节内容中。
进一步的，所述步骤320中的模块的执行时序以矩阵形式记录于“执行方案”章节内容。
有益效果：与现有技术相比，本发明具有如下优点：可以将指定模型的信息按指定的模板生成符合相应规范的设计说明文件，降低设计人员的工作量。
附图说明
图1为本发明的第一实施例的生成方法的流程图；
图2为本发明的第二实施例的生成方法的流程图。
具体实施方式
下面结合附图对本发明的技术方案作进一步说明。
参照图1，根据本发明实施例的软件模型的设计说明的生成方法，具体包括如下步骤：
步骤100：加载指定路径下的模型并获取模型的设计信息；
步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；
步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。
其中设计说明模板为按照一些行业标准，如GJB438B标准设计的，设计说明模板的段落格式、正文字体、页眉页脚等均按照需要的标准设置，在生成设计说明时加载该设计说明模板，并另存为新的设计说明文件。再将步骤100中获得的模型的设计信息，按照不同的内容分章节地，以设计说明模板中设好的格式生成到设计说明文件中保存。根据上述技术方案的软件模型设计说明的生成方法，可以自动获取模型的设计信息并输出成符合指定标准格式的设计说明文件，便于进行相关的交流，并降低开发人员的工作量。可以理解的是，设计说明模板可以根据需要选择合适的文字处理软件建立，如微软的Word等，并通过所用的文件处理软件的接口或者宏来实现内容的插入。
参照图2，在一些实施例中，加载指定模型并获取模型设计信息的方法具体包括如下步骤：
步骤110：加载指定路径下的模型的顶层模型；
步骤120：根据模型的工程文件中的引用关系，获取所有被顶层模型调用的子模型，并加载所有子模型；
步骤130：遍历顶层模型及所有子模型，获取顶层模型及子模型的设计信息。
以FADEC软件模型常用的SCADE Suite环境为例，调用SCADE Suite的Python API接口加载指定路径下的模型工程文件，再通过get_roots()接口加载最顶层的顶层模型。然后根据模型工程文件中的引用关系，获取所有被顶层模型调用的子模型，再采用load_project()接口加载所有被调用的子模型，遍历所有模型并获得顶层模型及子模型的设计信息。
在一些实施例中，需要获取的设计信息包括模型的全局信息及模型中所有模块的名称、组成及调用关系、执行时序、输入接口、输出接口、内部变量、模块注释及需求跟踪关系等。其中全局信息包括常量、枚举类型、结构体类型定义等全局信息。
在一些实施例中，设计信息按照如下步骤生成于设计说明文件中：
步骤310：根据设计信息中的模块的组成及调用关系信息生成设计说明文件中的“CSCI部件”章节内容；
步骤320：根据设计信息中的模块的执行时序生成设计说明文件中的“执行方案”章节内容；
步骤330：根据设计信息中的模块的名称、输入接口、输出接口、内部变量模块注释生成设计说明文件中的“CSCI详细设计”章节内容；
步骤340：根据设计信息中的模块的需求跟踪信息生成设计说明中的“软件需求跟踪矩阵”内容；
步骤350：更新设计文件目录信息，保存及关闭设计说明文件。
在一些实施例中，为了直观地获取模型的设计信息，步骤310中的“CSCI部件”章节以树状图的形式记录模块的组成及调用关系信息，以顶层模块作为树状图的根节点，被其调用的子模块作为叶子节点，直至模块的最底层。
在步骤320中，“执行方案”章节可以通过矩阵的形式展示模块的执行顺序。矩阵中以执行条件为矩阵的行，以模块的名称为列，在行列的交叉点表示该列的模块在满足该行的执行条件时是否执行。
在一些实施例中，设计说明文件中的“接口设计”、“CSCI详细设计”及“软件需求跟踪矩阵”章节中的内容均以表格方式呈现。
“接口设计”章节中，每个全局信息占一行，行内说明该全局信息的标识符、数据类型、单位等说明信息。
“CSCI详细设计”章节中将每个模块的名称、输入接口、输出接口、内部变量及模块注释等信息分别放入到对应模块名称下的子章节中。每个模块的子章节下还包括输入接口、输出接口、内部变量、功能处理四个子章节。其中，输入接口、输出接口、内部变量三个章节以表格形式输出。表格每个接口元素占一行，包括元素标识、类型、单位、描述信息四列。功能处理章节中，将模块的设计图以图片形式插入。
“软件需求跟踪矩阵”中的软件需求跟踪矩阵表格内包括序号、功能标识、低层需求标识、高层需求标识四列。其中，序号列为行的顺序编号，功能标识列填入模块的名称，低层需求标识列填入模块设计图的名称，高层需求标识列填入相应设计图所追踪的需求标识。

Claims (7)

1.一种软件模型设计说明的生成方法，其特征在于，包括如下步骤：
步骤100：加载指定路径下的模型并获取模型的设计信息；
步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；
步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。
2.根据权利要求1所述的软件模型设计说明的生成方法，其特征在于，所述步骤100包括：
步骤110：加载指定路径下的模型的顶层模型；
步骤120：根据模型的工程文件中的引用关系，获取所有被顶层模型调用的子模型，并加载所有子模型；
步骤130：遍历顶层模型及所有子模型，获取顶层模型及子模型的设计信息。
3.根据权利要求1或2所述的软件模型设计说明的生成方法，其特征在于，所述设计信息包括模型的全局信息及模型中所有模块的名称、组成及调用关系、执行时序、输入接口、输出接口、内部变量、模块注释及需求跟踪关系。
4.根据权利要求3所述的软件模型设计说明的生成方法，其特征在于，所述全局信息包括常量、枚举类型、结构体类型定义。
5.根据权利要求3所述的软件模型设计说明的生成方法，其特征在于，所述步骤300包括：
步骤310：根据设计信息中的模块的组成及调用关系信息生成设计说明文件中的“CSCI部件”章节内容；
步骤320：根据设计信息中的模块的执行时序生成设计说明文件中的“执行方案”章节内容；
步骤330：根据设计信息中的模块的名称、输入接口、输出接口、内部变量模块注释生成设计说明文件中的“CSCI详细设计”章节内容；
步骤340：根据设计信息中的模块的需求跟踪信息生成设计说明中的“软件需求跟踪矩阵”内容；
步骤350：更新设计文件目录信息，保存及关闭设计说明文件。
6.根据权利要求5所述的软件模型设计说明的生成方法，其特征在于，所述步骤310中模块的组成及调用关系信息以树状图的形式记录于“CSCI部件”章节内容中。
7.根据权利要求5所述的软件模型设计说明的生成方法，其特征在于，所述步骤320中的模块的执行时序以矩阵形式记录于“执行方案”章节内容。
CN202011473280.XA 2020-12-15 2020-12-15 软件模型设计说明的生成方法 Pending CN112579153A (zh)

Priority Applications (1)

Application Number Priority Date Filing Date Title
CN202011473280.XA CN112579153A (zh) 2020-12-15 2020-12-15 软件模型设计说明的生成方法

Applications Claiming Priority (1)

Application Number Priority Date Filing Date Title
CN202011473280.XA CN112579153A (zh) 2020-12-15 2020-12-15 软件模型设计说明的生成方法

Publications (1)

Publication Number Publication Date
CN112579153A true CN112579153A (zh) 2021-03-30

Family

ID=75134891

Family Applications (1)

Application Number Title Priority Date Filing Date
CN202011473280.XA Pending CN112579153A (zh) 2020-12-15 2020-12-15 软件模型设计说明的生成方法

Country Status (1)

Country Link
CN (1) CN112579153A (zh)

Citations (6)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US20050075746A1 (en) * 2003-10-03 2005-04-07 Malone Daniel R. Electronic product design
CN101599014A (zh) * 2008-06-05 2009-12-09 株式会社东芝 程序·设计文件的生成装置
CN101661580A (zh) * 2009-07-22 2010-03-03 中国农业银行股份有限公司 一种软件测试的方法及系统
CN103336760A (zh) * 2013-07-11 2013-10-02 北京信息科技大学 一种基于逆向工程自动生成软件文档的方法及装置
CN105528418A (zh) * 2015-12-04 2016-04-27 东软集团股份有限公司 一种设计文档生成方法及装置
CN110134596A (zh) * 2019-04-24 2019-08-16 中科恒运股份有限公司 测试文档的生成方法及终端设备

Patent Citations (6)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US20050075746A1 (en) * 2003-10-03 2005-04-07 Malone Daniel R. Electronic product design
CN101599014A (zh) * 2008-06-05 2009-12-09 株式会社东芝 程序·设计文件的生成装置
CN101661580A (zh) * 2009-07-22 2010-03-03 中国农业银行股份有限公司 一种软件测试的方法及系统
CN103336760A (zh) * 2013-07-11 2013-10-02 北京信息科技大学 一种基于逆向工程自动生成软件文档的方法及装置
CN105528418A (zh) * 2015-12-04 2016-04-27 东软集团股份有限公司 一种设计文档生成方法及装置
CN110134596A (zh) * 2019-04-24 2019-08-16 中科恒运股份有限公司 测试文档的生成方法及终端设备

Similar Documents

Publication Publication Date Title
US20060080603A1 (en) Method and apparatus for utilizing an object model to manage document parts for use in an electronic document
US20080244541A1 (en) Code translator and method of automatically translating modeling language code to hardware language code
CN104133772A (zh) 一种自动生成测试数据的方法
CN102236544B (zh) 一种皮肤设计方法及装置
CN111061475A (zh) 软件代码生成方法、装置、计算机设备和存储介质
US20120124550A1 (en) Facilitating database application code translation from a first application language to a second application language
CN114281342A (zh) 一种代码自动生成方法
CN112506505A (zh) 一种代码模板引擎进行程序代码生产的方法
CN100338605C (zh) 一种可扩展标记语言文档修改痕迹的记录方法
CN106789200A (zh) 一种云平台自定义自动部署的方法
CN113655996B (zh) 一种基于需求模型的企业级系统生成方法
CN109947711B (zh) 一种对ios项目开发过程中的多语言文件自动化管理方法
CN114091383A (zh) 测试序列生成方法、装置、系统及相关设备
JP5747698B2 (ja) 要件管理支援装置
CN114047970A (zh) 一种autosar架构软件的配置方法及系统
CN112947896A (zh) 一种基于有向图的组件依赖分析方法
CN110502735B (zh) 一种电子设备通用工艺文件快速制作方法及系统
CN116776811A (zh) 一种复杂电气设计pcb板图自动生成方法、系统及设备
CN112579153A (zh) 软件模型设计说明的生成方法
CN111399900B (zh) 一种基于python与正则表达式的API文档自动生成方法及系统
CN115268846A (zh) 一种添加属性信息的方法、装置及计算机可读存储介质
CN113792530A (zh) 基于国产cpu和操作系统的导出wps的方法及系统
CN107844639B (zh) 一种项目标准结构自动生成方法及系统
WO2008075087A1 (en) Code translator and method of automatically translating modelling language code to hardware language code
CN112068830A (zh) 一种面向航电系统架构模型的设计工具

Legal Events

Date Code Title Description
PB01 Publication
PB01 Publication
SE01 Entry into force of request for substantive examination
SE01 Entry into force of request for substantive examination
RJ01 Rejection of invention patent application after publication

Application publication date: 20210330

RJ01 Rejection of invention patent application after publication