软件开发技术手册

金安技术GoldSafety软件开发技术手册〈XXXXX软件〉作者：XXX版本号：x.xx宣布时间：200x—xx-xx文档编号软件名称软件简介相关系统参加人员金安技术版权全部第1页/共11页开发技术手册金安技术GoldSafety禁止在金安公司之外公开或使用!第2页/共11页开发技术手册金安技术GoldSafety版本历史版本号作者参加者更正说明日期1。00Damy—06———-27第3页/共11页开发技术手册金安技术GoldSafety一、软件介绍、介绍软件名称、实现主要功能。、本软件与整个系统中其余相关软件关系介绍。软件名称主要功能在整个系统中与其余软件关系（相关协议文档的说明）比方：软件名称AJ－M01软件(煤矿端）V1.0主要功能、地图的导入(mapinfo格式）、图元增添，更正，删除、图元显示、操作、盘问、图层管理、用户管理通讯办理:对因地图操作而生成的特点向量的保存，.在整个系统中与其余软此软件是经过安全卫士程序，将地图特点向量数据传输到中心，件关系与安全卫士程序有通讯协议。使用时需要安全卫士程序配合.二、软件开发环境名称操作系统版本说明名称数据库版本说明名称开发语言版本说明名称使用控件版本说明引用重点算法名称版本备注、软件开发平台：详细说明软件开发所用操作系统、数据库等版本.第4页/共11页开发技术手册金安技术GoldSafety、使用开发语言以及版本。、使用相关控件名称、版本（如组件、DLL、软件中引用重点算法说明。比方：名称Win2000操作系统版本Win2000professional+SP4说明软件在win2000开发，可运转于win2000\XP系统名称SQLServer版本Professional2000数据库说明-—名称Delphi开发语言版本6.0+SP2说明名称GISDLL.dll使用控件1版本V1.0、说明GIS开发平台名称REGDLL.dll使用控件2版本V1。0说明软件注册控件引用重点算法名称——版本备注三、软件框架与流程、软件框架结构描述。、软件主要流程图.、软件使用通讯协议、接口、数据库（表)方面详细说明。比方：、软件框架结构图第5页/共11页开发技术手册金安技术GoldSafetyMapinfo安全卫士格式地图数据终端地图数据转入功能模块：特点返回确地图文件向量包定信息1、将Mapinfo格式地图导入到GIS自己格式文件中，同时将图中对象相关的其属性存放到当地数据库中。（煤矿地图要严格依据地图制作规范进行绘制，同一煤矿只生产一个图，每一层导入到该图的相应图层）2、生产自己格式的地图文件，供程序调用。用户管理模块：1、更正密码2、新增用户3、删除用户（信息存库）地图编写、更正功能模块（设定用户权限）：1、可对地图中的点、线、面三大类对象进行地址、属性、节点进行编写、更正，并保存到当地地图文件和数据库中。通讯办理功能模块：2、在地图上可增添点、线、面三类对象及对象属性数据，保存到当地地图文件和数据库中。数据库1、依据用户提交保存地图（煤矿端－监控中心）操3、对上边的编写、更正每一个对象产生的相关数据生成一条特点向量，保存到特点向量文件中，供通讯模块调用。作,一次将多条特点向量进行组包，发送给安全卫特点向量保存在士。当地数据库中2、收到正确返回后，除去特点向量待发列表中的已经传达过的特点向量，并地图显示、操作、盘问功能模块：将其移至历史列表。3、通讯过程中的出错办理1、显示全图、地图放大、减小、搬动、选择等；2、分层显示的功能，用户可选择显示/隐蔽相关图层。3、各图层对象查找功能（主若是巷道层、工作面层、传功能感器层、分站层），并闪耀提示用户。煤矿端GIS功能模块和数据流程图、主要流程图（略）、详细通讯协议见远程监系统中总协议中煤矿端GIS与安全卫士部分.四、重点函数与功能说明（一)、软件重点函数(自定义、系统、引用）、窗体事件、模块储藏过程等的列表。重点函数或算法请写出流程图或用伪代码描述。编号函数名称功能描述参数说明返回值备注12345函数：流程或算法。函数2:流程或算法。第6页/共11页开发技术手册金安技术GoldSafety比方:、函数列表序号函数名称功能描述参数描述返回值其余从数据库取煤矿信（ADOQuery：正常返回1GetCoalFromDBToArray息到数组中TADOQuery；varCoalArray：TCoalArray)真从数据库取传感器（ADOQuery：Boolean2GetSensorFromDBToArray信息到数组中TADOQuery；varSensorArray：种类，正常返回真TSensorArray）从数据库取传感器（ADOQuery：Boolean3GetSensorTypeArrayFromDB种类到数组中TADOQuery；VarSensorTypeArray:TSensorTypeArray）种类，正常返回真从地图文件中取地无参数过程4GetMapArray图信息到MapArray数组无返回值＊依据传感器状态数（Status:String；i:integer)过程5CheckSensorStatus据，判断传感器状无返回值态6RefreshSensorStatus刷新传感器状态（CoalID：string）过程无返回值2、函数的算法描述（流程图或伪代码描述）函数：GetMapArray（)5打开地图文件.10设置地图数目变量n。15读取地图文件中地图数目保存到n中.20设置MapArray数组长度为。25再读取地图文件，将各地图信息存到MapArray数组中.30关闭地图文件。(二)、软件主要功能列表重点功能的流程要写出流程图或用伪代码描述。序号功能功能描述使用函数、窗体、储藏过程、数据库表、文件等备注12第7页/共11页开发技术手册金安技术GoldSafety345功能：流程或算法描述.功能：流程或算法描述.比方:2、功能列表序号功能功能描述使用函数、窗体、储藏过程、数据备注库表、文件等1发送特煤矿端GIS向数据交在主窗中实现，采纳TCP/IP方式.征向量换程序发送特点向量用到数据库SenderList（煤矿表,createID,objID，CreateTime,data端)字段.2取井下煤矿端GIS向数据交在主窗中实现采纳TCP/IP方式。系统换程序央求井下监控用到数据库configsensor。配置数系统配置数据。SensorID、SensorType、据、Position字段。用到ParseReceiveText函数.3配置数、AddSensorCfg办理井下监控系统配据办理置数据包功能流程：功能：发送特点向量第8页/共11页开发技术手册金安技术GoldSafety流程：取井下系统配置数据流程：配置数据办理第9页/共11页开发技术手册金安技术GoldSafety四、软件产品说明、对归档程序说明软件产品名称，以及使用到相关配置文件参数等说明。、软件怎样进行安装、参数配置、使用.需要进行注册或安装数据库等环境的要进行详细说明，或指出参照文档.、软件项目文件说明：各单元文件（类）之间关系，说明各单元文件功能。、软件开发环境配置说明。比方：、煤矿端GIS软件名称如：CoalEditGIS。exe，使用到GIS.ini配置文件和GIS.UDL数据连接文件，别的使用到两种自定义字体。、软件安装、参数配置、使用请参照此软件安装使用说明手册。、软件为Delphi6.0开发，工程文件在归档程序目录下,名称为CoalEditGIS。主要包括单元文件35个，以下表：序号名称主要功能备注1Main主窗体含.pas、.dfm文件2Login登陆窗体含。pasdfm文件3EditSensor传感器编写窗体含。pas、.dfm文件4EditLine线类对象编写窗体含。pasdfm文件第10页/共11页开发技术手册金安技术GoldSafety5Funproc自定义函数单元文件6structunit自定义结构单元文件⋯.。⋯⋯..⋯35WriteTxt记录信息到文本4、软件开发环境配置