TSView监控系统软件客户端主控台模块设计说明书.docx

TIANSUTSView监控系统软件客户端主控台模块设计说明书评审记录对TSView监控系统软件客户端主控台模块设计说明书VI.三的评审意见:1 .添加关于主界面方案选择的设计决策。上述问题修改验证后，由验证后，本文件即可发布。评审人员签字:问题修改验证结果:验证人签字:时间:.年一月日变更日志编号版本修改内容修改人修改日期0.1初版作成耿桦2010/10/181.0内部评审后修正耿桦2010/10/221引言11.1 编写目的11.2 背景113定义11.4 参考资料12 总体设计22.1 需求规定22.1.1 主角22.1.2 系统边界22.2 运行环境32.2.1 硬件环境32.2.2 软件环境32.3 概要设计决策32.3.1 设计原则32.3.2 设计决策32.4 开发环境43 模块设计53.1 初始化和登录模块53.1.1 模块说明53.1.2 模块设计53.1.3 数据规格73.1.4 出错消息73.2 主界面模块83.2.1 模块说明83.2.2 模块设计83.3 系统配置模块93.3.1 模块说明93.3.2 模块设计93.4 通讯管理功能103.4.1 模块说明103.4.2 模块设计103.4.3 流程图113.4.4 通讯报文113.5 公共模块123.5.1 模块说明123.5.2 模块设计124 质量要求164.1 性能要求164.1.1 数据库性能要求164.1.2 其他要求164.2 功能测试要求164.2.1 测试内容164.2.2 测试方法161引言1.1 编写目的本文档是对TSView监控系统软件的客户端主控台模块的需求规格进行详细分析和讨论后得出的概要设计和详细设计说明书，旨在明确系统客户端主控台模块的设计目标。通过本设计说明书，可以了解到EIB监控系统软件的客户端主控台模块开发的技术路线、功能边界、模块的界面设计、详细的输入输出等。本文档面向的读者是：TSVieW监控系统软件的客户端主控台模块的开发人员及测试人员，TSView监控系统软件的客户端主控台模块概要和详细设计说明书的评审人员。1.2 背景软件名称：TSView监控系统软件的客户端主控台软件模块。TSView监控系统软件采用C/S架构设计，客户端主控台模块主要作为客户端所有应用软件的主控和调度模块。主要包括：客户端初始化和登陆模块、主控台主界面和应用软件的管理模块、系统配置模块，另外还提供一些公用模块如和服务器端的通讯模块。1.3 定义下表列出本报告中专门术语的定义、英文缩写词的原词组和意义、项目组内达成一致意见的专用词汇,同时继承全部的先前过程中定义过的词汇。词汇名称词汇含义备注EIBEuropeanInstallationBusKNXKonnexETSEIBToolSoftware1-4参考资料编号资料名称说明1TSVieW监控系统软件研发项目需求规格说明书2GB/Z20965-2007住宅和楼宇控制系统3TSView监控系统软件数据库设计说明书2总体设计2.1 需求规定2.1.1 主角(1) EIB网关系统服务软件通过ElB网关实现对EIB总线系统的通讯，ElB网关包括E1B/RS232网关、E1B/USB网关以及EIB/IP网关三种，全部需是符合EIB标准经过认证的设备，系统服务软件通过集成FalCon通讯组件包实现与EIB网关的通讯。(2) ElB通讯群组在EIB总线标准中定义了实现具体通讯功能的通讯群组，系统服务软件也需要按照标准定义通讯群组功能并通过EIB网关收发总线数据，实现ETB总线设备状态的监视和控制。(3) 应用服务软件应用服务软件是系统服务软件的客户端，应用服务软件与系统服务软件通过以太网TCP通讯链接，通过已定义的标准通讯帧格式实现数据的查询与修改。应用服务软件包括实时图表显示、数据库配置工作、历史数据查询、实时声光告警等功能，系统服务软件为应用服务软件提供数据和通讯服务，应用服务软件为系统服务软件提供人机操作接口。(4) 工程调试人员工程调试人员实现系统服务软件的安装部署，通过数据库配置工具进行工程配置，并通过系统服务软件写入的磁盘数据库并同步到实时内存库。(5) 其他系统服务软件在主备冗余系统结构中与其他系统服务软件之间通过通讯方式进行心跳、数据同步等操作。2.1.2 系统边界本模块应该具备以下功能：(1)客户端初始化和登陆模块；(2) 主控台主界面和应用软件的管理模块；(3)系统配置模块；(4)和服务器端的组播、单播通讯模块。(5) 公共模块2.2 运行环境2.2.1 硬件环境硬件环境类别要求备注CPU2.OMHZ及以上内存IGB及以上硬盘IoGB及以上以太网口1个或更多2.2.2 软件环境软件环境类别要求备注操作系统Windows2000或WindowsXP数据库软件SQLTTE3.6.22通讯库Falcon1.82.3 概要设计决策2.3.1 设计原则（1） 软件需要有一个良好的设计框架。为了软件能适应未来几年的现场需要，软件应该根据实际需要保持一定的可扩展，这就要求系统升级时对已基于该系统实施的系统兼容，软件设计必须有良好的设计框架。其中包括：第一、多采用复用技术。第二、底层业务模块相对独立，低耦合度。第三、保持业务模型稳定，表现出来就是InIerfaCe稳定。（2）软件需要具有持续开发，功能完善能力，具有良好的向前兼容性。考虑到目前该软件模块使用对象的实际操作水平以及需求，软件开发不可能一步到位，但是必须考虑到未来的需求，目前系统必须为以后的功能完善，扩展留有充分的接口，系统具有良好的向前兼容性。2.3.2 设计决策本节记录对概要设计具有重要影响的软件需求和约束，描述相关的重要决策和决策的原因。这些决策一般对设计有很大影响,它们的改变很难通过设计技巧来屏蔽，例如所选用的开发语言,所选用的平台、组件和框架，对关键业务，类和方法的处理等。（1）决策1：主控台界面的设计选择设计决策主控台界面的选择标识号ADOl问题描述采用哪种界面Ul设计假设条件可选方案1、类似TebiS软件的主界面2、类似NTS-900M的主控台决策2理由1、海格的TebiS软件，采用了OUtlook风格的控制面板，来管理各个子软件模块，有一定的方便性。但是天溯以往的软件产品没有采用过类似的界面来作为主控台。2、采用类似NTS-900M的主控台，界面美观。而且可以和NTS-90OM保持一定程度的风格延续性，对于用户来说友好性更佳，学习代价也更低。对于成熟的商业软件组件，保持风格的一致性也是一个重要原则。基于以上分析，决定本次TSViCW客户端采用类似NTS-900M的主控台界面。另外，由于ElB软件主要应用于民用领域，没有配电系统那么高的安全性要求，因此本次主控台不提供桌面锁定功能。对于终端用户而言，操作起来也更方便。影响复用NTS-900M的主控台界面，具体设计根据TSVieW项目作相应调整。其他客户端软件的配色，也应照顾到和主控台配色的搭配，不应反差太大。相关决策无2.4 开发环境开发用机器类别要求备注CPU内存主机硬盘网卡USB口2.OGHZ或以上最少IGB最少80GB10100Mbs至少1个软件环境类别操作系统开发软件数据库软件通讯库要求WindowsXPMicrosoftVisualC+6.0SQLlTE3.6.22Falcon1.8备注3模块设计3.1 初始化和登录模块3.1.1 模块说明负责系统客户端主程序的启动和初始化工作，完成用户登录，以及和服务器建立连接。3.1.2 模块设计(1)登录画面每次启动客户端，都会弹出如下所示的登录界面。用户名登录用户名。密码登录密码。让系统自动检测服务器客户端会尝试主动发现服务器，并尝试建立连接。默认选中。手动填写服务器信息服务器地址服务器端口选择此radio,则手动填写地址。服务器IP地址。服务器侦听端口。确定取消确定登录。取消登录，退出系统。(2)登陆出错画面-如果用户输入错误(包括用户名空，超长等)，将弹出如下的错误消息框。-用户点击确定且输入无误后，系统将自动尝试连接服务器。在自动检测服务器模式下，如果连接失败，将弹出如下消息框。确定返回登录画面,并自动选中手动填写服务器信息,让用户手动配置地址。-在手动配置服务器地址模式下，如果连接失败，弹出如下消息框。-连接服务器成功，但用户身份验证失败。-身份验证通过，但是服务器忙，或已达到最大连接数。显示/隐藏错误详细信息。返回。重新尝试连接服务器。详细确定重试登陆成功后，将打开主控台界面。3.1.3数据规格(1)登录画面数据名说明规格说明m_strUserName用户名字符串。非空，最大长度30。m_strPassword密码字符串。非空，最大长度15。m_nAutoIP自动检测，或手动配置地址整型，。或1。m_dwServerlP服务器IPDWORDom_nPort服务器端口整型，范围(0-65535)。3.1.4出错消息(1)用户错误消息ID中文消息英文消息说明IDS_ERR_NAME_NUL1.用户名不能为空！Pleaseinputtheusername!用户名为空时报告该错误。IDS_ERR_NAME_MAXCHAR用户名不能超过30个英文字符，或10个汉字。Theusernamecannotcontainmorethan30alphabetcharacters,or10Chinesecharacters.用户名超长时报告该错误。1DS_ERR_PSWD_MAXCHAR密码不能超过15个字符。Thepasswordcannotcontainmorethan15密码超长时报告该错误。alphabetcharacters.IDS_ERR_IP_NULL手动配置服务器地址时，IP不能为空。PleaseinputtheserverIP.IP为空时报告该错误。IDS_ERR_PORT_NULL手动配置服务器地址时，端口不能为空。Pleaseinputtheserverport.端口为空时报告该错误。IDS_ERR_PORTJNVA1.ID端口号必须是大于0,小于65535的整数！Theportnumbermustbetween0and65535!端口不在有效范围内时报告该错误。(2)系统错误消息ID中文消息英文消息说明IDS_ERR_SERVER_NOTFOUND系统没有枪测到可用的服务器。请确认服务器已经启动，或手动配置.服务器地址。Noserverfound.Pleasemakesurethattheserverhasstarted,orconfiguretheserveraddressmanually.自动模式下,找不到可用的服务器时报错。1DS_ERR_CONNECT_FAILED连接到服务器失败，请确认服务器已经启动。Connectingtoserverfailed.Pleasemakesurethattheserverhasstarted.无法连接用户指定的服务器时报件IDS_ERR_MAXNUM客户端连接数目已达到系统支持上限(20)。请尝试关闭一些不用的TSVieW客户端软件后重试，或稍候再试。Thenumberofclientshasreached(heupperbound.PleaseclosesomeunusedTSViewclientsorre-trylater.服务器连接数已达上限时报错。3.2 主界面模块3.2.1 模块说明该模块提供主控台的主界面。该主界面为用户提供了访问客户端各个模块的统一接口，并提供关闭所有客户端软件的功能。3.2.2 模块设计(1)主界面数据配置打开EIB数据配置软件。TIANSUTSVieW监控系统软件客户端主控台模块设计说明书日历配置图元编辑图表绘制实时图表实时告警历史数据系统配置退出系统打开日历配置软件。打开图元编辑软件。打开图表绘制软件。打开实时图表软件。打开实时告警软件。打开历史数据查询软件。系统选项配置(详见下节)。退出系统，关闭所有客户端软件。此外，左上角的图钉型按钮，可以用来控制主控台是否自动隐藏。3.3 系统配置模块3.3.1 模块说明该模块提供系统配置功能，包括网络连接选项、语言选项、用户管理等。3.3.2 模块设计(1)系统配置一一网络连接主控台上如果选择系统配置,则弹出如下图所示的对话框.用户可以选择手动配置服务器地址。手动配置服务器地址Checkboxo服务器地址默认会显示系统检测到的服务器地址，但用户可以手动修改。服务器端口服务器端口。确定保存修改，并关闭对话框取消不保存，并关闭对话框应用保存修改。(2)系统配置语言系统支持两种语言：简体中文和英文。如下所示，可以进行配置。简体中文默认选项。选此项时系统使用简体中文。英语选此项时系统使用英语。保存语言选项后，需要重新启动TSVieW以使得修改生效。3.4 通讯管理功能3.4.1 模块说明实现客户端的通讯功能，包括组播和单播通讯。该模块作为公共模块，将封装成动态库，提供给所有客户端软件使用。3.4.2 模块设计EIB监控系统采用C/S架构。(1) .各应用节点(每个客户端应用都是一个单独的通讯节点)初始化时分别加入到同一组播组中，并向组播组指定端口发送登陆报文，在启动信息中表明本机的通讯设置，以及验证信息(用户名、密码)。(2) .组播组中，只有系统服务器收取该报文，而其他节点均忽略该保文。(3) .服务器验证通过后，向组播组回复一帧服务器确认报文，该报文中应该包含服务器TCP服务端口信息，如果服务器忙或者超过指定连接数量，服务器应回复忙帧要求该应用节点等待。10(4) .应用节点收到登陆确认报文以后，主动建立TCP客户端并发起对主服务器的访问请求，实现与服务器之间的通讯建链。至此，单播建立完成。(5) .如果应用节点在多次发送启动信息无回复后，应提示服务器无连接，退出启动过程。在应用节点断链后，系统服务器软件执行清理工作，更新节点状态。上述第(2)步，如果服务器未加入组播组，即服务器的运行模式为单机模式。则客户端判断超时后，尝试以TCP连接本地服务器，如果失败，则报告用户找不到服务器。3.4.3 流程图初始化连接的过程如下面的流程图所示。3.4.4 通讯报文通讯报文在服务器端设计说明书中已经有描述。请参照相关章节。3.5 公共模块3.5.1 模块说明该模块将多个软件可能会免用的子功能和子模块抽取出来，封装成独立的动态库。这种设计的好处是，提高软件的复用性，以及可维护性，同时便于系统维护统一的风格。公共模块包括登录对话框（3.1节已描述）、消息提示对话框、进度对话框，UniCode编码转换类，XML读写类，通讯线程类（3.4节已描述），以及报文收发类。3.5.2 模块设计（1）消息提示对话框TSView中所有软件需要向用户弹出消息提示窗口，都应该使用该类提供的对话框。该类支持所有WindowsAPIMCSSagCBOX支持的六种按钮风格。包括：编号风格说明1MB_CANCELTRYCONTINUEI取消、重试、继续三按钮2MB_OKI确认单按钮3MB_OKCANCE确认、取消双按钮4MB_RETRYCANCEL重试、取消双按钮5MB_YESNO是、否双按钮6MBeYESNOCANCELI是、否、取消三按钮以及四种ICon,和对应的音效。编号风格说明1MBCoNWARNlNG警告！2MBCONlNFoRMZmoN信息！3MB_ICONQUESTION提问？4MB_ICONERROR错误！另外，对于错误提示框，要求尽可能提供详细信息，以帮助用户了解错误原因，以及如何解决错误或者从错误中恢复。带详细信息的错误提示框，如下图所示。用户可以选择显示/隐藏详细信息窗口，但默认打开。对于没有详细信息的错误框，则详细按钮灰化。(2)进度对话框TSViCW中所有客户端与服务器的交互都是异步完成的。因此当客户端提交查询，或者提交更新请求的时候，有可能是一个长时间操作。对于查询操作等需要查询结果用于Ul显示的情况，可以弹出进度窗口，让用户等待。(对于更新操作，可以不弹出进度框)取消用户可以选择取消按钮，中止之前的操作，并返回。这样，之前的查询结果就不会返回给用户。(3) Unicode编码转换类TSView中，所有程序将直接使用UniCOde来管理所有字符串。但配置文件、数据库，以及报文传输都使用UTF8编码。因此，提供CUniCode类，来完成UniCode和UTF8编码之间的互相转化。类名CUnicode上要属性更明无主要方法说明UniCode转UTF8编码：staticBOOLUnicodeToUTF8(LPWSTRwszUtfl6,LPSTRszUtf8,intnUtf8Size);UTF8转UniCOde编码：staticBOOLUTF8ToUnicode(LPSTRszUtf8,LPWSTRszUtfl6,intnUtf16Size);(4) XML读写类提供CXMLSettings类，来完成简单的XML读写功能。类名CUnicode主要属性说明无主要方法说明写XML文件：BOOLWriteXMLToFile(LPCTSTRIpszFileName);读XML文件：BOOLReadXMLFromFile(BOOLblsReadOnly,LPCTSTRIpszFiIeName);写指定字段：virtualBOOLWrite(LPCTSTRpszKey,intiVal);virtualBOOLWrite(LPCTSTRpszKey,DWORDdwVal);virtualBOOLWrite(LPCTSTRpszKey,LPCTSTRpszVal);virtualBOOLWrite(LPCTSTRpszKey,CWordAayifcwcArray);virtualBOOLWrite(LPCTSTRpszKey,constCRect&reel);virtualBOOLWrite(LPCTSTRpszKey,LPPOINT&IpPoint);virtualBOOLWrite(LPCTSTRpszKey,LPBYTEpData,UINTBytes);virtualBOOLWrite(LPCTSTRpszKey,CObject<feobj);virtualBOOLWrite(LPCTSTRpszKey,CObject*pbj);读指定字段：virtualBOOLRead(LPCTSTRpszKey,int&iVal);virtualBOOLRead(LPCTSTRPSZKey,WORD&wVal);virtualBOOLRead(LPCTSTRpszKey,DW0RD&dvVal);virtualBOOLRead(LPCTSTRpszKey,CString&sVal);virtualBOOLRead(LPCTSTRPSZKey,CWordArray<fewcArray);virtualBOOLRead(LPCTSTRpszKey,LPPOINT&IpPoint);virtualBOOLRead(LPCTSTRPSZKey,CRect&rect);virtualBOOLRead(LPCTSTRpszKey,BYTE*ppData,UINT*pBytes);virtualBOOLRead(LPCTSTRpszKey,CObject&obj);virtualBOOLRead(LPCTSTRpszKey,CObjeel*&pbj);4质量要求4.1 性能要求4.1.1 数据库性能要求(1)千条数据事务性插入数据库操作所用时间ls(2)万条数据查询操作所用时间Ds4.1.2 其他要求(1)告警服务的功能，最多记录存储128条已存告警信息，告警实时响应时间。秒。(2) 软件可用率：=99.98%；系统对时时间偏差小于50ms(3) 系统在7*24小时运行过程中，连续稳定运行，平均无故障时间大于30000小时。(4) 模拟量误差Vl相操作正确率达到100%；(5) CPU负荷率在正常状态下任意5分钟内小于10%,在任意10秒内小于30%o(6) 网络负荷率在正常状态下任意5分钟内小于10%,在告警状态下小于30%o(7)尽量减少内存泄露。(8) 添加多线程同步机制，杜绝出现并发死锁。4.2功能测试要求4.2.1 测试内容本系统的功能测试包括系统中即将实现的所有功能模块。4.2.2 测试方法功能测试采用黑盒测试方法开展功能测试。首先根据软件需求和本文档进行功能测试案例的设计，前期采用手工执行测试案例的方式进行，随着功能的稳定，对于系统关键的业务功能和业务流程，采用自动化的功能测试工具维护功能测试，提高回归测试的效率。后期进行压力测试，和长时间拷机。系统的稳定性是本系统关键性能指标，在功能测试中，是测试重点，需要全面的对正常数据、非法数据等等各种情况对功能进行测试。其他非关键功能，在测试进度和资源允许的情况下，也需要全面的测试，否则测试功能是否能够正常实现即可。