需求文档详细设计案例.docx
《需求文档详细设计案例.docx》由会员分享，可在线阅读，更多相关《需求文档详细设计案例.docx（36页珍藏版）》请在冰豆网上搜索。
需求文档详细设计案例
1引言
2任务概述
3系统详细设计
3.1系统总体结构设计
TEAMS二次开发软件系统根据卫星状态监控与诊断等任务需要，读取有关设备的测试性模型，并分析模型中各个测试点的状态，结合实际数据完成诊断推理，同时提供了一种标准化的数据接口，完善诊断推理、报表生成和基于Web客户端的数据远程查看与管理等功能。
实时诊断结果在输出的同时，存储到系统数据库中，便于查询和调阅。
此外，针对若干通用卫星部件建立起TEAMS通用模型库，并利用系统数据库实现对模型库的管理。
TEAMS二次开发软件配置项的功能组成结构如图2所示。
图1TEAMS二次开发软件功能组成
TEAMS二次开发软件系统主要功能模块之间的逻辑结构如图3所示。
图2TEAMS二次开发软件的逻辑结构图
3.2TEAMS模型自动生成与批量修改软件
3.2.1功能概述
TEAMS模型自动生成与批量修改软件完成通过添加固定格式的Excel文件生成TEAMS模型文件；批量修改模型名称和批量添加测试点；TEAMS模型和分析报告的存储。
3.2.2用户界面设计
TEAMS模型自动生成是通过填写固定格式的Excel的文件，通过软件文件生成器生成TEAMS模型文件，Excel文件可以是事先编辑好导入也可以进行实时打开固定的Excel模板进行编辑，并且导入Excel的主要信息会显示软件的窗口中，按模型模块、测试、测试设置、资源、功能相关性等进行分类。
点击“生成TEAMS模型”可是得到如图4的模型文件。
图3TEAMSExcel文件生成TEAMS模型文件
图4TEAMS通过TEAMS模型自动生成与批量修改软件生成的TEAMS模型文件
如图5根据导入文件文件可以在软件中批量修改模型名称和批量添加测试点。
图5TEAMS模型自动生成与批量修改软件的批量修改模块名称和批量添加测试点
建立好的模型和针对模型分析的报告能够存储远程的数据库中，并能够对模型进行本版的管理，和对TEAMS的一些辅助信息的增加如建模人员名称，模型类型。
图6TEAMS模型自动生成与批量修改软件进行模型和报告的存储和管理
3.2.3程序逻辑结构
模型接口文件解析模块的设计说明见表1。
表1程序设计说明表
模块名称
TEAMS模型自动生成与批量修改模块
性能要求
能够通过Excel生成TEAMS模型文件、批量修改模型名称和批量添加测试点、对模型文件和分析报告进行存储和读取，其中从数据库中导出模型文件和报告的时间10s以内，导入在1分钟。
限制条件
拥有数据库访问权限
输入
固定格式的Excel文件。
模块名称对应文件、模块与测试点对应文件
输出
TEAMS模型文件
算法逻辑
1.导入Excel文件，生成TEAMs模型文件
2.导入模型文件，进行批量修改模块名称和批量添加测试点
备注
无
3.2.4类和方法列表
模型接口文件解析模块的类设计说明见表2。
表2类设计说明表
类名
属性∕方法
含义∕职责
ParseExcel
Level
模块级别信息
Reliability
模块可靠性信息
TestName
测试名称
TestLevel
测试级别
ExcelFilePath
EXCEL文件路径（string）
ModeInfo
模型数据（ModelingEntiry）
FaultInfo
故障源信息（FaultEntity[]）
TestInfo
测试信息（TestEntity[]）
ConvertCsv2Xml
ReadCSV
打开CSV表格文件并识别为一个模型
ConvertCsv
打开CSV表格文件并转换为TEAMS模型
ConvertCsvXml
打开CSV表格文件并转存为XML格式的模型文件
UpdateCsv
将修改后的模型数据保存为CSV表格文件
UpdateCsvXml
将修改后的模型数据保存为XML格式的模型文件
3.2.5方法详细设计
TEAMS模型自动生成与批量修改软件的逻辑结构图4所示。
图7TEAMS模型自动生成与批量修改软件的逻辑结构图
3.2.6TEAMS模型自动生成与批量修改软件设计细节
3.2.6.1定制文件解析类ParseExcel
定制文件解析类ParseExcel用于完成对定制EXCEL表格内容的解析与提取，该类设计的目的在于明确定制文件解析的实现接口、所含数据成员，与其他软件模块的接口关系，以及对类的操作。
定制文件解析类ParseExcel的设计任务主要包括：
（1）对输入的定制EXCEL表格进行解析，添加系统模型。
用户按照定制建模所需的表格要求填写相关内容，经识别后作为模型自动生成的输入。
（2）对输入的批量EXCEL表格进行修改，批量修改系统模型。
模型信息包括：
模块级别、模块功能、模块可靠性相关参数、模块维修的简单信息描述、测试点信息、测试信息、操作资源信息等内容。
定制文件解析类ParseExcel的基本关系如图5所示。
图8定制文件解析类关系图
定制文件解析类ParseExcel的数据成员设计见表3，函数成员设计见表4。
其中，结构体数据类型ModelingEntiry和FaultEntity、TestEntity、FaultTestEntity分别定义如下：
publicstructModelingEntiry
{
publicstringLevel;
publicstringFunc;
publicdoubleReliability;
publicstringMaintenance;
publicstring[]TestPoints;
publicstringTestInfo;
publicstringResource;
}
publicstructFaultEntity
{
publicstringCompName;
publicstringFaultMode;
publicdoubleMTTF;
publicstringDealInfo;
publicintPartId;
}
publicstructTestEntity
{
publicstringTestName;
publicstringTestInfo;
publicstringTestLevel;
publicdoubleTestTime;
publicboolIsSympton;
publicstringTestType;
}
publicstructFaultTestEntity
{
publicstringOneFault;
publicstringOneTest;
publicboolIsRelated;
}
表3ParseExcel类的数据成员设计
类名
数据
作用及类型定义
ParseExcel
ExcelFilePath
EXCEL文件路径（string）
ModeInfo
模型数据（ModelingEntiry）
FaultInfo
故障源信息（FaultEntity[]）
TestInfo
测试信息（TestEntity[]）
FaultVsTest
相关性信息（FaultTestEntity[]）
表4ParseExcel类的函数成员设计
类名
函数
作用
输入
输出
ParseExcel
ReadExcel
打开定制EXCEL文件并识别为一个模型
EXCEL文件路径
模型数据
测试性数据
ConvertExcelCsv
打开定制EXCEL文件并转存为CSV格式的综合表格
EXCEL文件路径
CSV文件路径
UpdateExcel
将修改后的模型数据保存为定制EXCEL文件
模型数据
测试性数据
EXCEL文件路径
UpdateExcelCsv
将修改后的模型数据保存为CSV格式的综合表格
模型数据
测试性数据
CSV文件路径
定制文件解析类ParseExcel的接口信息交换关系见表5。
表5ParseExcel类的接口信息交换关系
序号
名称
信息内容
信息流动
来源
目的
1
定制文件解析与用户输入模型数据的接口
模型数据
用户EXCEL输入
信息输入
2
定制文件解析与用户输入测试性数据的接口
测试性数据
用户EXCEL输入
信息输入
3
定制文件解析与综合报告表格转换单元的接口
CSV表格文件
CSV文件生成
信息输出
为方便建模人员能快速收集理解设备信息，并构建模型，我们开发使用一份收集测试性数据的Excel表单。
表单包含3个部分—故障源信息，测试信息，故障源-测试相关矩阵。
以下是表单内容展示和使用方法说明。
表6故障源信息表格
组件名称
故障模式名称
MTTF
故障处理方法描述
零件号码
电池
电池-F1
1000000
更换电池
123
电线
电线-F1
1000000
更换电线
234
开关
开关-F1
1000000
更换开关
456
灯泡
灯泡-F1
1000000
更换灯泡
567
故障源信息表格包含组件名称，故障模式名称，MTTF，故障处理方法描述，零件号码。
●组件名称是故障模式所在的底层可更换零件的名称，例如电池-F1发生于电池，电线-F1发生于电线，电池和电线就是底层零件。
●故障模式是组件的故障类型，如果某个组件含有多个故障模式，可在下一行填写其他的故障模式。
●MTTF中输入组件的MTTF参数，如果不确定，填写默认值1000000。
●处理方法描述中填写故障组件的处理操作。
●如果需要，输入组件的零件号码，号码会在故障排查过程中显示。
零件号码为数值格式。
表7测试信息表格
测试名称
测试内容描述
测试级别
测试时间
是否是症状?
测试标签
电池电压测试
电池是否供电12伏？
1
0
否
手动
电线电压测试
电线是否供电12伏？
1
0
否
手动
开关电压测试
开关是否供电12伏？
1
0
否
手动
灯泡点亮
灯泡是否点亮?
1
0
否
手动
症状
灯泡不点亮
1
0
是
症状
测试信息表格中包含测试名称，测试内容，测试级别，测试时间，是否是症状，测试标签。
●测试名称必须是唯一的，是对测试内容的概括。
●测试内容是测试的详细描述。
●测试级别规定了测试的执行难易程度，级别数值越低，测试会被优先执行，最小级别为1级。
●测试时间表示此测试在时间上的花费。
●是否是症状？
症状是系统在执行正常功能输出时的故障现象。
●测试标签是测试手段的描述。
包括手动，自动，在板，症状等。
表8故障源—测试相关性矩阵
电池电压测试
电线电压测试
开关电压测试
灯泡
点亮
症状
电池-F1
1
1
1
1
1
电线-F1
1
1
1
1
开关-F1
1
1
1
灯泡-F1
1
1
通过矩阵关联故障源和测试，确定故障源和哪些测试匹配。
相匹配的元素之间用数字“1”建立连接，反之无需填写。
根据前面三份表格生成故障源与测试综合报告，这份报告涵盖了前三个表格中的所有信息，并且这是一份自动生成的表格，报告生成之后把它存储为CSV格式。
3.2.6.2综合报告表格转换类ConvertCsv2Xml
综合报告表格转换类ConvertCsv2Xml用于完成对XML模型文件的转换，该类设计的目的在于明确综合报告表格转换的实现接口、所含数据成员，与其他软件模块的接口关系，以及对类的操作。
综合报告表格转换类ConvertCsv2Xml的主要设计任务，是将CSV格式的设备故障源测试报告，转化为XML格式的诊断报告，基本操作过程描述如下：
●导入CSV格式的故障源测试综合报告。
●匹配TEAMS元素和CSV表格元素，例如，匹配关系包括：
FailureMode—Name对应FailureModeName
SubModule—name对应ComponentName
FailureMode—MTTF对应MTTF
SubModule—Narrative对应更换Narrative
SubModule-PartNumber对应PartNumber
Test—Name对应testname
Test—Narrative对应TestNarrative
Test—level对应Testlevel
Test—time对应testtime
Test—isSymptom对应IsSymptom
Test—labelname对应TestLabel
●匹配完毕后将生成的XML文件保存。
●运行TEAMS-Designer，可以将XML文件以拖拽的形式打开。
●可以对XML文件的内容执行测试性分析和静态分析，并生成报告。
●在TEAMS软件中能够保存成本地模型文件。
综合报告表格转换类ConvertCsv2Xml的基本关系如图6所示。
图9综合报告表格转换类关系图
综合报告表格转换类ConvertCsv2Xml的数据成员设计见表9，函数成员设计见表10。
其中，结构体数据类型TeamsEntry和LegacyEntry分别定义如下：
publicstructTeamsEntry
{
publicstringFailureModeName;
publicdoubleFailureModeMTTF;
publicstringSubModuleName;
publicstringSubModuleNarrative;
publicstringSubModulePartNumber;
publicstringTestName;
publicstringTestNarrative;
publicstringTestLevel;
publicstringTestTime;
publicstringTestIsSymptom;
publicstringTestLabelName;
}
publicstructLegacyEntry
{
publicstringFailureModeName;
publicdoubleMTTF;
publicstringComponentName;
publicstringNarrative;
publicstringPartNumber;
publicstringTestName;
publicstringTestNarrative;
publicstringTestLevel;
publicstringTestTime;
publicstringIsSymptom;
publicstringTestLabel;
}
表9ConvertCsv2Xml类的数据成员设计
类名
数据
作用及类型定义
ConvertCsv2Xml
CsvFilePath
CSV文件路径（string）
TeamsInfo
TEAMS元素数据（TeamsEntry）
LegacyInfo
CSV表格元素数据（LegacyEntry）
表10ConvertCsv2Xml类的函数成员设计
类名
函数
作用
输入
输出
ConvertCsv2Xml
ReadCSV
打开CSV表格文件并识别为一个模型
CSV文件路径
CSV表格元素数据
ConvertCsv
打开CSV表格文件并转换为TEAMS模型
CSV文件路径
TEAMS元素数据
ConvertCsvXml
打开CSV表格文件并转存为XML格式的模型文件
CSV文件路径
XML文件路径
UpdateCsv
将修改后的模型数据保存为CSV表格文件
CSV表格元素数据
CSV文件路径
UpdateCsvXml
将修改后的模型数据保存为XML格式的模型文件
CSV表格元素数据
XML文件路径
综合报告表格转换类ConvertCsv2Xml的接口信息交换关系见表11。
表11ConvertCsv2Xml类的接口信息交换关系
序号
名称
信息内容
信息流动
来源
目的
1
综合报告表格转换与定制文件解析单元的接口
CSV表格文件
CSV文件
信息输入
2
综合报告表格转换与TEAMS-Designer的接口
XML模型文件
XML文件生成
信息输出
3.3模型中模块查询软件
3.3.1功能概述
模型中模块查询软件提供模型中模块信息查询，模块层次位置查询。
并可以树型结构对查询结构进行显示。
3.3.2用户界面设计
用户可以根据输入在不同的选择类型中进行模型中模块的查询任务，在左侧会显示模型的树型结构，在查询的结果中选择一个确定的模块，能够显示此模块在树型图中的位置和此模块的相信信息。
图10TEAMS模型自动生成与批量修改软件的批量修改模块名称和批量添加测试点
3.3.3程序逻辑结构
图11TEAMs模型中模块查询软件结构
模型接口文件解析模块的设计说明见表13。
表12程序设计说明表
模块名称
模型中模块查询软件
性能要求
能够将与输入条件相关的模块名称全部显示在窗体中
限制条件
必须导入模型
输入
TEAMS模型和查询条件
输出
显示导入模型中所有符合查询条件的模块名称和导入模型的模型树
算法逻辑
导入事先建立好的TEAMs模型，根据输入条件进行查询
备注
无
3.3.4类和方法列表
类设计说明表
类名
属性∕方法
含义∕职责
ParseTeamsModel
ParseTeamsModel
打开一个TEAMS模型文件，并解析这个模型文件
TeamsFilePath
TEAMS模型文件路径（string）
TeamsModelInfo
TEAMS模型数据（TeamsModelEntry）
QueryTeamsModel
GetSubModule
获取子模块信息
GetSubModulePos
搜索模型中子模块分层位置
3.3.5方法详细设计
模型接口文件解析模块的类设计说明见表14
图12模型中模块查询软件的逻辑结构图
3.3.6模型中模块查询软件设计细节
3.3.6.1模型解析类ParseTeamsModel
模型解析类ParseTeamsModel用于完成对TEAMS测试性模型的解析与提取，该类设计的目的在于明确模型解析的实现接口、所含数据成员，与其他软件模块的接口关系，以及对类的操作。
模型解析类ParseTeamsModel的主要设计任务，是在TEAMS中建立系统的模型之后，对模型文件内容进行解析，提取为相应的数据结构变量。
模型解析类ParseTeamsModel的基本关系如图8所示。
图13模型解析类关系图
模型解析类ParseTeamsModel的数据成员设计见表15，函数成员设计见表16。
其中，结构体数据类型TeamsModelEntry分别定义如下：
publicstructTeamsModelEntry
{
publicstringFailureModeName;
publicdoubleFailureModeMTTF;
publicstringSubModuleName;
publicstringSubModuleNarrative;
publicstringSubModulePartNumber;
publicstringTestName;
publicstringTestNarrative;
publicstringTestLevel;
publicstringTestTime;
publicstringTestIsSymptom;
publicstringTestLabelName;
}
表1ParseTeamsModel类的数据成员设计
类名
数据
作用及类型定义
ParseTeamsModel
TeamsFilePath
TEAMS模型文件路径（string）
TeamsModelInfo
TEAMS模型数据（TeamsModelEntry）
表2ParseTeamsModel类的函数成员设计
类名
函数
作用
输入
输出
ParseTeamsModel
ReadTeamsModel
打开TEAMS模型文件并识别为一个模型
TEAMS模型文件路径
TEAMS模型数据
模型解析类ParseTeamsModel的接口信息交换关系见表17。
表3ParseTeamsModel类的接口信息交换关系
序号
名称
信息内容
信息流动
来源
目的
1
模型解析与TEAMS-Designer的接口
TEAMS模型
TEAMS模型文件
信息输入
2
模型解析与模型查询与显示单元的借口
模型数据结构
模型数据变量生成
信息输出
3.3.6.2模型查询与显示类QueryTeamsModel
模型查询与显示类QueryTeamsModel用于完成对TEAMS测试性模型的查询及显示，该类设计的目的在于明确模型查询与显示的实现接口、所含数据成员，与其他软件模块的接口关系，以及对类的操作。
模型查询与显示类QueryTeamsModel的主要设计任务，是能够对某一子模块进行查询，得到该子模块在整个系统模型中的层次位置。
模型查询与显示类QueryTeamsModel的基本关系如图9所示。
图14模型查询与显示类关系图
模型查询与显示类QueryTeamsModel的数据成员设计见表18，函数成员设计见表19。
表4QueryTeamsModel类的数据成员设计
类名
数据
作用及类型定义
QueryTeamsModel
TeamsModelInfo
TEAMS模型数据（TeamsModelEntry）
SubModule
待查询子模块名称（string）
PositionInfo
子模块各层信息（string[]）
表5QueryTeamsModel类的函数成员设计
类名
函数
作用
输入
输出
QueryTeamsModel
GetSubModule
获取子模块信息
TEAMS模型数据
子模块名称
子模块数据
GetSubModulePos
搜索模型中子模块分层位置
TEAMS模型数据
子模块名称
子模块层次关系
模型查询与显示类QueryTeamsModel的接口信息交换关系见表20。
表6QueryTeamsModel类的接口信息交换关系
序号
名称
信息内容
信息流动
来源
目的
1
模型查询与显示与模型解析单元的接口
模型数据结构
TEAMS模型
信息输入
3.4测试分析结果格式化输出软件
3.4.1
升级会员 