【正文】 實時數(shù)據(jù)平臺 C++接口函數(shù)參考手冊實時數(shù)據(jù)平臺C++接口函數(shù)參考手冊 第一部分 用戶編程接口說明一、C++語言用戶接口函數(shù)類實時數(shù)據(jù)平臺在Alpha計算機OPEN VMS操作系統(tǒng)C++編程環(huán)境和PC機Visual C++編程環(huán)境中提供了C++語言用戶接口函數(shù)（API），供用戶編程訪問實時數(shù)據(jù)平臺中的數(shù)據(jù)庫。C++語言用戶接口函數(shù)全部放在CUserApi類中，作為CUserApi類的成員函數(shù)。用戶建立了CUserApi類的實例以后，就可以直接調(diào)用CUserApi類的成員函數(shù)實時數(shù)據(jù)平臺中的數(shù)據(jù)庫。二、函數(shù)返回值大部分用戶接口函數(shù)的返回值用于表示函數(shù)執(zhí)行狀態(tài)。表示函數(shù)執(zhí)行狀態(tài)的返回值總是一個整型數(shù)，當返回值大于零時表示函數(shù)執(zhí)行正確，當返回值小于或等于零時，表示函數(shù)執(zhí)行失敗。返回值的意義見各個函數(shù)中的說明。三、OPEN VMS操作系統(tǒng)C++編程環(huán)境中調(diào)用API在Alpha計算機OPEN VMS操作系統(tǒng)C++編程環(huán)境中，實時數(shù)據(jù)平臺提供了兩個頭文件和三個目標模塊庫。文件分別名稱為： ，其中分別包含了函數(shù)定義和符號定義。用戶程序中如果要調(diào)用API，必須在程序中用include包含這兩個頭文件。用戶程序在編譯以后要與實時數(shù)據(jù)平臺提供的兩個目標模塊庫連接。連接命令如下：$clink 用戶程序程序名clink是編程環(huán)境中提供的一個命令，它完成用戶的C++程序與連接庫的自動連接。（注：為使此命令有郊，用戶每次以用戶身份進入Open VMS操作系統(tǒng)用戶目錄下之后，首先執(zhí)行命令‘$ @RTDBLOG’或?qū)⒋嗣罴拥接脩鬖OGIN命令過程中。）四、Windows 9Windows NT Visual C++編程環(huán)境中調(diào)用APIVisual C++編程環(huán)境中，實時數(shù)據(jù)平臺提供了兩個頭文件、一個引入庫和一個動態(tài)連接庫。文件分別名稱為：，其中分別包含了函數(shù)定義和符號定義。用戶程序中如果要調(diào)用API，必須在程序中用include包含這兩個頭文件。在用戶程序工作臺(Workspace)中，在選單project下選擇Settings..，進入設置對話框，選擇Link設置，在Object/library 。，或者放在Windows的system下。 第二部分 用戶編程接口（API）成員函數(shù)AckAlarm long AckAlarm(char* database, long area, long unit, long attr) 。AckAlarm函數(shù)確認TAG點報警。參 數(shù)database （讀） 數(shù)據(jù)庫名，單數(shù)據(jù)庫系統(tǒng)為NULL。area （讀） 區(qū)域號，0表示確認所有區(qū)域TAG點報警。unit （讀） 單元號，0表示確認所有單元TAG點報警。attr （讀） 數(shù)據(jù)庫屬性，說明確認哪種數(shù)據(jù)庫的點，用下列符號表示：RTDB_ATTR_STANDARD 標準數(shù)據(jù)庫（缺省值)；RTDB_ATTR_SIMULATE 仿真數(shù)據(jù)庫。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失敗； 注：（函數(shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）AckTagAlarm long AckTagAlarm (char* database, char* tagName, long count, long attr)AckTagAlarm函數(shù)確認一個或多個TAG點報警。參 數(shù)database （讀） 數(shù)據(jù)庫名，單數(shù)據(jù)庫系統(tǒng)為NULL。tagName （讀）TAG點名稱數(shù)組，字符串數(shù)組指針。因為僅有PV值有報警數(shù)據(jù)，這 里也可寫成： 點名.PV。count （讀） TAG點個數(shù)。attr （讀） 數(shù)據(jù)庫屬性，說明確認哪種數(shù)據(jù)庫的點，用下列符號表示： RTDB_ATTR_STANDARD 標準數(shù)據(jù)庫（缺省值)； RTDB_ATTR_SIMULATE 仿真數(shù)據(jù)庫。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失??；注：（函數(shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）AsciiTime long AsciiTime(TIME_DESC* bTime, char* sTime)AsciiTime函數(shù)將二進制時間轉(zhuǎn)換成ASCII時間。參 數(shù)bTime （讀）二進制時間數(shù)據(jù)結構。TIME_DESC數(shù)據(jù)結構格式：typedef struct { long time 。 long flag 。 // , , } TIME_DESC 。其中：time為二進制時間值，flag為二進制時間標志：1表示絕對時間，2表示相對時間，0表示錯誤。sTime （寫）ASCII時間字符串。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失??；注：（函數(shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）BinaryTime long BinaryTime(char* sTime, TIME_DESC* bTime)BinaryTime函數(shù)將ASCII時間轉(zhuǎn)換成二進制時間。參 數(shù)sTime （讀）ASCII時間字符串。bTime （寫）二進制時間數(shù)據(jù)結構。TIME_DESC數(shù)據(jù)結構格式：typedef struct { long time 。 long flag 。 // , , } TIME_DESC 。其中：time為二進制時間值，flag為二進制時間標志：1表示絕對時間，2表示相對時間，0表示錯誤。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失敗；注：（函數(shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）Commit long Commit(long viewID) 。Commit函數(shù)向?qū)崟r數(shù)據(jù)平臺提交實時數(shù)據(jù)視圖中的數(shù)據(jù)。參 數(shù)viewID （讀）實時數(shù)據(jù)視圖標識。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失??；注：（函數(shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）CreateAlarmView long CreateAlarmView(longamp。 viewID, char* database, long area, long unit, long viewAttr, long count)CreateAlarmView函數(shù)建立報警記錄視圖。參 數(shù)viewID （寫） 報警記錄視圖標識。database （讀） 數(shù)據(jù)庫名，單數(shù)據(jù)庫系統(tǒng)為NULL。area （讀） 區(qū)域號，0表示所有區(qū)域。unit （讀） 單元號，0表示所有單元。viewAttr （讀） 視圖屬性，用下列符號表示：VIEW_ATTR_STATIC 靜態(tài)視圖（缺省值)；VIEW_ATTR_ACTIVE 動態(tài)視圖；VIEW_ATTR_STANDARD 標準視圖，數(shù)據(jù)來自系統(tǒng)數(shù)據(jù)庫（缺省值)；VIEW_ATTR_SIMULATE 仿真視圖，數(shù)據(jù)來自仿真數(shù)據(jù)庫。count (讀) 視圖報警中記錄個數(shù)。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失?。蛔ⅲ海ê瘮?shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）CreateDataViewlong CreateDataView(longamp。 viewID, char* database, long viewAttr, char* dataDesc, long count) CreateDataView函數(shù)建立實時數(shù)據(jù)視圖。參 數(shù)viewID （寫）實時數(shù)據(jù)視圖標識。database (讀) 數(shù)據(jù)庫名，單數(shù)據(jù)庫系統(tǒng)為NULL。viewAttr (讀) 視圖屬性，用下列符號表示：VIEW_ATTR_READONLY 只讀視圖（缺省值)；VIEW_ATTR_WRITE 可寫視圖；VIEW_ATTR_STATIC 靜態(tài)視圖（缺省值)；VIEW_ATTR_ACTIVE 動態(tài)視圖；VIEW_ATTR_STANDARD 標準視圖，數(shù)據(jù)來自系統(tǒng)數(shù)據(jù)庫（缺省值)；VIEW_ATTR_SIMULATE 仿真視圖，數(shù)據(jù)來自仿真數(shù)據(jù)庫。dataDesc (讀) 視圖數(shù)據(jù)TAG點參數(shù)描述表，字符串數(shù)組指針。數(shù)組中元素均為64字節(jié)的字符串，每個元素表示一個TAG點參數(shù)的描述，TAG點參數(shù)的描述為： 點名.參數(shù)名.細目名。count (讀) 點參數(shù)描述表中點參數(shù)個數(shù)。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失??；注：（函數(shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）說 明如果TAG點參數(shù)描述表中某TAG點僅描述為點名，則在建視圖時，會按隱式規(guī)則將此TAG點的所有參數(shù)的PV項自動建成。CreateDayStaView long CreateDayStaView(longamp。 viewID, char* database, long viewAttr, char* dataDesc, long tagCount, char* endTime, long count) 。CreateDayStaView函數(shù)建立日統(tǒng)計數(shù)據(jù)視圖。參 數(shù)viewID （寫）日統(tǒng)計數(shù)據(jù)視圖標識。database (讀) 數(shù)據(jù)庫名，單數(shù)據(jù)庫系統(tǒng)為NULL。viewAttr (讀) 視圖屬性，用下列符號表示：VIEW_ATTR_STANDARD 標準視圖，數(shù)據(jù)來自系統(tǒng)數(shù)據(jù)庫（缺省值)；VIEW_ATTR_SIMULATE 仿真視圖，數(shù)據(jù)來自仿真數(shù)據(jù)庫。dataDesc (讀) 視圖數(shù)據(jù)TAG點描述表，字符串數(shù)組指針。數(shù)組中元素均為64字節(jié)的字符串，每個元素表示一個TAG點名稱。因為僅有PV值保存統(tǒng)計數(shù)據(jù)，這里也可寫成： 點名.PV。tagCount (讀) 視圖中TAG點個數(shù)。endTime (讀) 視圖統(tǒng)計數(shù)據(jù)結束時間，視圖數(shù)據(jù)結束時間有三種方法表示： 絕對時間，時間格式為“YYYY:MM:DDHH:MM:SS”，意義為“年：月：日時：分：秒”，表示視圖數(shù)據(jù)結束時間為某一確定時間； 當前時間，用NULL時表示； 相對時間，時間格式為“DDHH:MM:SS”，意義為“天時：分：秒”表示視圖數(shù)據(jù)結束時間為當前時間向前減去所表示的相對時間。count (讀) 視圖中每個點的數(shù)據(jù)個數(shù)。返回值指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失?。蛔ⅲ海ê瘮?shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）說 明日統(tǒng)計數(shù)據(jù)是作為一種歷史數(shù)據(jù)保存的，到每天的24時保存當天的日統(tǒng)計數(shù)據(jù)。日統(tǒng)計數(shù)據(jù)是以天為單位計算的，以每天0時為基準。在上述視圖統(tǒng)計數(shù)據(jù)結束時間表示法中，用絕對時間表示時，小時、分鐘和秒沒有意義，函數(shù)執(zhí)行時小時、分鐘和秒將被截掉，如“1997:7:309:24:12”，作為“1997:7:300:0:0”處理；用當前時間表示時，最后一個數(shù)據(jù)是當前日到當前時間的統(tǒng)計數(shù)據(jù)，如果統(tǒng)計數(shù)據(jù)結束時間選擇NULL，當前時間是1998年3月5日8時25分36秒，日統(tǒng)計數(shù)據(jù)視圖中最后一個數(shù)據(jù)是從1998年3月5日到1998年3月5日8時25分36秒的統(tǒng)計數(shù)據(jù)；用相對時間表示時，相對時間中小時、分鐘和秒將被截掉，如“19:8:20”將被作為“10:0:0”處理，即日統(tǒng)計數(shù)據(jù)視圖中最后一個數(shù)據(jù)是當日前一天的數(shù)據(jù)。CreateEventView long CreateEventView(longamp。 viewID, char* database, long area, long unit, long viewAttr, long count)CreateEventView函數(shù)建立事件記錄視圖。參 數(shù)viewID （寫） 事件記錄視圖標識。database （讀） 數(shù)據(jù)庫名，單數(shù)據(jù)庫系統(tǒng)為NULL。area （讀） 區(qū)域號，0表示所有區(qū)域。unit （讀） 單元號，0表示所有單元。viewAttr （讀） 視圖屬性，用下列符號表示：VIEW_ATTR_STATIC 靜態(tài)視圖（缺省值)；VIEW_ATTR_ACTIVE 動態(tài)視圖；VIEW_ATTR_STANDARD 標準視圖，數(shù)據(jù)來自系統(tǒng)數(shù)據(jù)庫（缺省值)；VIEW_ATTR_SIMULATE 仿真視圖，數(shù)據(jù)來自仿真數(shù)據(jù)庫。count (讀) 視圖中記錄個數(shù)。返回值：指示函數(shù)執(zhí)行狀態(tài)：不小于1的整數(shù)值 函數(shù)執(zhí)行成功；小于1的整數(shù)值 函數(shù)執(zhí)行失?。蛔ⅲ海ê瘮?shù)執(zhí)行失敗原因可根據(jù)返回值參閱附錄A）CreateHisView long CreateHisView(longamp。 viewID, char* database, long viewAttr, char* dataDesc, long tagCount, char* endTime, char* spanTime, long count) CreateHisView函數(shù)建立歷史數(shù)據(jù)視圖。參 數(shù)viewID （寫）歷史數(shù)據(jù)視圖標識。database (讀) 數(shù)