系统概要设计说明书.doc

文档编号 08KY025 JS 0003 项目 项目 系统设计说明书 小组 20XX 年 XX 月 WS 多通道同步数字记录仪升级换代 系统设计说明书 修改记录 版本变更原因变更内容简述 编制 修 订者 批准者 发布 日期 v1 0 1 1 Build 2011 11 30 创建XXX WS TS PI GF 1010 系统设计说明书编制规范 目 录 1引言引言 3 1 1编写目的 3 1 2项目背景 4 1 3定义 4 1 4参考资料 4 2条件与限制条件与限制 4 3需求规定需求规定 5 4运行环境运行环境 5 4 1硬件环境 5 4 2软件环境 5 5体系架构体系架构 5 5 1系统结构 5 5 2软件架构 6 6逻辑结构设计逻辑结构设计 8 6 1CSCI 列表 10 6 2CSCI 关系图 11 6 3CSCI 1 1 话音数据记录 VOICERECORD 11 6 3 1模块名称 11 6 3 2功能描述 11 6 3 3接口描述 12 6 3 3 1输入接口 12 6 3 3 2输出接口 13 6 3 4流程描述 13 6 3 4 1话音记录初始化流程描述 13 6 3 4 2话音记录流程描述 14 6 3 4 3XXX 命令流程描述 16 多通道同步数字记录仪升级换代 系统设计说明书 第 I 页 共 14 页 6 3 5补充说明 16 6 4CSCI 4 网络与公共基础支持 BASICPUBLIC 16 6 4 1模块名称 16 6 4 2功能描述 16 6 4 2 1输入接口 17 6 4 3补充说明 17 7数据 库 结构设计数据 库 结构设计 17 7 1逻辑结构设计要点 17 7 2物理结构设计要点 18 8部署设计部署设计 18 9运行设计运行设计 19 9 1运行模块组合 19 9 2运行控制 19 9 3运行目录结构 19 10性能设计性能设计 19 11系统出错处理设计系统出错处理设计 19 11 1出错信息 19 11 2补救措施 19 11 3系统维护设计 20 11 4错误处理设计 20 12开发环境开发环境 20 13尚未解决的问题尚未解决的问题 20 多通道同步数字记录仪升级换代 系统设计说明书 第 页 2 1 引言 项目背景简介 1 1 编写目的 本系统设计说明书用于描述 XXXXXXX 项目的整体系统设计方案 本说明书 以 用户需求说明书 和 系统需求规格说明书 作为依据 本说明书是系统 详细设计的依据 也作为系统测试需求和系统测试计划和测试程序的重要参考 本用户需求说明书的阅读对象为 项目经理 开发工程师 测试工程师 CM 工 程师 QA 工程师 MA 工程师 1 2 项目背景 应包括 项目的委托单位 开发单位和主管部 该软件系统与其他系统的关系 1 3 定义 CSCI Compute Software Config Item XXXXX XXXXXXXXXX 1 4 参考资料 XXXXXXX 项目系统需求规格说明书 张三 2010 年 11 月 XXXXXXX 项目 项目开发计划 张三 2010 年 11 月 多通道同步数字记录仪升级换代 系统设计说明书 第 页 3 2 条件与限制 列出设计所基于的前提条件和约束 如 1 需求约束 该约束由系统设计人员从 用户需求说明书 和 系统 需求规格说明书 中提取需求约束 例如 a 本系统应当遵循的标准或规范 b 软件 硬件环境 包括运行环境和开发环境 的约束 c 接口 协议的约束 d 用户界面的约束 e 软件质量的约束 如正确性 健壮性 可靠性 性能 易用性 安 全性 可扩展性 兼容性 可移植性等等产品质量需求 2 隐含约束 这类约束指的是并没有在需求文档中明确指出假设或依赖 但 可能会对系统设计产生影响 例如对用户教育程度 计算机技能的一些假设或 依赖 对支撑本系统的软件硬件的假设或依赖等等 3 需求规定 概要说明用户的需求和软件的需求规定 系统能实现同步记录16 512路话音 1 64路原始雷达 1 100路景 象数据 系统应能实时监控系统的工作状态和报警状态 系统应具备根据外接时钟源对系统的各个主机主动校时的功能 系统应具备用户分级权限控制功能 系统应提供回放话音雷达数据的离线工具 详细需求参见 系统需求规格说明书 4 运行环境 4 1 硬件环境 说明软件运行时的硬件环境 诸如 网络 通信设备 服务器 终端 打 印机等环境 多通道同步数字记录仪升级换代 系统设计说明书 第 页 4 硬件平台为 P4 2 8G 以上的工业控制机 网络为 1000M 以太网 话音记录 使用公司自制的 ADPCM 卡和话音接口箱 雷达记录使用公司自制的雷达接口箱 和 MOXA 公司的 218 卡 系统控制单元和远程单元需本机普通声卡支持 4 2 软件环境 说明软件运行时的软件环境 诸如 操作系统 数据库 服务 支持软件 等环境 系统记录单元和控制单元的操作系统为 LINUX 2 6 内核 远程单元的操 作系统为 LINUX 2 6 内核 或 WINXP 系统 离线工具的操作系统为 LINUX 2 6 内核 或 WINXP 系统 5 体系架构 5 1 系统结构 着重从硬件 诸如网络 服务器 终端 打印机等 方面 用图形和文字 方法描述系统的结构 系统总体物理结构图如图 5 1 1 所示 记录单元二 记录单元一 话音信号 冗冗余余记记录录单单元元一一 记录单元四 记录单元三 冗冗余余记记录录单单元元二二 冗冗余余记记录录单单元元X X 记录单元十五 记录单元十五 冗冗余余记记录录单单元元八八 话音接口 记记录录单单元元 用用户户话话音音系系统统 用用户户雷雷达达输输入入 接接口口 雷达接口 用用户户外外部部A AT TC C 雷雷达达回回送送接接口口 雷达数据 记录信号 雷达数据 回送信号 A AT TC C景景象象数数据据 接接口口 A AT TC C网网络络雷雷达达 数数据据接接口口 控控制制单单元元一一 控控制制单单元元 控制单元二 控控制制单单元元二二 控制单元一 远远程程控控制制单单元元一一 远远程程控控制制单单元元 远程控制单元一 远远程程控控制制单单元元X X 远远程程控控制制单单元元八八 远程控制单元八 记录仪内部网络 席位景象 数据 网络雷达 数据 图图 5 1 1 系统总体物理结构图系统总体物理结构图 系统由 组成 各个主机节点功能 多通道同步数字记录仪升级换代 系统设计说明书 第 页 5 5 2 软件架构 着重从软件架构 诸如现有的系统 子系统 层等 方面 用图形和文字方法 描述系统的软件结构 话音记录原始雷达记录 景象 网络数据 记录 记录单元控制 系统控制 控制单元界面 记记录录单单元元 离线工具 控控制制单单元元远远程程单单元元 记录单元界面 雷达处理与显示话音解码与播放 远程控制 远程单元界面 离线工具 雷达处理与显示话音解码与播放 图图 5 1 2 系统总体软件结构图系统总体软件结构图 1 记录单元 系统记录单元由话音记录软件 原始雷达记录软件 景象 网络数据记录软 件 记录单元控制软件和可选的记录单元人机界面软件组成 话音记录软件负责话音数据的输入 加密 索引和记录写盘 2 控制单元 系统控制单元由系统控制软件 控制单元界面软 离 组成 系统控制软件负责对全系统各个单元的状态搜集 用户命令的发 送 转发 3 远程单元 系统远程单元由远程控制软件 远程单元界面软 组成 远程控制软件负责对全系统各个单元的状态搜集 用户命令的发 送 命令响应的处理 多通道同步数字记录仪升级换代 系统设计说明书 第 页 6 6 逻辑结构设计 CSCI 1 记记录录单单元元记记录录与与控控制制 进进程程组组 RecUnitRecCtrl CSCI 2记记录录单单元元状状态态 MdslStatus CSCI 5 控控制制单单元元控控制制 进进程程 MdslSysControl CSCI 7 控控制制单单元元界界面面 进进程程 ControlUnitMMI CSCI 6 远远程程单单元元控控制制 进进程程 DistUnitCtrl CSCI 3 系系统统状状态态 SysControlStatus CSCI 8 远远程程单单元元界界面面 进进程程 DistUnitMMI CSCI 4 网网络络与与公公共共基基础础支支持持 BasicPublic CSCI 9 离离线线工工具具包包 进进程程 ToolPack CSCI 10 雷雷达达处处理理与与显显示示 包包 进进程程组组 RdpSdd CSCI 11 话话音音解解码码与与播播放放 包包 库库 VoiceDecodeAndPlay CSCI 12 远程数据同步代理 进进程程 DistPlayAgent 本本CSCI系系重重用用 管管制制系系统统项项目目相相关关 模模块块 本本项项目目不不进进行行开开发发 CSCI 13 记记录录单单元元界界面面 进进程程 RecUnitRecCtrl 图图 6 1 系统顶层软件结构图系统顶层软件结构图 如图 6 1 所示 系统由 13 个顶层软件模块组成 CSCI 1 RecUnitRecCtrl 记录单元记录与控制 实现 本 CSCI 将进 一步划分 其子模块划分见图 6 2 CSCI 2 MdslStatus 记录单元状态 实现 CSCI 3 SysControlStatus 系统状态 实现对全系统各记录单元 CSCI 4 BasicPublic 网络与公共基础支持 实现对公用网络数据包的定 义 实现 多通道同步数字记录仪升级换代 系统设计说明书 第 页 7 CSCI 1 1 话话音音记记录录 进进程程 VoiceRecord CSCI 1 2 原原始始雷雷达达记记录录 进进程程 RadarRecord CSCI 1 3 景景象象 网网络络记记录录 进进程程 ScreenRecord CSCI 2记记录录单单元元状状态态 库库 RecUnitStatus CSCI 4 网网络络与与公公共共基基础础支支持持 库库 BasicPublic 注注 灰灰色色包包为为其其他他 CSCI定定义义 CSCI 1 4 记录单元控制 进进程程 UnitControls CSCI 1 5 记记录录进进程程守守护护 RecUnitKeeper 图图 6 2 CSCI 1 RecUnitRecCtrl 模块分解图模块分解图 如图 6 2 所示 CSCI 1 RecUnitRecCtrl 由 4 个软件模块组成 CSCI 1 1 VoiceRecord 话音记录 实现 CSCI 1 2 RadarRecord 原始雷达记录 实现 CSCI 1 5 RecUnitKeeper 记录单元守护 实现记录单元 6 1 CSCI 列表 表表 6 1 1 全系统全系统 CSCI 列表列表 多通道同步数字记录仪升级换代多通道同步数字记录仪升级换代 模块名称 标识功能简述 多通道同步数字记录仪升级换代 系统设计说明书 第 页 8 CSCI 1 1 VoiceRecord 话音数据记录 进程 CSCI 1 2 RadarRecord 原始雷达记录 进程 多通道同步数字记录仪升级换代 系统设计说明书 第 页 9 6 2 CSCI 关系图 参见图 6 1 图 6 2 图 6 3 6 3 CSCI 1 1 话音数据记录 VoiceRecord 6 3 1 模块名称 话音数据记录 进程 VoiceRecord 6 3 2 功能描述 实现对外部输入的话音数据的采集 记录 话音通道记录状态的维护 单 元记录相关的告警状态的维护 具体功能如下 根据实际话音卡通道数和读取话音通道参数决定本单元实际话音记录 通道数 维护话音通道状态 有信号状态 本 CSCI 和其他 CSCI 的关系图如图 6 3 2 16 3 2 1 CSCI 1 1 话话音音记记录录 进进程程 VoiceRecord CSCI 2记记录录单单元元状状态态 库库 RecUnitStatus CSCI 4 网网络络与与公公共共基基础础支支持持 库库 BasicPublic CSCI 1 4 记录单元控制 进进程程 UnitControls CSCI 1 5 记记录录进进程程守守护护 进进程程 RecUnitKeeper 图图 6 3 2 1 CSCI 1 1 话音数据记录包外部关系图话音数据记录包外部关系图 多通道同步数字记录仪升级换代 系统设计说明书 第 页 10 6 3 3 接口描述 6 3 3 1 输入接口 话音记录数据输入 1 输入条件 当处话音通道记录使能时 周期性 XXXms 从话音卡输入 2 传递消息定义 BYTE 单周期 XXXms 通道记录数据 最大话音记录长度 1 DWORD 单周期 XXXms 实际记录数据长度 注 1 最大话音记录长度 XXX 3 传输方式 驱动程序系统调用 话音通道状态 1 输入条件 周期性从 CSCI 2 记录单元状态 输入 XXXms 2 传递消息定义 参见 CSCI 2 记录单元状态有关话音通道状态的定义 3 传输方式 函数调用读取 共享内存 XXXX 控制指令 1 输入条件 A XXXXX 时 由 CSCI 1 4 记录单元控制进程 输入 2 传递消息定义 BYTE 指令类型 暂停回放 继续回放 停止回放 3 传输方式 共享内存 多通道同步数字记录仪升级换代 系统设计说明书 第 页 11 6 3 3 2 输出接口 话音数据索引文件 1 输出条件 周期性 XXXms 写入文件缓存区 周期性 Xs 写入物理主存储区 2 传递消息定义 文件格式定义和文件保存路径见 7 1 3 传输方式 输出至文件系统 6 3 4 流程描述 6 3 4 1 话音记录初始化流程描述 XXXX 流程如图 6 3 4 1 1 所示 话音数据记录进程由 CSCI 5 记录进程守 护进程创建 XXXXXXXXX 主要用活动图 顺序图 多通道同步数字记录仪升级换代 系统设计说明书 第 页 12 话音采集卡驱动CSCS 1 1 话音数据记录CSCI 2 记录单元状态CSCI 1 5 记录进程守护 创建进程 读取话音通道记录通道数参数 话音通道记录通道数参数 话音卡打开 话音使能 话音通道状态和告警设置 读取话音通道记录压缩比参数 话音通道记录压缩比参数 实际安装话音卡数 话音卡话音通道记录压缩比参数设置 读取话音通道记录静音门限参数 话音通道记录静音门限参数 读取话音通道记录AGC参数参数 话音通道记录AGC参数参数 话音卡话音通道记录静音门限参数设置 话音卡话音通道记录AGC参数设置 图图 6 3 4 1 1 话音记录初始化序列图话音记录初始化序列图 6 3 4 2 话音记录流程描述 话音数据记录流程如图 6 3 4 2 1 所示 其中图中话音数据索引文件 话 音数据文件 通话时间记录文件的目录结构定义和数据结构定义见 7 1 节 本 CSCI 负责根据通道实际数据情况更新 CSCS 2 的 通道当前是否有信号状态 根据实际写盘情况负责更新 CSCS 2 当前主机主存储设备存储空间溢出告警 多通道同步数字记录仪升级换代 系统设计说明书 第 页 13 话音采集卡驱动CSCS 1 1 话音数据记录CSCI 2 记录单元状态 操作系统 文件系统 本地话音通道状态 系统告警 周期 480ms 话音数据索引文件 话音数据文件 通话时间记录文件 文件系统物理存盘 周期性强制 数据文件物理写盘 周期 5s 话音记录数据输入 电话通道摘挂机 电话通道来去电读取通话最短时间长度和最大静音持续时间长度参数 本地话音通道状态 系统告警 话音数据索引文件 话音数据文件 通话时间记录文件 话音记录数据输入 电话通道摘挂机 电话通道来去电读取通话最短时间长度和最大静音持续时间长度参数 本地话音通道状态 系统告警 话音数据索引文件 话音数据文件 通话时间记录文件 话音记录数据输入 电话通道摘挂机 电话通道来去电 读取通话最短时间长度和最大静音持续时间长度参数 生成数据索引文件 生成数据文件 判断通话开始 结束 图图 6 3 4 2 1 话音记录序列图话音记录序列图 电话通道判断通话开始结束和写通话时间记录文件的活动图如图图 6 3 4 2 2 读取电话通道摘挂机状态 保存当前时间为本次通话起始时间 摘机状态由挂机变为摘机 保存当前时间为本次通话结束时间 摘机状态由摘机变为挂机 读取来去电号码 写本次通话信息至通话时间记录文件 通话长度大于最短通话长度参数 读取最短通话时间长度参数 图图 6 3 4 2 2 电话通道判断通话起止活动图电话通道判断通话起止活动图 多通道同步数字记录仪升级换代 系统设计说明书 第 页 14 6 3 4 3 XXX 命令流程描述 6 3 5 补充说明 6 4 CSCI 4 网络与公共基础支持 BasicPublic 6 4 1 模块名称 网络与公共基础支持 库 BasicPublic 6 4 2 功能描述 实现网络与公共基础支持 实现对公用网络数据包的定义 实现对线程和 进程同步类 实现本单元日志记录与访问 实现本单元数据文件路径的定义 数据文件的搜索与定位 定义本概要设计说明书中各 CSCI 之间 UDP 接口的数据结构 实现本单元日志的读写和查询 定义记录单元的话音数据文件 话音索引文件 通话时间记录文件的 存储路径和文件名 封装 LINUX 下线程之间或进程之间的实时排队信号传递 封装 LINUX 下线程互斥锁和线程信号量 封装 LINUX 下进程互斥锁和进程信号量 封装 LINUX 下进程共享内存的访问 封装 LINUX 下线程数据列表和进程数据列表的访问 多通道同步数字记录仪升级换代 系统设计说明书 第 页 15 6 4 2 1 输入接口 话音数据相关文件路径查询 1 输入条件 A CSCI 1 1 话音数据记录 初始化时主动读取 B CSCI 1 1 话音数据记录 在每新小时更换记录文件名 数据文件 索 引文件 时读取 2 传递消息定义 TIME 32 查询数据时间 BYTE 存储区类型 主存储区 备份存储区 还原存储区 3 传输方式 函数调用 6 4 3 补充说明 7 数据 库 结构设计 7 1 逻辑结构设计要点 描述适应性数据 文件系统 数据库的逻辑结构和物理结构 对每一项均 需给出逻辑结构设计要点和物理结构设计要点 1 逻辑结构设计要点 列出本系统内所使用的每一项的基本属性 如名称 标识符以及它们之中 每个数据项 记录 文卷和系的标识 定义 长度及它们之间的层次的或表格 的相互关系 2 物理结构设计要点 给出本系统内所使用的每一项的诸如存储要求 访问方法 存取单位 多通道同步数字记录仪升级换代 系统设计说明书 第 页 16 存取的物理关系 索引 设备 存储区域 设计考虑和保密条件等内容 记 录单元保存记录的话音 雷达 景象 网络数据文件的主数据目录结构如图 7 1 1 dataday01voice radar net screen day31 day02 day01 day31 day02 day01 day31 day02 day01 day31 day02 hour01 hour31 station01 stationX station02 voice20090701 00 dat voice20090701 00 inx voice20090701 01 dat voice20090701 01 inx voice20090701 23 dat voice20090701 23 inx radar20090702 00 dat radar20090702 00 inx radar20090702 01 dat radar20090702 01 inx radar20090702 23 dat radar20090702 23 inx radar ini hour01 hour31 net01 netX net02 Voice20090701 phn 根目录 雷达 话音 数据文件和数据索引文件 每一小时创建 话音通话时间记录文件 每一天创建 网络数据文件 每个通道单独保存 ATC系统完成 景象数据文件 每个席位单独保存 ATC系统完成 图图 7 1 1 记录数据文件目录结构记录数据文件目录结构 7 2 物理结构设计要点 8 部署设计 可用部署图描述用来部署和运行软件的一种或多种物理网络 硬件 配 置 对于每种配置 至少应该指出执行该软件的物理节点 计算机 CPU 及 其互连情况 总线连接 LAN 连接 点到点连接等 另外还要包括运行设计 中的各进程 如果有的话 和公用库到物理节点的映射 注 当软件的部署一目了然 本节可选 多通道同步数字记录仪升级换代 系统设计说明书 第 页 17 9 运行设计 9 1 运行模块组合 描述对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合 说明每种运行所历经的内部模块和支持软件 9 2 运行控制 描述每一种外界的运行控制的方式方法和操作步骤 9 3 运行目录结构 描述系统运行所涉及的程序 配置文件 其它数据文件的目录结构 如 bin resource public 10性能设计 描述为了达到需求中规定的性能要求而进行的特殊设计和专门的处理方法 11系统出错处理设计 11 1出错信息 描述各种可能的出错或故障情况出现时 系统输出信息的形式 含意及处 理方法 如 进程退出后 监控席变红显示 显示错误信息等 哪些主要错误 要进行哪些提示 本系统采用异常处理机制 当遇到异常时不但能够及时处理 保证程序的 安全性和稳定性 而且各种出错信息能通过弹出对话框的形式 即使的告诉用 户出错的原因及解决的办法 使用户能够减少错误的发生 程序的大部分地方 还采取了出错保护 如输入内容的长度和类型等减少了用户出错的可能 多通道同步数字记录仪升级换代 系统设计说明书 第 页 18 11 2补救措施 说明故障出现后可能采取的变通措施 包括 a 后备技术说明准备采用的后备技术 当原始系统数据万一丢失时启用的 副本的建立和启动的技术 例如周期性地把磁盘信息记录到磁带上去就是对于 磁盘媒体的一种后备技术 b 降效