数据接口函数.doc

地下工程和深基坑安全监测预警系统 数据采集专用接口(中间件)使用说明 目 录 TOC \o 1-3 \h \z \u 1. 概述 3 2. 定义 3 3. 数据接口函数 3 3.1. 登陆验证 3 3.2. 获取工程信息 4 3.3. 上传全站仪数据 5 3.4. 上传水准仪数据 7 3.5. 上传测斜仪数据 10 3.6. 上传频率计(单值)数据 11 3.7. 上传频率计(四值)数据 12 3.8. 上传频率计(六值)数据 14 3.9. 上传水位计数据 16 3.10. 上传裂缝监测数据 17 4. 函数返回值参考 18  概述 本说明针对地下工程和深基坑安全监测预警系统(以下简称“监测系统”)数据采集专用接口(中间件)加以描述。采集接口是基坑监测设备数据采集上传的统一入口，方便设备供应商或第三方软件供应商上传监测数据。 采集专用接口为动态链接库文件形式，封装了地下工程和深基坑各监测项目数据上传所需的全部函数。 定义 字符串 本说明中所有关于字符串的数据(包括输入与输出字符串)，默认为都是以’\0’ Xml包封装格式 所有xml内容(包括输入与输出)都使用UTF-8字符编码。 数据接口函数 登陆验证 Int FT_Login(const char* userId, const char* password); 验证用户信息，只有登录成功之后才允许调用其它接口函数。该方法只须成功调用一次即可。 参数 UserId 用户名 Password 密码 返回值 如果登录成功，则返回0。如果登录失败，则返回相应的错误码。 备注 在使用接口的任何函数之前，必须保证成功调用过Login方法进行登录，否则将调用失败。 获取工程信息 Int FT_GetProjectInfo(char** data, int* dataLength); 从服务器获取工程名称、检测项目等工程信息。返回值的格式如下： NewDataSet !--工程名称 -- PROJECT !-- 工程ID -- ID94d15263-ae8b-4724-ae67-091b05fbd84a/ID !-- 工程编号 -- CODEjc000a0007/CODE NAME系统测试/NAME /PROJECT !-- 监测项目 -- ITEM !-- 监测项目ID -- SYS_ITEMID1/SYS_ITEMID P_PROJECTID94d15263-ae8b-4724-ae67-091b05fbd84a/P_PROJECTID NAME围护墙边坡顶部水平位移/NAME !-- 测点编号前缀 -- CODINGWYS/CODING /ITEM !-- 监测编号 -- JCCODE SEQ_NOjc000a0005130417008/SEQ_NO P_PROJECTID94d15263-ae8b-4724-ae67-091b05fbd84a /P_PROJECTID /JCCODE /NewDataSet 参数 data 用来存储返回结果的缓存。 返回的结果为xml格式字符串。 该参数的内存由函数内部分配，但不自动清理，请在使用完成后手动清理内存。 dataLength 结果缓存区的长度。 如果函数调用成功，则该参数值为返回结果的长度。 返回值 如果函数调用成功，则返回0。如果调用失败，则返回相应的错误码。 上传全站仪数据 Int FT_UploadTotalStationData(const char* data); 上传全站仪的采集数据，参数使用xml的格式字符串。 参数 data xml格式的字符串。格式如下： ?xml version=1.0 encoding=utf-8? DataSet TotalStationData !-- 设备编号 -- DeviceNum/DeviceNum !-- 设备型号 -- DeviceModel /DeviceModel !-- 工程编号 -- ProjectCode/ProjectCode !-- 监测编号 -- SurveillanceNum/SurveillanceNum !-- 监测项目 -- SurveillanceItemId/SurveillanceItemId !-- 测站编号 -- StationNum/StationNum !-- 测点编号 -- PointNum/PointNum !-- 斜距 -- SJ