1、金安技术GoldSafety第 1 页 / 共 10 页 开发技术手册软件开发技术手册作者： XXX版本号： x.xx发布时间： 200x-xx-xx文档编号软件名称软件简介相关系统参与人员金安技术版权所有金安技术GoldSafety第 2 页 / 共 10 页 开发技术手册严禁在金安公司以外公开或使用 !金安技术GoldSafety第 3 页 / 共 10 页 开发技术手册版本历史版本号 作者 参与者 修改说明 日期1.00 Damy 2004-06-5-27金安技术GoldSafety第 4 页 / 共 10 页 开发技术手册一、软件介绍1、介绍软件名称、实现主要功能。2、本软件与整个系统
2、中其它相关软件关系介绍。软件名称主要功能在整个系统中与其它软件关系(相关协议文档的说明)例如：软件名称 AJ M01 GIS 软件（ 煤矿端） V1.0主要功能 a、地图的导入（ mapinfo 格式）b、图元添加，修改，删除c、图元显示、操作、查询d、图层管理e、用户管理通信处理：对因地图操作而生成的特征向量的保存，管理，发送等。在整个系统中与其它软件关系此软件是通过安全卫士程序，将地图特征向量数据传输到中心，与安全卫士程序有通信协议。使用时需要安全卫士程序配合。二、软件开发环境名称版本操作系统说明名称版本数据库说明名称版本开发语言说明名称版本使用控件说明引用关键算法 名称版本备注金安技术G
3、oldSafety第 5 页 / 共 10 页 开发技术手册1、软件开发平台: 详细说明软件开发所用操作系统、数据库等版本。2、使用开发语言以及版本。3、使用相关控件名称、版本（如组件、DLL 等） 。4、软件中引用关键算法说明。例如：名称 Win2000版本 Win2000 professional+SP4 操作系统说明 软件在 win2000 开发，可运行于 win2000XP 系统名称 SQL Server版本 Professional 2000数据库说明 -名称 Delphi版本 6.0+SP2开发语言说明名称 GISDLL.dll版本 V1.0、使用控件 1说明 GIS 开发平台名称
4、 REGDLL.dll版本 V1.0使用控件 2说明 软件注册控件引用关键算法 名称 -版本备注 三、软件框架与流程1、软件框架结构描述。2、软件主要流程图。3、软件使用通信协议、接口、数据库（表）方面详细说明。例如：1、软件框架结构图金安技术GoldSafety第 6 页 / 共 10 页 开发技术手册地 图 数 据 转 入 功 能 模 块 ：1 、 将 M a p i n f o 格式地图导入到 G I S 自己格式文件中 ， 同时将图中对象相关的其属性存放到本地数据库中 。（ 煤矿地图要严格按照地图制作规范进行绘制 ， 同一煤矿只生产一个图 ， 每一层导入到该图的相应图层 ）2 、 生产
5、自己格式的地图文件 ， 供程序调用 。地 图 显 示 、 操 作 、 查 询 功 能 模 块 ：1 、 显示全图 、 地图放大 、 缩小 、 移动 、 选择等 ；2 、 分层显示的功能 ， 用户可选择显示 / 隐藏相关图层 。3 、 各图层对象查找功能 （ 主要是巷道层 、 工作面层 、 传感器层 、 分站层 ）， 并闪烁提示用户 。地 图 编 辑 、 修 改 功 能 模 块 （ 设 定 用 户 权 限 ） ：1 、 可对地图中的点 、 线 、 面三大类对象进行位置 、 属性 、 节点进行编辑 、 修改 ， 并保存到本地地图文件和数据库中 。2 、 在地图上可增加点 、 线 、 面三类对象及对
6、象属性数据 ， 保存到本地地图文件和数据库中 。3 、 对上面的编辑 、 修改每一个对象产生的相关数据生成一条特征向量 ， 保存到特征向量文件中 ， 供通信模块调用 。通 信 处 理 功 能 模 块 ：1 、 根据用户提交保存地图（ 煤矿端 监控中心 ） 操作 , 一次将多条特征向量进行组包 ， 发送给安全卫士 。2 、 收到正确返回后 ， 清除特征向量待发列表中的已经传送过的特征向量 ， 并将其移至历史列表 。3 、 通信过程中的出错处理功能M a p i n f o格式地图地图文件特征向量保存在本地数据库中数据库安全卫士数据终端返回确定信息特征向量包煤矿端 G I S 功能模块和数据流程图
7、用 户 管 理 模 块 ：1 、 修改密码2 、 新增用户3 、 删除用户（ 信息存库 ）2、主要流程图（略）3、详细通信协议见远程监系统中总协议中煤矿端 GIS 与安全卫士部分。四、关键函数与功能说明(一)、软件关键函数（自定义、系统、引用） 、窗体事件、模块存储过程等的列表。关键函数或算法请写出流程图或用伪代码描述。编号 函数名称 功能描述 参数说明 返回值 备注12345函数 1：流程或算法。函数 2：流程或算法。金安技术GoldSafety第 7 页 / 共 10 页 开发技术手册例如 :1、函数列表序号 函数名称 功能描述 参数描述 返回值 其他1 GetCoalFromDBToAr
8、ray 从数据库取煤矿信息到数组中 (ADOQuery: TADOQuery; var CoalArray: TCoalArray) 正常返回真2 GetSensorFromDBToArray从数据库取传感器信息到数组中(ADOQuery: TADOQuery;var SensorArray: TSensorArray)Boolean类型，正常返回真3 GetSensorTypeArrayFromDB从数据库取传感器类型到数组中(ADOQuery: TADOQuery; Var SensorTypeArray: TSensorTypeArray)Boolean类型，正常返回真4 GetMapA
9、rray从地图文件中取地图信息到MapArray 数组无参数 过程无返回值 *5 CheckSensorStatus根据传感器状态数据，判断传感器状态(Status:String;i:integer) 过程无返回值6 RefreshSensorStatus 刷新传感器状态 (CoalID:string) 过程无返回值2、函数的算法描述（流程图或伪代码描述）函数 4： GetMapArray ( ) 5 打开地图文件。10 设置地图数量变量 n。15 读取地图文件中地图数量保存到 n 中。20 设置 MapArray 数组长度为 n。25 再读取地图文件，将各地图信息存到 MapArray 数组
10、中。30 关闭地图文件。(二)、软件主要功能列表关键功能的流程要写出流程图或用伪代码描述。 序号 功能 功能描述 使用函数、窗体、存储过程、 数据库表、文件等 备注12345金安技术GoldSafety第 8 页 / 共 10 页 开发技术手册功能 1：流程或算法描述。功能 2：流程或算法描述。例如：2、功能列表序号 功能 功能描述 使用函数、窗体、存储过程、数据库表、文件等备注1 发送特征向量(煤矿端 )煤矿端 GIS 向数据交换程序发送特征向量在主窗中实现，采用 TCP/IP 方式。用到数据库 SenderList 表，createID,objID,CreateTime,data 字段。2
11、 取井下系统配置数据煤矿端 GIS 向数据交换程序请求井下监控系统配置数据。在主窗中实现，采用 TCP/IP 方式。用到数据库 configsensor。 SensorID、 SensorType、 SubStationDesc、 Position 字段。用到ParseReceiveText 函数。3 配置数据处理处理井下监控系统配置数据包StoreSensorCfg、 AddSensorCfg功能流程： 功能 1: 发送特征向量金安技术GoldSafety第 9 页 / 共 10 页 开发技术手册流程 2: 取井下系统配置数据流程 3: 配置数据处理金安技术GoldSafety第 10 页
12、/ 共 10 页 开发技术手册四、软件产品说明1、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。2、软件如何进行安装、参数配置、使用。需要进行注册或安装数据库等环境的要进行详细说明，或指出参考文档。3、软件项目文件说明：各单元文件（类）之间关系，说明各单元文件功能.4、软件开发环境配置说明。例如：1、煤矿端 GIS 软件名称如： CoalEditGIS.exe，使用到 GIS.ini 配置文件和 GIS.UDL 数据连接文件，另外使用到两种自定义字体。2、软件安装、参数配置、使用请参考此软件安装使用说明手册。3、软件为 Delphi6.0 开发，工程文件在归档程序目录下，名称为
13、 CoalEditGIS.dpr,主要包含单元文件 35 个，如下表：序号 名称 主要功能 备注1 Main 主窗体 含 .pas、 .dfm 文件2 Login 登陆窗体 含 .pas、 .dfm 文件3 EditSensor 传感器编辑窗体 含 .pas、 .dfm 文件4 EditLine 线类对象编辑窗体 含 .pas、 .dfm 文件5 Funproc 自定义函数单元文件6 structunit 自定义结构单元文件. . . 35 WriteTxt 记录信息到文本4、软件开发环境配置说明：程序开发环境安装，在 windows2000 professional 系统下，先安装 Delphi6.0+SP2，再安装 MS SQL server2000,再根据安装手册中数据安装部分，将数据库进行还原，再启动Delphi6.0 打开软件归档目录中工程文件， CoalEditGIS.dpr。五、软件存在缺陷及建议开发人员认为软件在各方面存在缺陷说明，以及建议。略
