icapi.h

ICCP Toolkit 是在 Tru64下开发Tase.2通信协议的开发包

#define IC_UNKNOWN_TYPE                        40

#define IC_MMS_MSGSIZETOOBIG                   57
#define IC_MMS_REQ_SEND_FAIL                   58
#define IC_MMS_RESP_SEND_FAIL                  59
#define IC_MP_INFO_FAIL                        60
#define IC_CHANNEL_NOT_IDLE		       61

/* Status values for callbacks on icDefineTransferGroup */

/*
 * IC_DST_DEF_FAIL is the starting offset of errors
 * from failure of Data Set Definition
 *
 * IC_DST_WRITE_FAIL is the starting offset of errors
 * from failure of start DSTransferSet write
 */
/*
 *  the error in the callbacks of icDefineTransferGroup
 *  if it is greater or equal to IC_DST_DEF_FAIL but
 *         less than IC_DST_READ_FAIL,
 *     then it is resulted from Data Set Definition,
 *     Currently, there are no Data Set Definition errors.
 *
 *  if it is greater or equal to IC_DST_READ_FAIL but
 *         less than IC_DST_WRITE_FAIL,
 *     then (error - IC_DST_READ_FAIL) is the
 *     error resulted from read DSTransferSet failure.
 *     See MMS_EASE Ref: access_result.
 *
 *  if it is greater or equal to IC_DST_WRITE_FAIL
 *     then (error - IC_DST_WRITE_FAIL) is the
 *     error resulted from start DSTransferSet failure.
 *     See MMS_EASE Ref: write_resp_info.
 */

#define IC_DST_DEF_FAIL                       100
#define IC_DST_READ_FAIL                      120
#define IC_DST_WRITE_FAIL                     140

/* Status values for Block 4 I/Fs */

#define IC_NO_BLOCK_4                         400
#define IC_MISSING_REQMSG_CALLBACK            401
#define IC_MISSING_MSGRCV_CALLBACK            402
#define IC_DUPLICATE_MESSAGE                  403
#define IC_BAD_IM_INFO_REPORT_DISCARD         404 
#define IC_NO_IM_TRANSFER                     405 
#define IC_UNKNOWN_IM_RECEIVED                406
#define IC_MSG_SIZE_EXCEED_DEFINED_MAX        407

#define IC_INFO_TYPE_DEFINE_FAIL              408

#define IC_IMTRANSFER_SET_UNDEFINED           409
#define IC_CLIENT_IMXFER_SET_UNDEFINED        410
#define IC_INFO_HDR_VAR_UNDEFINED             411
#define IC_INFO_BUF_VAR_UNDEFINED             412

#define IC_INFO_HDR_ASN1_TYPE_MISMATCH        413
#define IC_INFO_BUF_ASN1_TYPE_MISMATCH        414

#define IC_MSG_SIZE_EXCEED_MAXPDU             415

#define IC_IM_XFER_SET_ENABLED                450    /* server status */
#define IC_IM_XFER_SET_DISABLED               451    /* server status */
#define IC_IM_XFER_SET_ALREADY_ACTIVE         452    /* server error */

#define IC_IM_XFER_SET_ALREADY_STARTED        470    /* client error */


/* Status values for Block 8 I/Fs */

#define IC_NO_BLOCK_8                         800
#define IC_MISSING_INFORCV_CALLBACK           801
#define IC_MISSING_INFOSEND_CALLBACK          802
#define IC_MISSING_REQCOND_CALLBACK           803
#define IC_DUPLICATE_ACCOUNT                  804
#define IC_INVALID_TYPE                       805
#define IC_EXCEED_MMS_PDU_SIZE                806
#define IC_MISSING_FLOAT_VALUES               807

#define IC_WRONG_TYPE                         808
#define IC_TYPE_NOT_SUPPORTED                 809
#define IC_BAD_VALUES_IN_HEADER               810
#define IC_GEN_INFO_ERROR                     811

#define IC_TATRANSFER_SET_UNDEFINED           820
#define IC_CLIENT_TA_COND_UNDEFINED           821
#define IC_TA_COND_UNDEFINED                  822
#define IC_TA_REQ_UNDEFINED                   823
#define IC_REQ_ID_UNDEFINED                   824
#define IC_TA_HDR_UNDEFINED                   825
#define IC_TA_XMT_SEG_UNDEFINED               826
#define IC_LCL_REF_UNDEFINED                  827
#define IC_MATRIX_ID_UNDEFINED                828
#define IC_FLT_ARRAY_UNDEFINED                829
#define IC_INT_ARRAY_UNDEFINED                830
#define IC_PROFILE_UNDEFINED                  831

#define IC_FLT_ARRAY_TYPE_UNDEFINED           832
#define IC_INT_ARRAY_TYPE_UNDEFINED           833

#define IC_TA_COND_ASN1_TYP_MISMATCH          834
#define IC_TA_HDR_ASN1_TYP_MISMATCH           835
#define IC_TA_REQ_ASN1_TYP_MISMATCH           836
#define IC_REQ_ID_ASN1_TYP_MISMATCH           837
#define IC_XMT_SEG_ASN1_TYP_MISMATCH          838
#define IC_LCL_REF_ASN1_TYP_MISMATCH          839
#define IC_MATRIX_ID_ANS1_TYP_MISMATCH        840
#define IC_FLT_ARRAY_ANS1_TYP_MISMATCH        841
#define IC_INT_ARRAY_ANS1_TYP_MISMATCH        842
#define IC_PROFILE_ASN1_TYP_MISMATCH          843


#define IC_NO_TA_CONDITION                    849
#define IC_TA_XFER_SET_ENABLED                850    /* server status */
#define IC_TA_XFER_SET_DISABLED               851    /* server status */
#define IC_TA_XFER_SET_ALREADY_ACTIVE         852    /* server error */

#define IC_TA_XFER_SET_ALREADY_STARTED        870    /* client error */
#define IC_TA_REQUEST_WRITE_OUTSTANDING       871    /* client error */
#define IC_BAD_TA_INFO_REPORT_DISCARD         872    /* client error */
#define IC_UNKNOWN_TA_RECEIVED                873    /* client error */


/* Status values for new Block 8 I/Fs */

#define IC_TXT_ARRAY_TYPE_UNDEFINED       880
#define IC_GD_REPORT_UNDEFINED            881
#define IC_BAD_GDR_INFO_REPORT_DISCARD    882
#define IC_NO_VARIABLE_FOR_MSG            883
#define IC_INVALID_MESSAGE                884
#define IC_BLOCK4_MSG_TOO_LARGE           885
#define IC_BLOCK4_TYPEID_NOT_FOUND        886
#define IC_B8_SEND_ACCOUNT_ERR            887
#define IC_B8_SEND_GDR_ERR                888
#define IC_BLOCK8_HEADER_UNDEFINED        889
#define IC_BAD_BLOCK8_MESSAGE_DISCARD     890

/* Additional error codes for Error Callback function */
#define IC_ASSOC_REST_FAIL              2001    /* fail on restart association */
#define IC_BLT_ERROR                    2002    /* Bilateral Table entry error */
#define IC_INACTIVE_ARNAME              2003    /* AR name not active */
#define IC_NOREG_ARNAME                 2004    /* AR name not registered */
#define IC_ARNAME_FAIL                  2005    /* AR name failed */
#define IC_MPREAD_ERROR                 2006    /* mp_read error */
#define IC_MPWRITE_ERROR                2007    /* mp_write error */
#define IC_MPERRRESP_ERROR              2008    /* mp_err_resp error */
#define IC_MPINDENTRESP_ERROR           2009    /* mp_indent_resp error */
#define IC_MPINITERR_ERROR              2010    /* mp_init_err error */
#define IC_MPINITRESP_ERROR             2011    /* mp_init_resp error */
#define IC_MPIDENT_ERROR                2012    /* mp_ident error */
#define IC_PE_STATUS_ERROR              2013    /* pe status error */
#define IC_MPNAMELIST_ERROR             2014    /* mp_namelist error */
#define IC_MPDELVLIST_ERROR             2015    /* mp_delvlist error */
#define IC_MPDEFVLIST_ERROR             2016    /* mp_defvlist error */
#define IC_MPINFO_ERROR                 2017    /* mp_info error */
#define IC_DSTRANSFERSET_ERROR          2018    /* DSTransferSet not found */
#define IC_MPGETVLIST_ERROR             2019    /* mp_getvlist error */
#define IC_MPGETVAR_ERROR               2020    /* mp_getvar error */
#define IC_ICCP_VERSION_NOTFOUND        2021    /* ICCP Version Variable not in blt */
#define IC_MS_LOCL_TO_ASN1_ERROR        2022    /* ms_locl_to_asn1 with type error */
#define IC_MPDEFVLIST_RESP_ERROR        2023    /* mp_defvlist_resp error */
#define IC_MPDELVLIST_RESP_ERROR        2024    /* mp_delvlist_resp error */
#define IC_MPOUTPUT_RESP_ERROR          2025    /* mp_output_resp error */
#define IC_DATASET_LOCK_ERROR           2026    /* error on dataset lock */
#define IC_DATASET_SETUP_ERROR          2027    /* dataset setup error */
#define IC_MPWRITE_RESP_ERROR           2028    /* mp_write_resp error */
#define IC_UNKNOWN_SCOPE                2029    /* unknown variable scope */
#define IC_MMSEASE_INTERNAL_ERROR       2030    /* MMS-EASE generic internal error */
#define IC_MPCONCLUDERESP_ERROR         2031    /* mp_conclude_resp error */
#define IC_MISMATCH_RUNTIME_ERROR       2032    /* conf and runtime mismatch */
#define IC_UNKNOWN_TA_TYPE              2033    /* unknown TA type */
#define IC_U_MP_READ_CONF_ERROR         2034    /* u_mp_read error */
#define IC_MP_CONCLUDE_ERROR            2035    /* error on mp_conclude */
#define IC_MPGETVAR_RESP_ERROR          2036    /* mp_getvar_resp error */
#define IC_UNKNOWN_OBJ_TAG              2037    /* unknown object tag error */
#define IC_MPGETVLIST_RESP_ERROR        2038    /* mp_getvlist_resp error */
#define IC_UNKNOWN_DATASET_ERROR        2039    /* unknown dataset */
#define IC_RESPONSE_TOOLARGE_ERROR      2040    /* read response too large */
#define IC_CRITICAL_TIMEOUT             2041    /* Critical Data Time Out  */
#define IC_CRITICAL_NOT_ARRIVED         2042    /* Critical data not arrived */
#define IC_CRITICAL_NACK		2043	/* Critical NACK received */
#define IC_TOO_MANY_REMOTE_AR           2044    /* Too many remote ar names specified */

#define IC_SUP_FEAT_READ_FAIL           2900    /* supported features read failure      */
#define IC_SUP_FEAT_MISMATCH            2901    /* supported features mismatch!         */
#define IC_VERSION_FAILURE              2902    /* iccp version read failure    */
#define IC_VERSION_MISMATCH             2903    /* iccp version mismatch        */
#define IC_BILAT_READ_FAILURE           2904    /* bilateral table id read failure      */
#define IC_BILAT_MISMATCH               2905    /* bilateral table id mismatch  */
#define IC_TOO_MANY_TS                  2906    /* too many transfer sets       */

/* -- Remote Protocol Types -- */

#define IC_TYPE_MMS     1
#define IC_TYPE_ICCP    2 


/* -- Remote Variable Scope Types -- */

#define IC_SCOPE_VMD     0
#define IC_SCOPE_DOMAIN  1

#define IC_SCOPE_MAX     1        /* must match highest scope type */

/* -- Transfer Set Status -- */

#define IC_DISABLE                     0 

/* -- Data Types -- */

#define IC_TYPE_UNKNOWN	               1000 

/*
 *  Block 1 2 User Data Types 
 */
/* -- Pre-defined types -- */
 
#define IC_TYPE_STATE                  0
#define IC_TYPE_STATE_Q                1
#define IC_TYPE_STATE_Q_TIME_TAG       2
#define IC_TYPE_STATE_EXTENDED         3 

#define IC_TYPE_DISCRETE               4
#define IC_TYPE_DISCRETE_Q             5
#define IC_TYPE_DISCRETE_Q_TIME_TAG    6
#define IC_TYPE_DISCRETE_Q_EXTENDED    7

#define IC_TYPE_REAL                   8
#define IC_TYPE_REAL_Q                 9
#define IC_TYPE_REAL_Q_TIME_TAG        10
#define IC_TYPE_REAL_EXTENDED          11 

#define IC_TYPE_USER_DEFINED           12

#define IC_TYPE_MAX                    12
/*
 *  Block 4 User Data Types - Information Buffer Objects
 */
#define IC_B4_USER_TYPE_MIN           400
#define IC_TYPE_INFO_BUF_HDR          400

#define IC_B4_USER_TYPE_MAX           IC_TYPE_INFO_BUF_HDR

/*
 *  Block 5 User Data Types 
 */
#define IC_B5_USER_TYPE_MIN           500
#define IC_TYPE_CHECKBACKID           (IC_B5_USER_TYPE_MIN + 0)
#define IC_TYPE_COMMAND               (IC_B5_USER_TYPE_MIN + 1)
#define IC_TYPE_SETPOINT_DISCRETE     (IC_B5_USER_TYPE_MIN + 2)
#define IC_TYPE_SETPOINT_REAL         (IC_B5_USER_TYPE_MIN + 3)
#define IC_TYPE_DEVICE_TAG            (IC_B5_USER_TYPE_MIN + 4)
#define IC_B5_USER_TYPE_MAX           IC_TYPE_DEVICE_TAG

/*
 *  Block  6 User Data Types 
 */
#define IC_B6_USER_TYPE_MIN           600
#define IC_B6_USER_TYPE_MAX           IC_B6_USER_TYPE_MIN

/*
 *  Block 7 User Data Types 
 */
#define IC_B7_USER_TYPE_MIN           700
#define IC_B7_USER_TYPE_MAX           IC_B7_USER_TYPE_MIN

/*
 *  Block 8 User Data Types - Account Object Types
 */
#define IC_B8_USER_TYPE_MIN           800

#define IC_TYPE_NAME_SEG_PRD          801  /* Periodic with Segment and Name */
#define IC_TYPE_SEG_PRD               802  /* Periodic with Segment*/
#define IC_TYPE_NAME_PRD              803  /* Periodic with Name   */
#define IC_TYPE_PERIODIC              804  /* Periodic             */

#define IC_TYPE_NAME_SEG_PRF          805  /* Profile  with Segment and Name */
#define IC_TYPE_SEG_PRF               806  /* Profile  with Segment*/
#define IC_TYPE_NAME_PRF              807  /* Profile  with Name   */
#define IC_TYPE_PROFILE               808  /* Profile              */

#define IC_TYPE_MATRIX_ACCOUNT        809  /* matrix TA Types      */

/*-- Application Block 8 Access and Transfer Object Types -- */

#define IC_TYPE_DEV_OUT_NEW_REV        830  /* Device Outage New or Revised */
#define IC_TYPE_DEV_OUT_CANCEL         831  /* Device Outage Cancel */
#define IC_TYPE_DEV_OUT_ACTUAL         832  /* Device Outage Actual */
#define IC_TYPE_POWER_PLANT_AVAIL      833  /* Power plant available */
#define IC_TYPE_POWER_PLANT_UNAVAIL    834  /* Power plant unavailable */
#define IC_TYPE_POWER_PLANT_RT_AVAIL   835  /* Power plant realtime status availability */
#define IC_TYPE_POWER_PLANT_RT_UNAVAIL 836  /* Power plant realtime status unavailability */
#define IC_TYPE_FORECAST               837  /* Forecast */
#define IC_TYPE_CURVE                  838  /* Curve */
#define IC_TYPE_GEN_DATA_REPORT        839  /* General Data Report */
#define IC_TYPE_GEN_DATA_RESPONSE      840  /* General Data Report response */
#define IC_TYPE_CURVE_SEG_DESCR        841  /* Curve Segment Description */

#define IC_TYPE_USER_DEFINED_START     850  /* The first user defined type */

#define IC_TYPE_USER_DEFINED_1         (IC_TYPE_USER_DEFINED_START + 0)
#define IC_TYPE_USER_DEFINED_2         (IC_TYPE_USER_DEFINED_START + 1)
#define IC_TYPE_USER_DEFINED_3         (IC_TYPE_USER_DEFINED_START + 2)
#define IC_TYPE_USER_DEFINED_4         (IC_TYPE_USER_DEFINED_START + 3)
#define IC_TYPE_USER_DEFINED_5         (IC_TYPE_USER_DEFINED_START + 4)
#define IC_TYPE_USER_DEFINED_6         (IC_TYPE_USER_DEFINED_START + 5)
#define IC_TYPE_USER_DEFINED_7         (IC_TYPE_USER_DEFINED_START + 6)
#define IC_TYPE_USER_DEFINED_8         (IC_TYPE_USER_DEFINED_START + 7)
#define IC_TYPE_USER_DEFINED_9         (IC_TYPE_USER_DEFINED_START + 8)

#define IC_B8_USER_TYPE_MAX           IC_TYPE_MATRIX_ACCOUNT

/*
 *  New Block 8 User Data Types - Account Object Types
 */

#define IC_B8_NEW_TYPES               IC_TYPE_USER_DEFINED_9

#define IC_B8_TEXT32_VALUE            IC_B8_NEW_TYPES + 1
#define PT_B8_TEXT32_VALUE            IC_B8_TEXT32_VALUE

#define IC_B8_UNIT_CAPACITY           IC_B8_NEW_TYPES + 2
#define PT_B8_UNIT_CAPACITY           IC_B8_UNIT_CAPACITY

#define IC_B8_RAMP_RATE               IC_B8_NEW_TYPES + 3
#define PT_B8_RAMP_RATE               IC_B8_RAMP_RATE

#define IC_B8_AVAIL_CLASS             IC_B8_NEW_TYPES + 4
#define PT_B8_AVAIL_CLASS             IC_B8_AVAIL_CLASS

#define IC_B8_NEW_TYPES_MAX           IC_B8_AVAIL_CLASS

/*
 *  New Block 8 User Data Types - Project Defined Types
 */

#define IC_B8_PROJECT_TYPES           IC_B8_NEW_TYPES_MAX

#define IC_FLOAT_ACCOUNT              0
#define IC_INTEGER_ACCOUNT            1
#define IC_PROFILE_ACCOUNT            2
/*
 *  Block 9 User Data Types 
 */
#define IC_B9_USER_TYPE_MIN           900
#define IC_B9_USER_TYPE_MAX           900

/* -- Data/Transfer Set Min/Max Values -- */