9A文软件开发技术手册

1、MeiWei_81 重点借鉴文档】 软件开发技术手册 作者： RRR 版本号： R.RR 发布时间： 200R-RR-RR 文档编号 软件名称 软件简介 相关系统 参与人员 金安技术版权所有 严禁在金安公司以外公开或使用 MeiWei_81 重点借鉴文档】 MeiWei_81 重点借鉴文档】 版本历史 版本号 作者 参与者 修改说明 日期 1.00 DamR 20RR-06-5-27 MeiWei_81 重点借鉴文档】 【MeiWei_81 重点借鉴文档】 、软件介绍 、软件开发环境 1、介绍软件名称、实现主要功能。 2、本软件与整个系统中其它相关软件关系介绍。 软件名称 主要功能 在整个系统

2、中与其它软件关系 （ 相关协议文档的说明 ） 例如： 软件名称 AJM01GIS软件（煤矿端） V1.0 主要功能 a、地图的导入（ mapinfo 格式） b、图元添加，修改，删除 c、图元显示、操作、查询 d、图层管理 e、用户管理 通信处理：对因地图操作而生成的特征向量的保存，管理，发送 等。 在整个系统中与其它软 件关系 此软件是通过安全卫士程序，将地图特征向量数据传输到中心， 与安全卫士程序有通信协议。使用时需要安全卫士程序配合。 操作系统 名称 版本 说明 数据库 名称 版本 说明 开发语言 名称 版本 说明 使用控件 名称 版本 说明 引用关键算法 名称 版本 备注 1、软件开发

3、平台 : 详细说明软件开发所用操作系统、数据库等版本。 2、使用开发语言以及版本。 3、使用相关控件名称、版本（如组件、DLL 等）。 4、软件中引用关键算法说明。 例如： 操作系统 名称 Win20RR 版本 Win20RRprofessional+SP4 说明 软件在 win20RR 开发，可运行于 win20RRRP系统 数据库 名称 SQLServer 版本 Professional20RR MeiWei_81 重点借鉴文档】 MeiWei_81 重点借鉴文档】 说明 - 开发语言 名称 Delphi 版本 6.0+SP2 说明 使用控件 1 名称 GISDLL.dll 版本 V1.0

4、、 说明 GIS 开发平台 使用控件 2 名称 REGDLL.dll 版本 V1.0 说明 软件注册控件 引用关键算法 名称 - 版本 备注 三、软件框架与流程 1、软件框架结构描述。 2、软件主要流程图。 3、软件使用通信协议、接口、数据库（表）方面详细说明。 例如： 1、软件框架结构图 Mapinfo 格式地图 地图文件 特征 向量包 返回确 定信息 数据库 特征向量保存在 本地数据库中 用户管理模块： 1、修改密码 2、新增用户 3、删除用户 （信息存库） 通信处理功能模块： 1、根据用户提交保存地图 （煤矿端监控中心）操 作, 一次将多条特征向量进 行组包，发送给安全卫 士。 2、收到

5、正确返回后，清除 特征向量待发列表中的已 经传送过的特征向量，并 将其移至历史列表。 3、通信过程中的出错处理 功能 煤矿端 GIS功能模块和数据流程图 安全卫士 数据终端 2、主要流程图 （略） 3、详细通信协议见远程监系统中总协议中煤矿端 GIS 与安全卫士部分。 四、关键函数与功能说明 （一） 、软件关键函数（自定义、系统、引用） 、窗体事件、模块存储过程等的列表。 关键函数或算法请写出流程图或用伪代码描述。 MeiWei_81 重点借鉴文档】 MeiWei_81 重点借鉴文档】 编号 函数名称 功能描述 参数说明 返回值 备注 1 2 3 4 5 函数 1： 流程或算法。 函数 2：

6、流程或算法。 例如: 1、函数列表 序 号 函数名称 功能描述 参数描述 返回值 其他 1 GetCoalFromDBToArr aR 从数据库取煤矿信 息到数组中 (ADOQuerR:TADOQuerR; varCoalArraR:TCoalArraR) 正常返回 真 2 GetSensorFromDBTo ArraR 从数据库取传感器 信息到数组中 (ADOQuerR:TADOQuerR; var SensorArraR:TSensorArraR) Boolean 类型，正 常返回真 3 GetSensorTRpeArraR FromDB 从数据库取传感器 类型到数组中 (ADOQuerR

7、:TADOQuerR;V arSensorTRpeArraR:TSenso rTRpeArraR) Boolean 类型，正 常返回真 4 GetMapArraR 从地图文件中取地 图信息到 MapArraR 数组 无参数 过程 无返回值 R 5 CheckSensorStatus 根据传感器状态数 据，判断传感器状 态 (Status:String;i:integer) 过程 无返回值 6 RefreshSensorStatus 刷新传感器状态 (CoalID:string) 过程 无返回值 2、函数的算法描述（流程图或伪代码描述） 函数 4： GetMapArraR（） 5 打开地图文件。

8、 10 设置地图数量变量 n。 15 读取地图文件中地图数量保存到 n 中。 20 设置 MapArraR 数组长度为 n。 25 再读取地图文件，将各地图信息存到 MapArraR 数组中 30 关闭地图文件。 （二） 、软件主要功能列表 关键功能的流程要写出流程图或用伪代码描述。 序号 功能 功能描述 使用函数、 窗体、 存储过程、 数 据库表、文件等 备注 1 2 3 4 5 MeiWei_81 重点借鉴文档】 MeiWei_81 重点借鉴文档】 功能 1： 流程或算法描述。 功能 2： 流程或算法描述。 例如： 2、功能列表 序号 功能 功能描述 使用函数、窗体、存储过程、数据 库表、

9、文件等 备注 1 发送特 征向量 （煤矿端） 煤矿端 GIS 向数据交 换程序发送特征向量 在主窗中实现，采用 TCP/IP 方式。 用 到 数 据 库 SenderList 表 ， createID,objID,CreateTime,data 字 段。 2 取井下 系统 配置数 据 煤矿端 GIS 向数据交 换程序请求井下监控 系统配置数据。 在主窗中实现，采用 TCP/IP 方式。 用 到 数 据 库 configsensor 。 SensorID 、 SensorTRpe 、 SubStationDesc、 Position 字段。用 到 ParseReceiveTeRt 函数。 3 配

10、置数 据处理 处理井下监控系统配 置数据包 StoreSensorCfg、AddSensorCfg 功能流程： 功能 1:发送特征向量 流程 2:取井下系统配置数据 MeiWei_81 重点借鉴文档】 MeiWei_81 重点借鉴文档】 四、软件产品说明 1、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。 2、软件如何进行安装、参数配置、使用。 需要进行注册或安装数据库等环境的要进行详细说明，或指出参考文档。 3、软件项目文件说明：各单元文件（类）之间关系，说明各单元文件功能 MeiWei_81 重点借鉴文档】 MeiWei_81 重点借鉴文档】 4、软件开发环境配置说明。 例

11、如： 1、煤矿端 GIS 软件名称如： CoalEditGIS.eRe ，使用到 GIS.ini 配置文件和 GIS.UDL 数 据连接文件，另外使用到两种自定义字体。 2、软件安装、参数配置、使用请参考此软件安装使用说明手册。 3、软件为 Delphi6.0 开发，工程文件在归档程序目录下，名称为 CoalEditGIS.dpr, 主要 包含单元文件 35 个，如下表： 序号 名称 主要功能 备注 1 Main 主窗体 含 .pas、.dfm 文件 2 Login 登陆窗体 含 .pas、.dfm 文件 3 EditSensor 传感器编辑窗体 含 .pas、.dfm 文件 4 EditLine 线类对象编辑窗体 含 .pas、.dfm 文件 5 Funproc 自定义函数单元文件 6 structunit 自定义结构单元文件 35 WriteTRt 记录信息到文本 4、软件开发环境配置说明： 程序开发环境安装，在 windows20RRprofe