软件模型设计说明的生成方法技术

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

【技术实现步骤摘要】
软件模型设计说明的生成方法
本专利技术涉及计算机软件领域，特别涉及一种软件模型设计说明的生成方法。
技术介绍
在航空发动机全权限数字电子控制系统(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软件模型常用的SCADESuite环境为例，调用SCADESuite的PythonAPI接口加载指定路径下的模型工程文件，再通过get_roots()接口加载最顶层的顶层模型。然后根据模型工程文件中的引用关系，获取所有被顶层模型调用的子模型，再采用load_project()接口加载所有被调用的子模型，遍历所有模型并获得顶层模型及子模型的设计信息。在一些实施例中，需要获取的设计信息包括模型的全局信息及模型中所有模块的名称、组成及调用关系、执行时序、输入接口、输出接口、内部变量、模块注释及需求跟踪关系等。其中全局信息包括常量、枚举类型、结构体类型定义等全局信息。在一些实施例中，设计信息按照如下步骤生成于设计说明文件中：步骤310：根据设计信息中的模块的组成及调用关系信息生成设计说明文件中的“CSCI部件”章节内容；步骤320：根据设计信息中的模块的执行时序生成设计说明文件中的“执行方案”章节内容；步骤330：根据设计信息中的模块的名称、输入接口、输出接口、内部变量模块注释生成设计说明文件中的“CSCI详细设计”章节内容；步骤340：根据设计信息中的模块的需求跟踪信息生成设计说明中的“软件需求跟踪矩阵”内容；步骤350：更新设计文件目录信息，保存及关闭设计说明文件。在一些实施例中，为了直观地获取模型的设计信息，步骤310中的“CSCI部件”章节以树状图的形式记录模块的组成及调用关系信息，以顶层模块作为树状图的根节点，被其调用的子模块作为叶子节点，直至模块的最底层。在步骤320中，“执行方案”章节可以通过矩阵的形式展示模块的执行顺序。矩阵中以执行条件为矩阵的行，以模块的名称为列，在行列的交叉点表示该列的模块在满足该行的执行条件时是否执行。在一些实施例中，设计说明文件中的“接口设计”、“CSCI详细设计”及“软件需求跟踪矩阵”章节中的内容均以表格方式呈现。“接口设计”章节中，每个全局信息占一行，行内说明该全局信息的标识符、数据类型、单位等说明信息。“CSCI详细设计”章节中将每个模块的名称、输入接口、输出接口、内部变量及模块注释等信息分别放入到对应模块名称下的子章节中。每个模块的子章节下还包括输入接口、输出接口、内部变量、功能处理四个子章节。其中，输入接口、输出接口、内部变量三个章节以表格形式输出。表格每个接口元素占一行，包括元素标识、类型、单位、描本文档来自技高网...

【技术保护点】
1.一种软件模型设计说明的生成方法，其特征在于，包括如下步骤：/n步骤100：加载指定路径下的模型并获取模型的设计信息；/n步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；/n步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。/n

【技术特征摘要】
1.一种软件模型设计说明的生成方法，其特征在于，包括如下步骤：
步骤100：加载指定路径下的模型并获取模型的设计信息；
步骤200：调用指定路径下的设计说明模板并另存为设计说明文件；
步骤300：将设计信息按照设计说明模板的格式输出到软件设计说明文件中，并保存设计说明文件。


2.根据权利要求1所述的软件模型设计说明的生成方法，其特征在于，所述步骤100包括：
步骤110：加载指定路径下的模型的顶层模型；
步骤120：根据模型的工程文件中的引用关系，获取所有被顶层模型调用的子模型，并加载所有子模型；
步骤130：遍历顶层模型及所有子模型，获取顶层模型及子模型的设计信息。


3.根据权利要求1或2所述的软件模型设计说明的生成方法，其特征在于，所述设计信息包括模型的全局信息及模型中所有模块的名称、组成及调用关系、执行时序、输入接口、输出接口、内部变量、模块注释及需求跟踪关系。


4.根据权利要求3所述的软件模型设计说明的生成方法，其特征在于，所述全局信息包括常...

【专利技术属性】
技术研发人员：朱理化，周彰毅，张春，黄浩，
申请(专利权)人：中国航发控制系统研究所，
类型：发明
国别省市：江苏;32