BIM工程信息管理系统-详细设计

详细设计说明书

1引言

1.1编写目的

编写详细设计说明书的目的就是为程序员写出实际的程序代码提供依据。它是软件详细设计阶段所有任务和所有相关人员所需的参考资料.

1.2背景

说明：

a．  软件名称：BIM工程信息管理系统；

b．  项目提出者：**科技技术委员会

c．  开发者：**研发部

d．  用户：适用于隧道，桥梁　BIM施工

e．  系统运行：Windows7/8

1.3定义

用户接口：是指一个程序与程序使用者交互的部分。

算法：详细设计中实现某项功能的数据处理流程及处理方法。

SDK：Software Development Kit  即软件开发工具包。

VS: Visual Studio

MSSQL：微软SQL Server

1.4参考资料

列出有关的参考资料：

a．  根据需求分析文档的功能需求

b．  IT项目管理 [机械出版社会]

2程序系统的结构

本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系:

系统分为以下几个模块：系统基础模块功能，系统BIM属性功能模块，系统插件管理模块，模型关联信息模块，系统可视集成模块，系统工程简介与概述,施工管理模块

3系统基础模块[机构管理]

3.1程序描述

主要是考虑到集团类型的公司下一般都有很多分公司。管理员通过机构管理可以添加对应的机构信息。可以新增，编辑，删除 等功能

3.2功能

说明该程序应具有的功能，可采用IPO图：

3.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

3.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

3.5输出项

输出是从数据库中读取的数据，或错误警告信息。

3.6算法

本部分没有采用自定义的算法。

3.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

3.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

3.9注释设计

说明准备在本程序中安排的注释，

a．  加在模块首部的注释；//简介：开发人员:  时间

b．  加在各分枝点处的注释；//说明程序

c．  对各变量的功能、范围、缺省条件等所加的注释；

d．  对使用的逻辑所加的注释等等。

3.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

3.11测试计划

测试计划按照测试经理的安排完成项目的测试需要。

4系统基础模块[部门管理]

4.1程序描述

主要是考虑到机构一般都有很多部门。管理员通过机构管理可以添加对应的部门信息。可以新增，编辑，删除 等功能

4.2功能

说明该程序应具有的功能，可采用IPO图：

4.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

4.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

4.5输出项

输出是从数据库中读取的数据，或错误警告信息。

4.6算法

本部分没有采用自定义的算法。

4.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

4.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

4.9注释设计

说明准备在本程序中安排的注释，

e．  加在模块首部的注释；//简介：开发人员:  时间

f．   加在各分枝点处的注释；//说明程序

g．  对各变量的功能、范围、缺省条件等所加的注释；

h．  对使用的逻辑所加的注释等等。

4.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

4.11测试计划

测试计划按照测试经理的安排完成项目的测试需要。

5系统基础模块[用户与角色管理]

5.1程序描述

管理员可以对已注册用户进行删除、修改信息、查询等不同功能

管理员可以对已角色信息进行删除、修改信息、查询等不同功能

5.2功能

说明该程序应具有的功能，可采用IPO图：

图:用户管理

图：角色管理

5.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

5.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

5.5输出项

输出是从数据库中读取的数据，或错误警告信息。

5.6算法

本部分没有采用自定义的算法。

5.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

5.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

4.9注释设计

说明准备在本程序中安排的注释，

i．   加在模块首部的注释；//简介：开发人员:  时间

j．   加在各分枝点处的注释；//说明程序

k．  对各变量的功能、范围、缺省条件等所加的注释；

l．   对使用的逻辑所加的注释等等。

5.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

5.11测试计划

......

6系统基础模块[系统权限菜单管理]

6.1程序描述

主要是对系统功能菜单的管理,进行对菜单的分组，模块的划分 等信息.以及插件的加载。等信息管理、

6.2功能

说明该程序应具有的功能，可采用IPO图：

6.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

6.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

6.5输出项

输出是从数据库中读取的数据，或错误警告信息。

6.6算法

本部分没有采用自定义的算法。

6.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

6.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

6.9注释设计

说明准备在本程序中安排的注释，

m．                      加在模块首部的注释；//简介：开发人员:  时间

n．  加在各分枝点处的注释；//说明程序

• o．  对各变量的功能、范围、缺省条件等所加的注释；

p．  对使用的逻辑所加的注释等等。

6.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

6.11测试计划

......

7系统基础模块[权限信息管理]

7.1程序描述

主要是对角色和用户信息授权信息管理.

7.2功能

说明该程序应具有的功能，可采用IPO图：

7.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在5—10秒之间

7.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

7.5输出项

输出是从数据库中读取的数据，或错误警告信息。

7.6算法

本部分没有采用自定义的算法。

7.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

7.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

7.9注释设计

说明准备在本程序中安排的注释，

q．  加在模块首部的注释；//简介：开发人员:  时间

r．   加在各分枝点处的注释；//说明程序

s．   对各变量的功能、范围、缺省条件等所加的注释；

t．   对使用的逻辑所加的注释等等。

7.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

7.11测试计划

......

8BIM模型模块 [模型属性分类]设计说明

8.1程序描述

主要是模型属性的信息进行分类.进行对分类添加，删除，编辑的管理

可以正对不同的行业性。如果隧道，桥梁信息

8.2功能

说明该程序应具有的功能，可采用IPO图：

8.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

8.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

8.5输出项

输出是从数据库中读取的数据，或错误警告信息。

8.6算法

本部分没有采用自定义的算法。

8.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

8.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

8.9注释设计

说明准备在本程序中安排的注释，

u．  加在模块首部的注释；//简介：开发人员:  时间

v．  加在各分枝点处的注释；//说明程序

w．                      对各变量的功能、范围、缺省条件等所加的注释；

x．  对使用的逻辑所加的注释等等。

8.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

8.11测试计划

......

9BIM模型模块[模型属性模板]设计说明

9.1程序描述

主要是根据模型属性的分类，根据分类添加对应的模板信息。

9.2功能

说明该程序应具有的功能，可采用IPO图：

9.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

9.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

9.5输出项

输出是从数据库中读取的数据，或错误警告信息。

9.6算法

本部分没有采用自定义的算法。

9.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

9.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

9.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

9.11测试计划

......

10 BIM模型模块[模型属性自定义模板]设计说明

10.1程序描述

主要是对应的分类加载分类对应的模板信息。

10.2功能

说明该程序应具有的功能，可采用IPO图：

10.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

10.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

10.5输出项

输出是从数据库中读取的数据，或错误警告信息。

10.6算法

本部分没有采用自定义的算法。

10.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

10.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

10.9注释设计

说明准备在本程序中安排的注释，

cc．                     加在模块首部的注释；//简介：开发人员:  时间

dd．                    加在各分枝点处的注释；//说明程序

ee．                     对各变量的功能、范围、缺省条件等所加的注释；

ff． 对使用的逻辑所加的注释等等。

10.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

10.11测试计划

......

11BIM模型模块 [模型管理]设计说明

11.1程序描述

主要是对模型的信息添加，删除，修改 等。

11.2功能

说明该程序应具有的功能，可采用IPO图：

11.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

11.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

11.5输出项

输出是从数据库中读取的数据，或错误警告信息。

11.6算法

本部分没有采用自定义的算法。

11.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

11.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

11.9注释设计

说明准备在本程序中安排的注释，

gg．                    加在模块首部的注释；//简介：开发人员:  时间

hh．                    加在各分枝点处的注释；//说明程序

ii． 对各变量的功能、范围、缺省条件等所加的注释；

jj． 对使用的逻辑所加的注释等等。

11.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

11.11测试计划

......

12施工计划 设计说明

12.1程序描述

主要是考虑到集团类型的公司下一般都有很多分公司。管理员通过机构管理可以添加对应的机构信息。可以新增，编辑，删除 等功能

12.2功能

说明该程序应具有的功能，可采用IPO图：

12.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

12.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

12.5输出项

输出是从数据库中读取的数据，或错误警告信息。

12.6算法

本部分没有采用自定义的算法。

12.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

12.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

12.9注释设计

说明准备在本程序中安排的注释，

kk．                    加在模块首部的注释；//简介：开发人员:  时间

ll． 加在各分枝点处的注释；//说明程序

mm．                对各变量的功能、范围、缺省条件等所加的注释；

nn．                    对使用的逻辑所加的注释等等。

12.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，所以客户端的语言使用Win form，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。

12.11测试计划

......

13施工日志设计说明

12.1程序描述

主要是考虑到集团类型的公司下一般都有很多分公司。管理员通过机构管理可以添加对应的机构信息。可以新增，编辑，删除 等功能

12.2功能

说明该程序应具有的功能，可采用IPO图：

12.3性能

灵活性：窗口响应绝大部分的快捷菜单和控制面板操作

时间特性：响应鼠标单击的时间在2—3秒之间

12.4输人项

输入的数据是用户执行的各种操作，包括鼠标、键盘等操作。。

12.5输出项

输出是从数据库中读取的数据，或错误警告信息。

12.6算法

本部分没有采用自定义的算法。

12.7接口

硬件接口：主要就是WCF 以TCP/IP层中的网络接口层

软件接口：具体来说开发中可能使用到的ADO的常用对象有以下几个：

（1）连接对象（Connection）：用来连接数据库。

（2）记录集对象（RecordSet）：用来保存查询语句的返回结果。

（3）命令对象（Command）：用来执行SQL语句或者SQL Server的存储过程。

（4）参数对象（Parameter）：用来为存储过程或查询提供参数。

12.8存储分配

本程序在高级语言C#进行编码，直接的内存分配由C#运行时分配。

12.10限制条件

（1）由于本系统的开发将是基于Window的C/S 结构，客户端的语言使用Winform，服务器端的语言使用WCF，开发人员将不能用其他的开发语言（编写组件除外）。而数据库也将随之采用SQL Server2012。

（2）开发人员在编写代码的过程中需要严格按照软件工程的要求来进行，以利于接下来的测试和维护及升级。