详细说明书.docx

1、详细说明书砂处理智能单元详细说明书智能工厂及产业应用中心文档属性文件名文档编号状态砂处理智能详细设计说明书0.1更改历史日期更改人版本描述2016-05-20周正学0.1初稿批准人审批人审批日期审批意见目录1概述 41.1编写目的 41.2背景 41.3参考资料 41.4术语定义及说明 52设计概述 52.1需求概述 52.2运行环境概述 52.3条件与限制 62.4详细设计方法和工具 63系统详细设计需求分析 73.2接口需求分析 84总体方案设计 84.1系统结构设计 84.2系统功能模块详细设计 94.3系统界面详细设计 115数据库系统设计 125.1设计要求 125.2信息模型设计

2、126.3数据表设计 136编码 146.1包设计 146.2用户界面字符 147非功能性设计 147.1配置管理 157.2错误处理 151、概述1.1编写目的本文旨在描述公司智能工厂砂处理智能单元各功能模块的内部实现细节，重点包括算法和详细数据结构，为软件编码实现提供必要的说明，同时为软件测试、软件操作提供理论基础。1.2背景1.3参考资料砂处理智能单元软件策划方案.xlsxGB8566-88-计算机软件开发规范GB8567088-计算机软件产品开发文件编制指南GB9385-88-计算机需求说明编制指南1.4术语定义及说明序号术语说明1智能工厂2砂处理3ESB4Web Services5经

3、营体2、设计概述2.1需求概述通过本项目自主开发适用于南车共享智能铸造工厂砂处理智能单元模块，实现现场设备的数字化管理，生产过程中的高度自动化控制。并依托该软件提高现场工作人员的流程化作业，并从铸件各子过程逐步替代目前的生产方式，为智能工程整体解决方案打下坚实基础。2.2运行环境概述该软件采用SOA架构，所有数据采用Web Services方式进行发布，并由客户端软件进行数据接收并展示。运行环境分为客户端、应用服务器和数据库服务器三个部分。具体要求见下表：名称详细要求客户端操作系统：Windows 7或更新版本.Net Framework：4.5硬件：HPZ220或同等型号以上应用服务器操作系

4、统：Windows Server 2003或更新版本MS：.Net Framework：4.5Java环境：JDK6或更新版本硬件：IBM3650或同等型号以上虚拟主机数据库服务器操作系统：Windows Server 2003或Solaris10数据库系统：SQL Serverxx或更新版本硬件：IBM3650或同等型号以上虚拟主机2.3条件与限制软件设计的约束以及有关说明如下所示：开发环境：.Net Framework 4.5,JDK8.0, Visual SVN, Team Foundation Server, IIS 7.0, Tomcat 7.0编程环境：Visual Studio

5、2013/2015, Eclipse Kepler 数据库：SQL Server 2008，创建独立的数据库实例以及独立的数据库连接账号遵循的规范：软件的设计和开发过程需要严格按照软件的设计方案来进行，软件开发过程应遵循软件工程规范，对过程和版本进行管理和控制。测试环境：南车共享智能工厂现场车间软件交付形式：以B/S架构部署在服务器，并发放集成客户端安装包文件开发期限：2016年06月30日完成2.4详细设计方法和工具设计过程中用到的工具及方法如下所示: HIPO图：用来表示软件功能模块的输入-处理-输出内容及处理逻辑 E-R图：用来表示实体对象关系图 文字处理工具：MS Office2013

6、 基本绘图工具：MS Visio 2013 UML绘图工具：Rational Rose2007 数据库绘图操作工具：PowerDesigner16，SQL Server 2014 Management Studio，Navicat for SQL Server3、系统详细设计需求分析3.1详细需求分析31对功能的规定本软件为智能工厂其中一个模块，主要通过采集现场硬件数据、接收ERP、MES系统数据，集成铸造过程中标准库、专家库，面向现场工人并辅助其更好的完成现场生产工作。包括以下几个方面的内容： 集成参考资料中所列出的相关标准、知识库 发布现在生产计划 现场设备运行状态监控及维护 现场经营体核

7、算功能 生产作业指导书、工艺手册、公司公告的发布32对性能的规定321精度说明对该软件的输入、输出数据精度的要求，可能包括传输过程中的精度。322时间特性要求说明对于该软件的时间特性要求，如对：a响应时间；b更新处理时间；c数据的转换和传送时间；d解题时间；等的要求。323灵活性所有数据处理过程应处在服务层，说明对该软件的灵活性的要求，即当需求发生某些变化时，该软件对这些变化的适应能力，如：a预留浏览器、手持设备客户端数据接口；b采用软PLC数据采集接口、适应多种硬件设备的数据采集；c同其他软件的接口的变化；d精度和有效时限的变化；e计划的变化或改进。324输入输出要求解释各输入输出数据类型，

8、并逐项说明其媒体、格式、数值范围、精度等。对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。325数据管理能力要求说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。326其他要求对于重要信息推送，比如设备报警信息，需要有醒目的提示界面。比如弹出、桌面气球等。3.2接口需求分析3.2.1外部接口外部接口的用户界面部分按Windows应用软件用户界面的规范来设计，界面设计风格与环境保持一致，采用Smart GWT Enterprise Gray风格，采用下拉菜单，对

9、话框，以及按钮等方式作为用户界面，便于用户使用。3.2.2软件接口硬件数据通信接口ERP，MES数据通信接口3.2.3硬件接口现场硬件：PLC，温度控制器倍福软PLC4、总体方案设计4.1系统结构设计由于该系统为公司规划平台的一个子系统，图示显示图4.1平台构成关系4.2系统功能模块详细设计表中显示此次项目过程中需要进行开发的功能细分为如下几个模块软件名称模块编号模块名称模块描述01生产计划02过程控制03经营体核算04设备管理05报警查看06统计报表07公告08软件设置表5.1砂处理智能单元功能模块以下是具体功能模块的IPO（Input-Processing-Output）表示：功能编号02

10、功能名称生产计划所属功能描述生产计划输入项无流程/算法无处理描述自动推送MES系统中当天生产计划输出项目在客户端显示当天计划功能编号03功能名称过程控制所属功能描述通过采集现在硬件参数，包括质量参数、绿色参数、设备参数，并对这些参数与专家库中的理论值进行比较分析。并对分析结果进行反馈。输入项1、现场硬件采集参数，参见砂处理智能单元软件策划方案.xlsx2、MES系统专家库处理描述输出项目对车间现场业务运行状态进行监控，如发生异常，及时发送邮件或手机短信到相应责任人功能编号04功能名称经营体核算所属功能描述通过用户输入温度、相对温度、舱室容积、舱壁面积等设计参数计算生成计算结果输入项输入温度、相

11、对温度、舱室容积、舱壁面积等设计参数处理描述该模块计算处理过程较为复杂，具体算法可参考ISO 7547（居住舱室）、ISO 8862（ECR）、ISO 9099（Dry Provision Room）GB-13409相关内容，在这里就不再赘述。输出项目生成舱室通风条件计算结果功能编号05功能名称设备管理所属功能描述通过该模块后台采集PLC设备运行数据，对设备运行状态进行监控、预警、故障处理，通过引自MES设备、仪器保养计划、润滑计划。让现场工作人员对设备监控、保养、维修各环节有一个方便快捷的用户界面。输入项1、PLC数据采集（目前该输入项对于软件开发工作过于笼统，需进一步讨论）2、通过MES系

12、统引用设备、仪器保养计划、润滑计划。3、MES工艺知识库、设备故障专家库流程处理描述输出项目提供设备运行状态实时动态图、提供设备故障清单、提供设备保养、润滑计划清单、提供设备报修流程化操作用户界面功能编号06功能名称报警查看所属功能描述1、 通过监控PLC采集设备运行状态数据，并将数据与来自MES系统的设备故障知识库、工艺专家库等进行对比分析，并将当天分析结果显示与默认界面。2、 根据不同的报警级别采取相应的处理措施，详细见算法描述3、 用户可根据多种报警属性进行查询历史数据输入项PLC数据采集，MES系统支持库文件，用户查询过滤条件算法报警处理流程：处理描述根据计算结果智能匹配相应空调类型输

13、出项目报警记录及处理方式功能编号06功能名称报表统计所属功能描述为用户提供有较强的数据统计分析报表功能，包括生产计划清单及详细条目、工艺参数、成本统计、设备管理，并提供统计表格及各种统计图示（条形图、饼状图等）输入项各数据时间属性参数，起始时间-终止时间（精确到天）流程/算法无处理描述通过用户给定过滤统计条件，提供数据查询，展示输出项目各类数据统计表格及图示功能编号07功能名称公告栏所属功能描述为现在工作人员提供工艺操作手册，作业指导书在线浏览和下载功能，提供培训计划、公司新闻公告等输入项无流程/算法无处理描述新闻公告、工艺操作手册、作业指导书在线浏览和下载功能引自公司内部网络资源URL并在网

14、络浏览器控件显示，培训计划和三项素质输出项目新闻公告、工艺操作手册、作业指导书在线浏览和下载，培训计划和三项素质计划查看功能编号07功能名称软件设置所属功能描述该模块为软件使用辅助功能，提供常用参数设置保存功能输入项暂无（需要用户自定义的参数，需要进一步沟通）流程/算法无处理描述将用户设置参数和用户登录标识进行绑定保存，保证每个用户根据自己的个人喜好进行参数设置输出项目无4.3系统界面详细设计外部界面设计内部界面设计用户界面设计5、数据库系统设计5.1设计要求5.2信息模型设计关键信息模型E-R（Entity Relationship Diagram）图如下所示（由于篇幅原因，部分属性值略，详

15、细请参考数据库表关系图）关键信息模型E-R示意图5.3数据表设计打箱计划列名数据类型主键外键是否为空注释序号IntY不能为空砂箱号Int铸件名称Varchar铸件号Varchar托盘号Varchar重量Double砂铁比Double砂量Double设备故障列名数据类型主键外键是否为空注释序号IntY不能为空日期Date时间Date设备名称Varchar故障描述Varchar故障级别Varchar处理方法Varchar是否保修Boolean质量参数列名数据类型主键外键是否为空注释序号IntY不能为空日期Date时间Date设备名称Varchar质量参数Varchar标准值？实际值？是否正常Boo

16、lean异常原因Varchar6、软件编码6.1包设计6.2接口设计 生产计划getPlanDataSet获得砂处理生产计划DataSet输入参数：无；返回数据：DataSetgetPlanDataSetByPeroid获取一定时间段内的砂处理生产计划DataSet输入参数：起始日期，终止日期；返回数据：DataSet6.2用户界面字符全部通过RESX文件进行配置7、非功能性设计7.1配置管理由于该项目采用增量开发模型，考虑到后续系统的可靠性及通用性，对于需求不明确的环境采用配置管理的方式进行，另外考虑到用户使用的便利性，将用户常用参数，输入信息通过内部界面进行配置管理。设置选项有：用户自定义界面数据刷新时间间隔设备报警发送邮件地址及手机号码7.2错误处理软件运行状态需要有日志文件进行记录，对于常见错误需要有必要的用户界面进行提示：序号故障描述故障级别故障处理办法1非法的用户名一般对用户进行提醒2无效的字段一般对用户进行提醒3客户端网络不通畅一般对用户进行提醒并将故障信息写入日志文件4客户端界面加载过慢，出现“假死”现象严重给用户界面提示信息并写入日志文件5客户端界面奔溃严重写入日志文件6计算中断严重写入日志文件