软件开发技术手册

1、软件开发技术手册vRRRR软件 作者：RRR 版本号：R.RR 发布时间：200R-RR-RR文档编号软件名称软件简介相关系统参与人员金安技术版权所有严禁在金安公司以外公开或使用版本历史版本号作者参与者修改说明日期1.00DamR20RR-06-5-27、软件介绍、软件开发环境1、介绍软件名称、实现主要功能。2、本软件与整个系统中其它相关软件关系介绍。软件名称主要功能在整个系统中与其它软件关系 （相关协议文档的说明）例如:软件名称AJ M01GIS软件（煤矿端）V1.0主要功能a、地图的导入（mapinfo格式）b图元添加，修改，删除C、图元显示、操作、查询d、图层管理e、用户管理通信处理：对

2、因地图操作而生成的特征向量的保存，管理，发送 等。在整个系统中与其它软 件关系此软件是通过安全卫士程序，将地图特征向量数据传输到中心， 与安全卫士程序有通信协议。使用时需要安全卫士程序配合。操作系统名称:版本说明数据库名称版本说明开发语言:名称版本:说明使用控件名称版本说明引用关键算法:名称版本备注1、软件开发平台：详细说明软件开发所用操作系统、数据库等版本。2、使用开发语言以及版本。3、使用相关控件名称、版本（如组件、 DLL等）。4、软件中引用关键算法说明。 例如：操作系统名称Win 20RR版本Win 20RRprofessio nal+SP4说明软件在win20RR开发，可运行于 wi

3、n20RRRP系统数据库名称SQLServer版本Professio nal20RR说明-开发语言名称Delphi版本6.0+SP2说明使用控件1名称GISDLL.dll版本V1.0、说明GIS开发平台使用控件2名称REGDLL.dll版本V1.0说明软件注册控件引用关键算法名称-版本备注三、软件框架与流程1、软件框架结构描述。2、软件主要流程图。3、软件使用通信协议、接口、数据库（表）方面详细说明。 例如：1、软件框架结构图Mapi nfo 格式地图地图文件特征向量包返回确定信息扌数据库IIt特征向量保存在i本地数据库中:.J用户管理模块:1、修改密码2、新增用户3、删除用户 （信息存库）通

4、信处理功能模块：1、根据用户提交保存地图 （煤矿端监控中心）操作,一次将多条特征向量进 行组包，发送给安全卫 士。2、收到正确返回后，清除 特征向量待发列表中的已 经传送过的特征向量，并 将其移至历史列表。3、通信过程中的出错处理 功能煤矿端GIS功能模块和数据流程图安全卫士 数据终端2、主要流程图（略）3、详细通信协议见远程监系统中总协议中煤矿端 GIS与安全卫士部分。四、关键函数与功能说明（一）、软件关键函数（自定义、系统、弓I用）、窗体事件、模块存储过程等的列表。关键函数或算法请写出流程图或用伪代码描述。编号函数名称功能描述参数说明返回值备注12345函数1:流程或算法。函数2:流程或算

5、法。 例如：1、函数列表序 号函数名称功能描述参数描述返回值其他1GetCoalFromDBToArr aR从数据库取煤矿信 息到数组中(ADOQuerR:TADOQuerR; varCoalArraR:TCoalArraR)正常返回真2GetSe nsorFromDBTo ArraR从数据库取传感器 信息到数组中(ADOQuerR:TADOQuerR; varSen sorArraR:TSe nsorArraR)Boolea n 类型，正 常返回真3GetSe nsorTRpeArraR FromDB从数据库取传感器 类型到数组中(ADOQuerR:TADOQuerR;V arSe nsor

6、TRpeArraR:TSe nso rTRpeArraR)Boolea n 类型，正 常返回真4GetMapArraR从地图文件中取地 图 信 息 到MapArraR 数组无参数过程 无返回值R5CheckSe nsorStatus根据传感器状态数 据，判断传感器状 态(Status:Stri ng;i:i nteger)过程 无返回值6RefreshSe nsorStatus刷新传感器状态(CoalID:stri ng)过程 无返回值2、函数的算法描述（流程图或伪代码描述）函数 4: GetMapArraR（）5打开地图文件。10设置地图数量变量n。15读取地图文件中地图数量保存到n中。20

7、设置 MapArraR 数组长度为n。25再读取地图文件，将各地图信息存到MapArraR数组中 30关闭地图文件。（二）、软件主要功能列表关键功能的流程要写出流程图或用伪代码描述。序号功能功能描述使用函数、窗体、存储过程、数 据库表、文件等备注12345功能1：流程或算法描述。功能2:流程或算法描述。 例如：2、功能列表骨口. 序号功能功能描述使用函数、窗体、存储过程、数据 库表、文件等备注1发送特 征向量（煤矿端）煤矿端GIS向数据交 换程序发送特征向量在主窗中实现，米用 TCP/IP方式。 用到数据库 SenderList表， createlD,objlD,CreateTime,data

8、字段。2取井下 系统配置数 据煤矿端GIS向数据交 换程序请求井下监控 系统配置数据。在主窗中实现，米用TCP/IP方式。 用 到数据库 configsensor。Sen sorID 、Sen sorTRpe 、SubStationDesc、Position 字段。用 到 ParseReceiveTeRt函数。3配置数据处理处理井下监控系统配 置数据包StoreSensorCfg、AddSensorCfg功能流程：功能1：发送特征向量流程2:取井下系统配置数据四、软件产品说明1、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。2、软件如何进行安装、参数配置、使用。需要进行注册或安

9、装数据库等环境的要进行详细说明，或指出参考文档。3、软件项目文件说明：各单元文件（类）之间关系，说明各单元文件功能4、软件开发环境配置说明。例如：1、煤矿端GIS软件名称如：CoalEditGlS.eRe，使用到GlS.ini配置文件和GIS.UDL数 据连接文件，另外使用到两种自定义字体。2、软件安装、参数配置、使用请参考此软件安装使用说明手册。3、软件为Delphi6.0开发，工程文件在归档程序目录下，名称为 CoalEditGIS.dpr,主要 包含单元文件35个，如下表：序号名称主要功能备注1Mai n主窗体含.pas、.dfm文件2Login登陆窗体含.pas、.dfm文件3EditSe nsor传感器编辑窗体含.pas、.dfm文件4EditL ine线类对象编辑窗体含.pas、.dfm文件5Fun proc自定义函数单元文件6struct un it自定义结构单元文件35WriteTRt记录信息到文本4、软件开发环境配置说明:程序开发环境安装，在 windows20RRprofe