接口设计说明书v1.01
HRHIP接口设计说明(IDD)模板
XXX系统(HRHIP)V1.0(IDD)接口设计说明上海融达信息科技有限公司All rights reserved版权所有侵权必究RD-RHIP 接口设计说明（IDD ） 密级：秘密上海融达信息科技有限公司 － 2 / 7 －修订记录RD-RHIP 接口设计说明（IDD ） 密级：秘密上海融达信息科技有限公司 － 3 / 7 －目录1引言 ........................................................................................................................................................................... 4 1.1. 标识 ..................................................................................................................................................................... 4 1.2. 系统概述 .............................................................................................................................................................. 4 1.3. 文档概述 .............................................................................................................................................................. 4 1.4. 基线 (4)2. 引用文件 ······························································································································································ 43.接口设计 ······························································································································································ 4 3.1.接口标识和接口图 (4)4. X(接口的项目唯一标识符) ··································································································································· 55. 需求的可追踪性 ·················································································································································· 66.注解······································································································································································ 6 6.1.文档中使用的缩略语清单 (6)附录 (7)RD-RHIP 接口设计说明（IDD ） 密级：秘密上海融达信息科技有限公司 － 4 / 7 －1. 引言1.1标识本条应包含本文档适用的系统、接口实体和接口的完整标识，(若适用)包括标识号、标题、缩略词语、版本号、发行号。
SGB750说明书1-01(南自母差)
装置应能通过GB9254-1998规定的辐射发射限值A类试验。
4 保护原理说明
4.1母线差动保护
母线保护采用电流变化量和常规电流分相式电流差动保护原理，针对不同容量的电力系统不同故障类型的故障特征，设置“差电流快速突变启动”及“差电流慢速积分启动”等双启动方案；快速启动，判别迅速准确；慢速启动,确保动作灵敏度。
e)对于可能导致母线保护装置误动的小概率因素，例如，由于接入母线保护的各单元TA的特性不一致，在区外故障切除、不对称冲击负荷、系统解合环、并网、投切负荷等造成的不平衡差电流；TA断线造成的差电流；区外故障TA在2个周波以后再饱和造成的差电流等情况，SG B750系列母线保护从多方位采取预防为主的有效措施，确保母线保护装置不误动，整套装置的安全性很高。
3)母线发生区外故障而导致TA饱和，当TA饱和很严重时，以积分方式计算的差电流会大于动作门槛，同时也会超过比率制动的制动量，但由于饱和TA存在2ms及以上正确传变的时间，所以差电流是不连续而有间断点的，此时，由“轨迹扫描法”检测到的“差电流间断点”可以有效地防止电流差动保护误动。
“轨迹扫描法”对常规差电流的变化轨迹不间断地扫描监视，采用数学方法逐点整形处理，寻找“差流间断点”，判断是否区内故障，“轨迹扫描法”本质上并不判别TA是否饱和，所以，TA饱和（2ms及以上）对“轨迹扫描法”的判别并无影响，具有判别准确可靠的优点。
3.2.6.4浪涌（冲击）抗扰度
装置应能承受GB/T17626.5-1998规定的试验严酷等级为4级的浪涌（冲击）抗扰度试验，施加干扰期间，装置应无误动或拒动现象。试验后装置性能仍应符合规定。
3.2.6.5射频场感应的传导抗扰度
装置应能承受GB/T17626.6-1998规定的试验严酷等级为3级的射频场感应的传导抗扰度试验，施加干扰期间，装置应无误动或拒动现象。试验后装置性能仍应符合规定。
接口设计模板
<系统名称>接口设计说明书****科技有限公司修改历史目录1概述 (1)2子系统说明1 (1)2.1接口名NO.1 (1)2.2接口名NO.2 (1)1概述[概述说明本文档的描述的内容、目的、使用场合等。
]2子系统说明12.1接口名NO.1示例如下：接口功能：验证用户是否合法。
除部分特别说明不需要用户验证的接口外，此接口必须首先调用，否则会出现“未授权”的异常错误。
在验证成功之后才能成功调用其它接口，该接口验证通过的用户信息将保存到IHDUserSession类的实例中，作为其它接口调用的用户信息。
此接口在内部需要通过以下几点的验证：1.CA验证，验证USBKey是否合法（只有系统策略中设置了需要CA验证选项后才会进行CA的验证）；2.域用户验证，验证登录用户名和密码是否是域用户，通过Windows集成身份验证实现；3.用户数据库合法性验证，验证登录用户是否存在于USERS表中；4.计算机合法性验证，验证登录计算机是否存在于COMPUTER表中，计算机的验证通过计算机名，硬盘序列号，网卡物理地址，IP地址这四项的组合进行验证，具体组合可以系统策略中配置；5.如果验证未通过，返回false，并在客户端日志中记录登录失败的原因接口声明：***相关数据表：****输入参数：****输出参数：***返回值及异常：参见错误!未找到引用源。
错误!未找到引用源。
返回值不变。
捕获到异常，请对异常进行分析。
如果异常类型是***。
2.2接口名NO.2'. 接口功能：接口声明：相关数据表：输入参数：输出参数：返回值及异常：。
接口详细设计文档
.接口详细设计文档作者：唐为（为哥）审核：赵锟日期：2005-5-27接口详细设计文档 (1)1编写目的 (3)2名词解释 (3)3组件分布图 (4)4程序结构 (5)4.1接入处理线程类图 (5)4.2接收线程类图 (6)4.3启动控制图 (6)5程序设计说明 (7)5.1对原系统的改动 (7)5.2ThreadInSvcProcessor 接入处理器 (8)5.2.1类图 (8)5.2.2时序图 (9)5.2.3流程图 (9)5.2.4ThreadInSvcProcessor类说明 (11)5.3PatternNewSyncAsyncInnerDir 同异步向内处理模式 (16)5.3.1类图 (16)5.3.2描述 (17)5.3.3流程图 (17)5.3.4类说明 (19)5.4ThreadReplySvcProcessor 异步应答返回处理器 (24)5.4.1类图 (24)5.4.2类说明 (24)5.5ClientInfo 客户端连接数据 (33)5.5.1类图 (33)5.5.2类描述 (33)5.6ClientInfoTable 客户端连接数据表 (34)5.6.1类图 (34)5.6.2类描述 (34)5.7ClientInfoTableMonitor 客户端连接数据表监控程序 (38)5.7.1类图 (38)5.7.2类说明 (38)5.8FrontMain 主控程序 (40)5.8.1类间关系 (40)5.8.2流程图 (41)5.8.3类说明 (42)5.9问题 (44)1编写目的预期读者：对接口行为和目的有一定了解的人背景说明⏹软件系统名称：接口前端接入服务器⏹描述<接口> 接收不同商家的接入，接收数据转发给主机服务器，并同步/异步将返回数据发给接入商家的行为2名词解释⏹ChannelBase渠道,通信基类，提供数据收发和释放的方法接口用子类实现来封装了不同通信方式目前有TCP短连接接入，从ACE Message_Queue中读取（IPC MessageQueue-> ACE_Message_Queue）⏹Trade* trade商家对象，代表的其实是针对该商家处理方法的集合将接入数据的商家称为服务商家而将请求面向的商家称为主机商家，主机商家负责同步/异步返回交易的应答数据给接口平台⏹而接口（数据交换）平台是在两者之间的交换平台⏹渠道工厂：把接入数据的渠道工厂统一定为服务渠道工厂，发送数据的渠道工厂统一定为主机通道工厂4程序结构4.1接入处理线程类图Process() TradeOutProcess() ClearDataBus() CallHost() TradeInProcess()is_sync_return()is_same_rw_sv createClientInfo() addToClientInfoTable()PatternASyncInnerDir()Process()GetSelf()GetHostChannelObj()ProcessPattern()<<v<<v<<v<<v<<v<<v<<v<<v<<v<<vshm_mgr()res_mgr()SvGetChannel()TradeRecvTradeInProcess()ExecPattern()RequestSecureFailedProcess()ThreadInSv_trade_code : std::string<<v<<v<<vshm_mgr()_trade_code : char [TRADECODELEN+1]_trade_name : char [TRADENAMELEN+1]_compress_flag : SINT32_encry_flag : SINT32_trade_type : SINT32_err_times : SINT32_infun_ser : v_outfun_ser : v_pack_strategy : GenericFmlTranslaterInterface *4.2接收线程类图begin_time timeout_time trade_code : string interface_id : string pkggrp_id : int pkg_idx : int mutex : ACE_Thread_Mutexinstance_mutex : ACE_Thread_mutexgetInstance()addRecord()fetchRecord()clearTimeoutRecords()generateKey()cleanup()_trade_code : char [TRADECODELEN+1]_trade_name : char [TRADENAMELEN+1]_compress_flag : SINT32_encry_flag : SINT32_trade_type : SINT32_err_times : SINT32_infun_ser : vector< SINT32 >_outfun_ser : vector< SINT32 >_pack_strategy : GenericFmlTranslaterInterface *p_recv_trade : Trade*data_bus : DataBusb_exit : bool*SvcRun()GetRecvChannel(p_recv_trade : Trade*) : ChannelBase*TradeRecvData(p_chnbase : ChannelBase*, p_trade : Trade*, p_databus : DataBus*, p_timeout : ACE_Time_Value*) : intUnpackRecvData(p_databus : DataBus*) : intfetchClientInfoRecord(key : string) : ClientInfo*RecoverDataBusInfo(p_clientinfo_record : ClientInfo*, p_databus : DataBus*) : intgetTrade(trade_code : string) : Trade*TradeOutProcess(p_trade : Trade*, p_databus : DataBus*) : intCreateOutputChannel(out_trade : Trade*) : ChannelBase*TradeSendData(p_trade : Trade*, p_databus : DataBus*) : intThreadReplySvcProcessor(pTrade : Trade*, pFactory : SvcChannelFactory*, pBExit : bool*)_trade_code : std::string<<virtual>> GetChannel()<<virtual>> Initialize()<<virtual>> ~SvcChannelFactory()shm_mgr()4.3启动控制图FrontMain() startup()shutdown()ClientInfoTableMonitor ClientInfoTableMonitor()startup()shutdown()_trade_code : std::string <<v<<v<<vshm_mgr()_bexit : SINT32_v_trade_code : string_nthreads : SINT32 InteTask()Start()Stop()AddThread()~InteTask()<<static>> ThreadProc() CreateSvres_manager()SvGetChannel()TradeRecvTradeInProcess()ExecPattern()RequestSecureFailedProcess()ThreadInSv ThreadReplySvcProcessorp_recvdata_bus : DataBusb_exit : bool*SvGetRecvTradeRecvUnpackRecvfetchClientInfoRecord()RecovgetTrade()TradeOutProcess()CreateOutputChannel()TradeSendData()ThreadReplySv5程序设计说明5.1对原系统的改动⏹改变原有商家Trade类，不存放渠道对象在商家类中，商家类只执行商家处理，不负责渠道的管理⏹改动原有的系统中所有模式的处理，模式处理必须对渠道的释放负责⏹修改MidHstChannel，添加后台服务需要的２个FML字段,这两个字段是:FML域名描述S_INTERF_NO接口标识号，整数。
PROFIBUS-DP用户手册(V1.01)
文档编号 版本 密级 PRONET-S002 V1.01内部公开 南京埃斯顿自动控制技术有限公司研发部资源类别：共25页PROFIBUS-DP 用户手册拟制： 日期： 审核： 日期： 批准： 日期：修订记录日期 修订版本 描述 作者 2008/08/28 1.00 初稿完成 徐慧2009/09/14 1.01 Profibus-DPV0, DPV1 , DPV2合并在DP100模块的一个DSP程序。
易健第一章：前言本说明书内容主要介绍PROFIBUS接线，配置，功能和软件协议。
z第二章：PROFIBUS简介z第三章：产品概述z第四章：安装信息z第五章：PROFIBUS-DP通讯z第六章：GSD文件说明及参数设定z第七章：LED灯指示说明及故障排除方法z第八章：参数模式/对象字典z第九章：参数描述第二章：PROFIBUS 简介2.1 PROFIBUS 概况PROFIBUS是一个国际化、开放性且独立于供货商的（vendor-independent）通讯协议标准，广泛应用于生产、制造、加工和建筑自动化以及其它自动化控制领域。
PROFIBUS 根据不同需求及应用，有三种主要类型：PROFIBUS-DP、PROFIBUS-PA及PROFIBUS-FMS：z PROFIBUS-DP（Decentralized Periphery）：PROFIBUS-DP是一种速率快且成本低的通讯系统，专为高速数据传输而设计的。
PROFIBUS-DP被广泛使用，尤其在远程I/O系统、马达控制中心以及变频器的应用上。
采用PROFIBUS-DP连接自动化系统与分散外围装置间通讯时，可达到最佳化的效果。
z PROFIBUS-PA（Process Automation）：PROFIBUS-PA（通常附有 MBP-IS 传输技术）是一种用于过程自动化的PROFIBUS通讯系统，PROFIBUS-PA以PROFIBUS-DP为基础，在数据传输上为PROFIBUS-DP通讯协议的延伸，专门支持本质安全防爆应用，可藉由本质安全防爆MBP-IS接口，应用在有爆炸危险的区域。
接口设计说明书(软件设计文档范例)
接口设计说明书(软件设计文档范例)接口设计说明书(软件设计文档范例)1.引言1.1 文档目的本文档旨在描述软件系统的接口设计，提供开发人员进行开发和集成工作的指导。
1.2 读者对象本文档适用于软件开发团队、测试人员和其他与系统开发和集成相关的人员。
2.系统概述2.1 系统描述系统为一个类型的软件系统，主要功能包括但不限于、和。
2.2 系统架构系统采用了架构，主要包括以下模块和组件：- 模块1：描述模块1的功能和接口- 模块2：描述模块2的功能和接口-3.接口设计3.1 接口概述系统的接口主要分为内部接口和外部接口，用于不同模块之间的通信和数据传递。
3.2 内部接口3.2.1 模块1接口模块1提供以下接口供其他模块使用：- 接口1：描述接口1的功能和输入输出参数- 接口2：描述接口2的功能和输入输出参数-3.2.2 模块2接口模块2提供以下接口供其他模块使用：- 接口1：描述接口1的功能和输入输出参数- 接口2：描述接口2的功能和输入输出参数-3.3 外部接口3.3.1 数据输入接口系统支持以下数据输入接口：- 接口1：描述接口1的功能和输入参数格式- 接口2：描述接口2的功能和输入参数格式-3.3.2 数据输出接口系统支持以下数据输出接口：- 接口1：描述接口1的功能和输出数据格式- 接口2：描述接口2的功能和输出数据格式-4.接口标准4.1 接口命名规范- 内部接口：采用驼峰命名法，例如getUserName()- 外部接口：采用大写字母和下划线的形式，例如GET_USER_INFO4.2 接口参数规范- 参数类型：根据具体需求确定参数的类型，例如字符串、整数等- 参数命名：采用有意义的命名，易于理解和使用4.3 接口返回值规范- 返回值类型：根据具体需求确定返回值的类型，例如字符串、整数等- 返回值说明：对返回值的含义和可能取值进行详细说明5.附件本文档涉及的附件包括：- 附件1：x- 附件2：x-6.法律名词及注释6.1 法律名词1：定义1- 注释1：x6.2 法律名词2：定义2- 注释2：x7.全文结束。
接口设计说明书
[项目名称] 接口设计说明书
目录
1.介绍 (4)
1.1.编写目的 (4)
1.2.阅读对象 (4)
1.3.术语和略缩语 (4)
1.4.参考资料 (4)
2.模板内容 (4)
2.1.1.三级标题 (4)
2.1.1.1.四级标题 (4)
模板填写说明：
1）空行编写正文，编写后删除蓝色斜体字。
2）模板完成后，删除此模板填写说明。
1.介绍
1.1. 编写目的
简单描述编写此文档的目的。
1.2. 阅读对象
列出此文档的阅读对象。
1.3. 术语和略缩语
列举本文中涉及到的属于和缩略语，并做相应的解释，统一阅读者的认识。
1.4. 参考资料
列举此文的参照的文档和资料。
2.模板内容
2.1.1. 三级标题
2.1.1.1.四级标题
正文字体：宋体，五号，黑色行距：1.15倍
1)步骤式表达：
2)
★分类式表达：
★。
接口设计说明书v1.01
接口设计说明书v1.01
接口设计说明书
目录
1引言 (1)
1.1编写目的 (1)
1.2背景 (1)
2接口设计说明 (1)
2.1接口列表 (1)
2.2接口说明 (2)
2.2.1上传防治信息 (2)
2.2.2上传采收信息 (2)
2.2.3上传灌溉信息 (3)
2.2.4上传旧版包装信息 (3)
2.2.5上传新版包装信息 (4)
2.2.6上传种植信息 (5)
2.2.7上传施肥信息 (5)
2.2.8上传检测信息 (6)
2.2.9验证执法巡查系统用户 (6)
2.2.10获取产品信息 (7)
2.2.11下载企业基本信息 (7)
2.2.12把旧数据库中的数据转换到新的数据库里 (8)
1引言
1.1编写目的
广州市农产品质量安全追溯系统接口设计说明书详细介绍广州市农产品质量安全追溯系统涉及的接口及接口说明，指出了接口与应用程序之间的关系。
该接口设计说明书的读者包括程序开发人员、以上相关系统的开发人员、测试人员。
1.2背景
接口设计基于已有系统及新增系统功能提出。
2接口设计说明
2.1接口列表
2.2接口说明
2.2.1上传防治信息
2.2.2上传采收信息
2.2.3上传灌溉信息
2.2.4上传旧版包装信息
2.2.5上传新版包装信息
2.2.6上传种植信息
2.2.7上传施肥信息
2.2.8上传检测信息
2.2.9验证执法巡查系统用户
2.2.10获取产品信息
2.2.11下载企业基本信息
2.2.12把旧数据库中的数据转换到新的数据库里。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
接口设计说明书
目录
1引言 (1)
1.1编写目的 (1)
1.2背景 (1)
2接口设计说明 (1)
2」接口列表 (1)
2.2接口说明 (2)
221上传防治信息 (2)
2.2.2上传采收信息 (2)
2.2.3上传灌溉信息 (3)
2.2.4上传旧版包装信息 (3)
225上传新版包装信息 (4)
226上传种植信息 (5)
227上传施肥信息 (5)
228上传检测信息 (6)
229验证执法巡查系统用户 (6)
2210获取产品信息 (7)
2211下载企业基本信息 (7)
2.2.12耙旧数据库中的数据转换到新的数据库里 (8)
1引言
1.1编写目的
广州市农产品质量安全追溯系统接口设计说明书详细介绍广州市农产品质量安全追溯系统涉及的接口及接口说明，指出了接口与应用程疗;之间的关系。
该接口设计说明书的读者包括程序开发人员、以上相关系统的开发人员、测试人员。
1・2背景
接口设计基于已有系统及新增系统功能提出O
2接口设计说明
2・1接口列表
2・2接口说明
2.2.1上传防治信息
2.2.2上传采收信息
return sum; }
catch
(
return "1;
}
2.2.3上传灌溉信息
2.2.4 ±传旧版包装信息
2.2.5上传新版包装信息
2.2.6上传种植信息
2.2.7上传施肥信息
2.2.8
上传检测信息
2.2.9
验证执法巡査系统用户
示例
2.2.10获取产品信息
2.2.11下载企业基本信息
2.2.12把旧数据库中的数摇转换到新的数据库里。