软件开发技术手册.doc

金安技术GoldSafety 软件开发技术手册作者：XXX版本号：x.xx发布时间：200x-xx-xx文档编号软件名称软件简介相关系统参与人员金安技术版权所有严禁在金安公司以外公开或使用!版本历史版本号作者参与者修改说明日期1.00Damy2004-06-5-27 一、软件介绍1、介绍软件名称、实现主要功能。2、本软件与整个系统中其它相关软件关系介绍。软件名称主要功能在整个系统中与其它软件关系(相关协议文档的说明)例如：软件名称AJM01 GIS软件（煤矿端）V1.0主要功能a、地图的导入（mapinfo格式）b、图元添加，修改，删除c、图元显示、操作、查询d、图层管理e、用户管理通信处理：对因地图操作而生成的特征向量的保存，管理，发送等。在整个系统中与其它软件关系此软件是通过安全卫士程序，将地图特征向量数据传输到中心，与安全卫士程序有通信协议。使用时需要安全卫士程序配合。二、软件开发环境操作系统名称版本说明数据库名称版本说明开发语言名称版本说明使用控件名称版本说明引用关键算法名称版本备注1、软件开发平台:详细说明软件开发所用操作系统、数据库等版本。2、使用开发语言以及版本。3、使用相关控件名称、版本（如组件、DLL等）。4、软件中引用关键算法说明。例如：操作系统名称Win2000版本Win2000 professional+SP4 说明软件在win2000开发，可运行于win2000XP系统数据库名称SQL Server版本Professional 2000说明-开发语言名称Delphi版本6.0+SP2说明使用控件1名称GISDLL.dll版本V1.0、说明GIS开发平台使用控件2名称REGDLL.dll版本V1.0说明软件注册控件引用关键算法名称-版本备注 三、软件框架与流程1、软件框架结构描述。2、软件主要流程图。3、软件使用通信协议、接口、数据库（表）方面详细说明。例如：1、软件框架结构图 2、主要流程图 （略）3、详细通信协议见远程监系统中总协议中煤矿端GIS与安全卫士部分。四、关键函数与功能说明(一)、软件关键函数（自定义、系统、引用）、窗体事件、模块存储过程等的列表。关键函数或算法请写出流程图或用伪代码描述。编号函数名称功能描述参数说明返回值备注12345函数1：流程或算法。函数2：流程或算法。例如:1、函数列表序号函数名称功能描述参数描述返回值其他1GetCoalFromDBToArray从数据库取煤矿信息到数组中(ADOQuery: TADOQuery; var CoalArray: TCoalArray)正常返回真2GetSensorFromDBToArray从数据库取传感器信息到数组中(ADOQuery: TADOQuery; varSensorArray: TSensorArray)Boolean类型，正常返回真3GetSensorTypeArrayFromDB从数据库取传感器类型到数组中(ADOQuery: TADOQuery; Var SensorTypeArray: TSensorTypeArray)Boolean类型，正常返回真4GetMapArray从地图文件中取地图信息到MapArray数组无参数过程无返回值*5CheckSensorStatus根据传感器状态数据，判断传感器状态(Status:String;i:integer)过程无返回值6RefreshSensorStatus刷新传感器状态(CoalID:string)过程无返回值2、函数的算法描述（流程图或伪代码描述）函数4：GetMapArray ( )5 打开地图文件。10 设置地图数量变量n。15 读取地图文件中地图数量保存到n中。20 设置MapArray数组长度为n。25 再读取地图文件，将各地图信息存到MapArray数组中。30 关闭地图文件。(二)、软件主要功能列表关键功能的流程要写出流程图或用伪代码描述。序号功能功能描述使用函数、窗体、存储过程、数据库表、文件等备注12345功能1：流程或算法描述。功能2：流程或算法描述。例如：2、功能列表序号功能功能描述使用函数、窗体、存储过程、数据库表、文件等备注1发送特征向量(煤矿端)煤矿端GIS向数据交换程序发送特征向量在主窗中实现，采用TCP/IP方式。用到数据库SenderList表，createID,objID,CreateTime,data字段。2取井下系统配置数据煤矿端GIS向数据交换程序请求井下监控系统配置数据。在主窗中实现，采用TCP/IP方式。用到数据库configsensor。SensorID、SensorType、SubStationDesc、Position字段。用到ParseReceiveText函数。3配置数据处理处理井下监控系统配置数据包StoreSensorCfg、AddSensorCfg功能流程： 功能1: 发送特征向量流程2: 取井下系统配置数据流程3: 配置数据处理四、软件产品说明1、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。2、软件如何进行安装、参数配置、使用。需要进行注册或安装数据库等环境的要进行详细说明，或指出参考文档。3、软件项目文件说明：各单元文件（类）之间关系，说明各单元文件功能.4、软件开发环境配置说明。例如：1、煤矿端GIS软件名称如：CoalEditGIS.exe，使用到GIS.ini配置文件和GIS.UDL数据连接文件，另外使用到两种自定义字体。2、软件安装、参数配置、使用请参考此软件安装使用说明手册。3、软件为Delphi6.0开发，工程文件在归档程序目录下，名称为CoalEditGIS.dpr,主要包含单元文件35个，如下表：序号名称主要功能备注1Main主窗体含.pas、.dfm文件2Login登陆窗体含.pas、.dfm文件3EditSensor传感器编辑窗体含.pas、.dfm文件4EditLine线类对象编辑窗体含.pas、.dfm文件5Funproc自定义函数单元文件6structunit自定义结构单元文件.35WriteTxt记录信息到文本4、软件开发环境配置说明：程序开发环境安装，在windows2000 professional系统下，先安装Delphi6.0+SP2，再安装MS SQ