軟件開發(fā)技術(shù)手冊

軟件開發(fā)技術(shù)手冊VXXXX）軟件＞作者：XXX版本號：X.XX發(fā)布時間：200X-XX-XX文檔編號軟件名稱軟件簡介相關(guān)系統(tǒng)參與人員金安技術(shù)版權(quán)所有嚴(yán)禁在金安公司以外公開或使用版本歷史版本號作者參與者修改說明日期1.00Damy2004-06-5---27、軟件介紹1、介紹軟件名稱、實現(xiàn)主要功能。2、本軟件與整個系統(tǒng)中其它相關(guān)軟件關(guān)系介紹軟件名稱主要功能在整個系統(tǒng)中與其它軟件關(guān)系（相關(guān)協(xié)議文檔的說明）例如:軟件名稱AJ—M01GIS軟件（煤礦端）V1.0主要功能a、地圖的導(dǎo)入（mapinfo格式）b圖元添加，修改，刪除C、圖元顯示、操作、杳詢d圖層管理e、用戶管理通信處理：對因地圖操作而生成的特征向量的保存，管理，發(fā)送等。在整個系統(tǒng)中與其它軟件關(guān)系此軟件是通過安全衛(wèi)士程序，將地圖特征向量數(shù)據(jù)傳輸?shù)街行?，與安全衛(wèi)士程序有通信協(xié)議。使用時需要安全衛(wèi)士程序配合。二、軟件開發(fā)環(huán)境1、軟件開發(fā)平臺：詳細說明軟件開發(fā)所用操作系統(tǒng)、數(shù)據(jù)庫等版本2、使用開發(fā)語言以及版本。

DLL等）。3DLL等）。4、軟件中引用關(guān)鍵算法說明。例如:操作系統(tǒng)名稱Win2000版本W(wǎng)in2000professional+SP4說明軟件在win2000開發(fā)，可運行于win2000\XP系統(tǒng)數(shù)據(jù)庫名稱SQLServer版本Professional2000說明--開發(fā)語言名稱Delphi版本6.0+SP2說明使用控件1名稱GISDLL.dll版本V1.0、說明GIS開發(fā)平臺使用控件2名稱REGDLL.dll版本V1.0說明軟件注冊控件引用關(guān)鍵算法名稱--版本備注三、軟件框架與流程1、軟件框架結(jié)構(gòu)描述。2、軟件主要流程圖。3、軟件使用通信協(xié)議、接口、數(shù)據(jù)庫（表）方面詳細說明例如：1、軟件框架結(jié)構(gòu)圖

Mapinfo格式地圖安全衛(wèi)士數(shù)據(jù)終端地圖數(shù)據(jù)轉(zhuǎn)入功能模塊:地圖文件1、將Mapinfo格式地圖導(dǎo)入到GIS自己格式文件中，同時將圖中對象相關(guān)的其屬性存放到本地數(shù)據(jù)庫中。（煤礦地圖要嚴(yán)格按照地圖制作規(guī)范進行繪制，同一煤礦只生產(chǎn)一個圖，每一層導(dǎo)入到該圖的相應(yīng)圖層）Mapinfo格式地圖安全衛(wèi)士數(shù)據(jù)終端地圖數(shù)據(jù)轉(zhuǎn)入功能模塊:地圖文件1、將Mapinfo格式地圖導(dǎo)入到GIS自己格式文件中，同時將圖中對象相關(guān)的其屬性存放到本地數(shù)據(jù)庫中。（煤礦地圖要嚴(yán)格按照地圖制作規(guī)范進行繪制，同一煤礦只生產(chǎn)一個圖，每一層導(dǎo)入到該圖的相應(yīng)圖層）2、生產(chǎn)自己格式的地圖文件，供程序調(diào)用。特征返回確向量包定信息用戶管理模塊:1、修改密碼2、新增用戶3、刪除用戶（信息存庫）地圖編輯、修改功能模塊（設(shè)定用戶權(quán)限）：1、可對地圖中的點、線、面三大類對象進行位置、屬性、節(jié)點進行編輯、修改，并保存到本地地圖文件和數(shù)據(jù)庫中。2、在地圖上可增加點、線、面三類對象及對象屬性數(shù)據(jù)，保存到本地地圖文件和數(shù)據(jù)庫中。3、對上面的編輯、修改每一個對象產(chǎn)生的相關(guān)數(shù)據(jù)生成一條特征向量，保存到特征向量文件中，供通信模塊調(diào)用。通信處理功能模塊:I-I特征向量保存在亠本地數(shù)據(jù)庫中■~~地圖顯示、操作、查詢功能模塊:1、顯示全圖、地圖放大、縮小、移動、選擇等；2、分層顯示的功能，用戶可選擇顯示/隱藏相關(guān)圖層3、各圖層對象查找功能（主要是巷道層、工作面層、傳感器層、分站層），并閃爍提示用戶。1、根據(jù)用戶提交保存地圖（煤礦端一監(jiān)控中心）操作,一次將多條特征向量進行組包，發(fā)送給安全衛(wèi)士。2、收到正確返回后，清除特征向量待發(fā)列表中的已經(jīng)傳送過的特征向量，并將其移至歷史列表。3、通信過程中的出錯處理功能煤礦端GIS功能模塊和數(shù)據(jù)流程圖2、主要流程圖（略）3、詳細通信協(xié)議見遠程監(jiān)系統(tǒng)中總協(xié)議中煤礦端GIS與安全衛(wèi)士部分四、關(guān)鍵函數(shù)與功能說明（一）、軟件關(guān)鍵函數(shù)（自定義、系統(tǒng)、弓I用）關(guān)、窗體事件、模塊存儲過程等的列表鍵函數(shù)或算法請寫出流程圖或用偽代碼描述。編號函數(shù)名稱編號函數(shù)名稱功能描述12345參數(shù)說明返叵值備注函數(shù)1：流程或算法。函數(shù)2：流程或算法。例如:1、函數(shù)列表

序號函數(shù)名稱功能描述參數(shù)描述返回值其他1GetCoalFromDBToArray從數(shù)據(jù)庫取煤礦信息到數(shù)組中(ADOQuery:lADOQuery;varCoalArray:TCoalArray)正常返回真2GetSensorFromDBToArray從數(shù)據(jù)庫取傳感器信息到數(shù)組中(ADOQuery:TADOQuery;varSensorArray:TSensorArray)Boolean類型，正常返回真3GetSensorTypeArrayFromDB從數(shù)據(jù)庫取傳感器類型到數(shù)組中(ADOQuery:TADOQuery;VarSensorTypeArray:TSensorTypeArray)Boolean類型，正常返回真4GetMapArray從地圖文件中取地圖信息到MapArray數(shù)組無參數(shù)過程無返回值*5CheckSensorStatus根據(jù)傳感器狀態(tài)數(shù)據(jù)，判斷傳感器狀態(tài)(Status:String;i:integer)過程無返回值6RefreshSensorStatus刷新傳感器狀態(tài)(CoallD:string)過程無返回值2、函數(shù)的算法描述（流程圖或偽代碼描述）函數(shù)4:GetMapArray（）5打開地圖文件。10設(shè)置地圖數(shù)量變量n。15讀取地圖文件中地圖數(shù)量保存到n中。20設(shè)置MapArray數(shù)組長度為n。25再讀取地圖文件，將各地圖信息存到MapArray數(shù)組中。關(guān)閉地圖文件。30（二）、軟件主要功能列表關(guān)鍵功能的流程要寫出流程圖或用偽代碼描述。流程或算法描述功能2：流程或算法描述。

例如：2、功能列表序號功能功能描述使用函數(shù)、窗體、存儲過程、數(shù)據(jù)庫表、文件等備注1發(fā)送特征向量（煤礦端）煤礦端GIS向數(shù)據(jù)交換程序發(fā)送特征向量在主窗中實現(xiàn)，米用TCP/IP方式。用到數(shù)據(jù)庫SenderList表，createlD,objlD,CreateTime,data字段。2取井下系統(tǒng)配置數(shù)據(jù)煤礦端GIS向數(shù)據(jù)交換程序請求井下監(jiān)控系統(tǒng)配置數(shù)據(jù)。在主窗中實現(xiàn)，米用TCP/IP方式。用到數(shù)據(jù)庫configsensor。SensorID、SensorType、SubStationDesc、Position字段。用到ParseReceiveText函數(shù)。3配置數(shù)據(jù)處理處理井下監(jiān)控系統(tǒng)配置數(shù)據(jù)包StoreSensorCfg、AddSensorCfg功能流程：功能1：發(fā)送特征向量流程2:取井下系統(tǒng)配置數(shù)據(jù)1-■-■f--Jl冋“'「pH4Tfi'■■■/7恍電靳時轉(zhuǎn)世”?一m：譏：開始;昶祈件割s敎據(jù)1-■-■f--Jl冋“'「pH4Tfi'■■■/7恍電靳時轉(zhuǎn)世”?一m：譏：開始;昶祈件割s敎據(jù)說宣徹撫卑艷新時#Ht(-.MAftlK'V流程3:配置數(shù)據(jù)處理按協(xié)i義解也

紂創(chuàng)數(shù)據(jù)彌

分

花數(shù)據(jù)祁莎宦位

-種分隔符的位世杓入IT祐”晉c令品滸偵艸析肚否磐f->——t&yjiwn據(jù)”慣訶揆損肝融舉為宇，

從數(shù)據(jù)部彷樓取開關(guān)皤竽

救抓?汕別處理模T'開關(guān)邸數(shù)抓結(jié)束四、軟件產(chǎn)品說明1、對歸檔程序說明軟件產(chǎn)品名稱，以及使用到相關(guān)配置文件參數(shù)等說明。2、軟件如何進行安裝、參數(shù)配置、使用。需要進行注冊或安裝數(shù)據(jù)庫等環(huán)境的要進行詳細說明，或指出參考文檔。3、軟件項目文件說明：各單元文件（類）之間關(guān)系，說明各單元文件功能4、軟件開發(fā)環(huán)境配置說明。例如：1、煤礦端GIS軟件名稱如：CoalEditGIS.exe,使用到GIS.ini配置文件和GIS.UDL數(shù)據(jù)連接文件，另外使用到兩種自定義字體。2、軟件安裝、參數(shù)配置、使用請參考此軟件安裝使用說明手冊。3、軟件為DeIphi6.0開發(fā)，工程文件在歸檔程序目錄下，名稱為CoalEditGlS.dpr,主要包含單元文件35個，如下表：序號名稱主要功能備注1Main主窗體含.pas、?dfm文件2Login登陸窗體含.pas、?dfm文件3EditSensor傳感器編輯窗體含.pas、?dfm文件4EditLine線類對象編輯窗體含.pas、?dfm文件5Funproc自定義函數(shù)單元文件6structunit自定義結(jié)構(gòu)單元文件???????????????35WriteTxt記錄信息到文本4、軟件開發(fā)環(huán)境配