详细说明书.docx
《详细说明书.docx》由会员分享，可在线阅读，更多相关《详细说明书.docx（16页珍藏版）》请在冰豆网上搜索。
详细说明书
砂处理智能单元详细说明书
智能工厂及产业应用中心
文档属性
文件名
文档编号
状态
砂处理智能详细设计说明书
0.1
更改历史
日期
更改人
版本
描述
2016-05-20
周正学
0.1
初稿
批准人
审批人
审批日期
审批意见
目录
1概述4
1.1编写目的4
1.2背景4
1.3参考资料4
1.4术语定义及说明5
2设计概述5
2.1需求概述5
2.2运行环境概述5
2.3条件与限制6
2.4详细设计方法和工具6
3系统详细设计需求分析7
3.2接口需求分析8
4总体方案设计8
4.1系统结构设计8
4.2系统功能模块详细设计9
4.3系统界面详细设计11
5数据库系统设计12
5.1设计要求12
5.2信息模型设计12
6.3数据表设计13
6编码14
6.1包设计14
6.2用户界面字符14
7非功能性设计14
7.1配置管理15
7.2错误处理15
1、概述
1.1编写目的
本文旨在描述公司智能工厂砂处理智能单元各功能模块的内部实现细节，重点包括算法和详细数据结构，为软件编码实现提供必要的说明，同时为软件测试、软件操作提供理论基础。
1.2背景
1.3参考资料
《砂处理智能单元软件策划方案.xlsx》
《GB8566-88-计算机软件开发规范》
《GB8567088-计算机软件产品开发文件编制指南》
《GB9385-88-计算机需求说明编制指南》
1.4术语定义及说明
序号
术语
说明
1
智能工厂
2
砂处理
3
ESB
4
WebServices
5
经营体
2、设计概述
2.1需求概述
通过本项目自主开发适用于南车共享智能铸造工厂砂处理智能单元模块，实现现场设备的数字化管理，生产过程中的高度自动化控制。
并依托该软件提高现场工作人员的流程化作业，并从铸件各子过程逐步替代目前的生产方式，为智能工程整体解决方案打下坚实基础。
2.2运行环境概述
该软件采用SOA架构，所有数据采用WebServices方式进行发布，并由客户端软件进行数据接收并展示。
运行环境分为客户端、应用服务器和数据库服务器三个部分。
具体要求见下表：
名称
详细要求
客户端
操作系统：
Windows7或更新版本
.NetFramework：
4.5
硬件：
HPZ220或同等型号以上
应用服务器
操作系统：
WindowsServer2003或更新版本
MS：
.NetFramework：
4.5
Java环境：
JDK6或更新版本
硬件：
IBM3650或同等型号以上虚拟主机
数据库服务器
操作系统：
WindowsServer2003或Solaris10
数据库系统：
SQLServerxx或更新版本
硬件：
IBM3650或同等型号以上虚拟主机
2.3条件与限制
软件设计的约束以及有关说明如下所示：
开发环境：
.NetFramework4.5,JDK8.0,VisualSVN,TeamFoundationServer,IIS7.0,Tomcat7.0
编程环境：
VisualStudio2013/2015,EclipseKepler
数据库：
SQLServer2008，创建独立的数据库实例以及独立的数据库连接账号
遵循的规范：
软件的设计和开发过程需要严格按照软件的设计方案来进行，软件开发过程应遵循软件工程规范，对过程和版本进行管理和控制。
测试环境：
南车共享智能工厂现场车间
软件交付形式：
以B/S架构部署在服务器，并发放集成客户端安装包文件
开发期限：
2016年06月30日完成
2.4详细设计方法和工具
设计过程中用到的工具及方法如下所示:
●HIPO图：
用来表示软件功能模块的输入-处理-输出内容及处理逻辑
●E-R图：
用来表示实体对象关系图
●文字处理工具：
MSOffice2013
●基本绘图工具：
MSVisio2013
●UML绘图工具：
RationalRose2007
●数据库绘图操作工具：
PowerDesigner16，SQLServer2014ManagementStudio，NavicatforSQLServer
3、系统详细设计需求分析
3.1详细需求分析
3．1对功能的规定
本软件为智能工厂其中一个模块，主要通过采集现场硬件数据、接收ERP、MES系统数据，集成铸造过程中标准库、专家库，面向现场工人并辅助其更好的完成现场生产工作。
包括以下几个方面的内容：
●集成参考资料中所列出的相关标准、知识库
●发布现在生产计划
●现场设备运行状态监控及维护
●现场经营体核算功能
●生产作业指导书、工艺手册、公司公告的发布
3．2对性能的规定
3．2．1精度
说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。
3．2．2时间特性要求
说明对于该软件的时间特性要求，如对：
a．响应时间；
b．更新处理时间；
c．数据的转换和传送时间；
d．解题时间；等的要求。
3．2．3灵活性
所有数据处理过程应处在服务层，说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：
a．预留浏览器、手持设备客户端数据接口；
b．采用软PLC数据采集接口、适应多种硬件设备的数据采集；
c．同其他软件的接口的变化；
d．精度和有效时限的变化；
e．计划的变化或改进。
3．2．4输入输出要求
解释各输入输出数据类型，并逐项说明其媒体、格式、数值范围、精度等。
对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。
3．2．5数据管理能力要求
说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。
3．2．6其他要求
对于重要信息推送，比如设备报警信息，需要有醒目的提示界面。
比如弹出、桌面气球等。
3.2接口需求分析
3.2.1 外部接口
外部接口的用户界面部分按Windows应用软件用户界面的规范来设计，界面设计风格与环境保持一致，采用SmartGWTEnterpriseGray风格，采用下拉菜单，对话框，以及按钮等方式作为用户界面，便于用户使用。
3.2.2软件接口
硬件数据通信接口
ERP，MES数据通信接口
3.2.3 硬件接口
现场硬件：
PLC，温度控制器
倍福软PLC
4、总体方案设计
4.1系统结构设计
由于该系统为公司规划平台的一个子系统，图示显示
图4.1平台构成关系
4.2系统功能模块详细设计
表中显示此次项目过程中需要进行开发的功能细分为如下几个模块
软件名称
模块编号
模块名称
模块描述
01
生产计划
02
过程控制
03
经营体核算
04
设备管理
05
报警查看
06
统计报表
07
公告
08
软件设置
表5.1砂处理智能单元功能模块
以下是具体功能模块的IPO（Input-Processing-Output）表示：
功能编号
02
功能名称
生产计划
所属
功能描述
生产计划
输入项
无
流程/算法
无
处理描述
自动推送MES系统中当天生产计划
输出项目
在客户端显示当天计划
功能编号
03
功能名称
过程控制
所属
功能描述
通过采集现在硬件参数，包括质量参数、绿色参数、设备参数，并对这些参数与专家库中的理论值进行比较分析。
并对分析结果进行反馈。
输入项
1、现场硬件采集参数，参见《砂处理智能单元软件策划方案.xlsx》
2、MES系统专家库
处理描述
输出项目
对车间现场业务运行状态进行监控，如发生异常，及时发送邮件或手机短信到相应责任人
功能编号
04
功能名称
经营体核算
所属
功能描述
通过用户输入温度、相对温度、舱室容积、舱壁面积等设计参数计算生成计算结果
输入项
输入温度、相对温度、舱室容积、舱壁面积等设计参数
处理描述
该模块计算处理过程较为复杂，具体算法可参考ISO7547（居住舱室）、ISO8862（ECR）、ISO9099（DryProvisionRoom）GB-13409相关内容，在这里就不再赘述。
输出项目
生成舱室通风条件计算结果
功能编号
05
功能名称
设备管理
所属
功能描述
通过该模块后台采集PLC设备运行数据，对设备运行状态进行监控、预警、故障处理，通过引自MES设备、仪器保养计划、润滑计划。
让现场工作人员对设备监控、保养、维修各环节有一个方便快捷的用户界面。
输入项
1、PLC数据采集（目前该输入项对于软件开发工作过于笼统，需进一步讨论）
2、通过MES系统引用设备、仪器保养计划、润滑计划。
3、MES工艺知识库、设备故障专家库
流程
处理描述
输出项目
提供设备运行状态实时动态图、提供设备故障清单、提供设备保养、润滑计划清单、提供设备报修流程化操作用户界面
功能编号
06
功能名称
报警查看
所属
功能描述
1、通过监控PLC采集设备运行状态数据，并将数据与来自MES系统的设备故障知识库、工艺专家库等进行对比分析，并将当天分析结果显示与默认界面。
2、根据不同的报警级别采取相应的处理措施，详细见算法描述
3、用户可根据多种报警属性进行查询历史数据
输入项
PLC数据采集，MES系统支持库文件，用户查询过滤条件
算法
报警处理流程：
处理描述
根据计算结果智能匹配相应空调类型
输出项目
报警记录及处理方式
功能编号
06
功能名称
报表统计
所属
功能描述
为用户提供有较强的数据统计分析报表功能，包括生产计划清单及详细条目、工艺参数、成本统计、设备管理，并提供统计表格及各种统计图示（条形图、饼状图等）
输入项
各数据时间属性参数，起始时间-终止时间（精确到天）
流程/算法
无
处理描述
通过用户给定过滤统计条件，提供数据查询，展示
输出项目
各类数据统计表格及图示
功能编号
07
功能名称
公告栏
所属
功能描述
为现在工作人员提供工艺操作手册，作业指导书在线浏览和下载功能，提供培训计划、公司新闻公告等
输入项
无
流程/算法
无
处理描述
新闻公告、工艺操作手册、作业指导书在线浏览和下载功能引自公司内部网络资源URL并在网络浏览器控件显示，培训计划和三项素质
输出项目
新闻公告、工艺操作手册、作业指导书在线浏览和下载，培训计划和三项素质计划查看
功能编号
07
功能名称
软件设置
所属
功能描述
该模块为软件使用辅助功能，提供常用参数设置保存功能
输入项
暂无（需要用户自定义的参数，需要进一步沟通）
流程/算法
无
处理描述
将用户设置参数和用户登录标识进行绑定保存，保证每个用户根据自己的个人喜好进行参数设置
输出项目
无
4.3系统界面详细设计
外部界面设计
内部界面设计
用户界面设计
5、数据库系统设计
5.1设计要求
5.2信息模型设计
关键信息模型E-R（EntityRelationshipDiagram）图如下所示（由于篇幅原因，部分属性值略，详细请参考数据库表关系图）
关键信息模型E-R示意图
5.3数据表设计
打箱计划
列名
数据类型
主键
外键
是否为空
注释
序号
Int
Y
不能为空
砂箱号
Int
铸件名称
Varchar
铸件号
Varchar
托盘号
Varchar
重量
Double
砂铁比
Double
砂量
Double
设备故障
列名
数据类型
主键
外键
是否为空
注释
序号
Int
Y
不能为空
日期
Date
时间
Date
设备名称
Varchar
故障描述
Varchar
故障级别
Varchar
处理方法
Varchar
是否保修
Boolean
质量参数
列名
数据类型
主键
外键
是否为空
注释
序号
Int
Y
不能为空
日期
Date
时间
Date
设备名称
Varchar
质量参数
Varchar
标准值
？
？
实际值
？
？
是否正常
Boolean
异常原因
Varchar
6、软件编码
6.1包设计
6.2接口设计
●生产计划
getPlanDataSet
获得砂处理生产计划DataSet
输入参数：
无；返回数据：
DataSet
getPlanDataSetByPeroid
获取一定时间段内的砂处理生产计划DataSet
输入参数：
起始日期，终止日期；返回数据：
DataSet
6.2用户界面字符
全部通过RESX文件进行配置
7、非功能性设计
7.1配置管理
由于该项目采用增量开发模型，考虑到后续系统的可靠性及通用性，对于需求不明确的环境采用配置管理的方式进行，另外考虑到用户使用的便利性，将用户常用参数，输入信息通过内部界面进行配置管理。
设置选项有：
用户自定义界面数据刷新时间间隔
设备报警发送邮件地址及手机号码
7.2错误处理
软件运行状态需要有日志文件进行记录，对于常见错误需要有必要的用户界面进行提示：
序号
故障描述
故障级别
故障处理办法
1
非法的用户名
一般
对用户进行提醒
2
无效的字段
一般
对用户进行提醒
3
客户端网络不通畅
一般
对用户进行提醒并将故障信息写入日志文件
4
客户端界面加载过慢，出现“假死”现象
严重
给用户界面提示信息并写入日志文件
5
客户端界面奔溃
严重
写入日志文件
6
计算中断
严重
写入日志文件
升级会员 