icsdkt.h

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

/*                                SPECTRUM: C                            txt off
 * Copyright (C) Siemens AG 1993 All Rights Reserved.Confidential
 * ICCP Protocol Engine data definitions
 *
 * $Id: icsdkt.h,v 1.000.1.11 1997/09/10 19:01:35 rwoodruf Exp $
 *
 * $NewRev$
 * $NewRevEnd$
 *
 * revision 08/01/02 changes to chanConfType for 8 remote ar names
 * revision 11/28/00 additions to support icDataValuesChanged;
 * Revision 05/24/00 add more dataSet states
 * Revision 04/21/00 add cleanAssoc flag to peerType - nav
 * Revision 02/07/00 add criticalTimerEntryQueue by nav @ sisco
 * Revision 1.000.1.17  1999/03/26  20:12:38  rwoodruf
 * Add icpeWaitAssoc to icpeStateType: making icpeWaitAssoc mean waiting
 * for init (listener) or init_conf (initiator); and icpeWaitUp mean
 * assoc established but waiting for initial read. EMP18389
 * Revision 1.000.1.14  1998/10/14  18:41:49  rwoodruf
 * Remove icpeLinkFailEvent from icpeEventType. EMP17849
 * 		patches added by nav at sisco 09/03/99
 *
 * Revision 11/02/98 add B4B8 globals to peerType by nav @ SISCO
 *
 * Revision 1998/01/14 SISCO Inc: port to SUN Solaris v2.5 for SPARC wokstation.
 * Changed MMS-EASE include files from <> to "".
 *
 * $Log: icsdkt.h,v $
 * Revision 1.000.1.11  1997/09/10  19:01:35  rwoodruf
 * Add icDsObjState field to cDataSetObjectType record. EMP13988
 *
 * Revision 1.000.1.10  1997/08/29  19:51:38  nancyl
 * Changes needed to allow ICCP code to be merged into Vienna base
 * EMP13971
 *
 * Revision 1.000.1.09  1997/08/13  20:29:52  rwoodruf
 * Remove fields myIdentifier, myName, localIdentifier and
 * peerIdentifier from peerType and add fields localDomName
 * andremoteDomName. EMP13897
 *
 * Revision 1.000.1.08  1997/08/05  18:21:29  rwoodruf
 * Remove mp read flags from peerType. EMP12875
 *
 * Revision 1.000.1.07  1997/06/27  22:23:04  shri
 * Modified cDataSetObjectType structure to contain
 * CriticalDataNotRcvdTimer & CriticalAckInterval field. EMP13291
 *
 * Revision 1.000.1.06  1997/05/28  21:05:57  shri
 * Transfered Transmit Queue Full code from NT to AIX EMP13185
 *
 * Revision 1.000.1.05  1997/04/18  22:02:10  shri
 * Multi-threading changes & SISCO recomended changes EMP12885
 *
 * Revision 1.000.1.04  1997/04/08  00:13:02  shri
 * Added icpeEventType enum EMP12884
 *
 * Revision 1.000.1.03  1997/04/07  15:15:35  rwoodruf
 * Add transfer group pointers to conditionDefEntryType and
 * cDataSetObjectType records. EMP11732
 *
 * Revision 1.000.1.02  1997/03/25  23:31:45  shri
 * NT Changes EMP12684
 *
 * Revision 1.000.1.01  1996/10/10  21:42:13  kevinr
 *  EMP9614
 * Got rid of some types that are no longer used for event processing.
 * Added objectIndex to objectChangeNotifyType.
 *
 * Revision 1.000.1.00  1996/09/11  00:25:59  kevinr
 * -- revision created by srcinit -- EMP10251
 *
 * Revision 1.000  1996/09/11  00:25:59  kevinr
 * Initial revision EMP10251
 * This is a copy of the def_c/ict.h file (rev. 1.000.1.05) with
 * the unnecessary items removed.
 *
 * $Logend$
 *                                                                       txt on-
 */                                                                      /*-*/


#ifndef _ICSDKT_H
#define _ICSDKT_H

/* SISCO_START */
#ifdef __cplusplus
extern "C" {
#endif

/* SISCO_END  */


/* FILE START
*******************************************************************************

NAME
    icsdkt.h - Common typedefs for ICCP SDK

SCOPE
    Internal to subsystem.

SYNOPSIS
    #include <icsdkt.h>

DESCRIPTION
    The ICCP SDK data definitions are defined here.

NOTES


*******************************************************************************
FILE END */

#include "glbtypes.h"

#if SPEC_SUBSYSTEM_TREE
#include <comms/DEF/icapi.h>
#else  /* SPEC_SUBSYSTEM_TREE */
#include <icapi.h>
#endif /* SPEC_SUBSYSTEM_TREE */

#include "icsdkc.h"

/* the following define the data point type */

/*
 *
 * Foundation Type
 *
 * unsigned char = one byte integer
 * short int     = two byte integer
 * long int      = four byte integer
 * int           = four byte integer
 * unsigned int  = four byte integer
 */

/*
 * Time Interval Types
 */

typedef icShort timeIntervalDType;     /* time interval in days    */
typedef icShort timeIntervalHType;     /* time interval in hours   */
typedef icShort timeIntervalMType;     /* time interval in minutes */
typedef icShort timeIntervalSType;     /* time interval in seconds */
typedef icShort timeIntervalL16Type;   /* time interval in millis  */
typedef icLong  timeIntervalL32Type;   /* time interval in millis  */

/*
 *****  NOTE  *****  NOTE  *****  NOTE  *****  NOTE  *****
 *
 *  Any change to the ICCP types should also change
 *  MMS type definition in iccp.c
 *
 *****  NOTE  *****  NOTE  *****  NOTE  *****  NOTE  *****
 */

/*
 * ICCP Time Stamp Types
 */

typedef icLong  GMTBasedSType;  /* seconds since Jan. 1, 1970 GMT */
typedef icLong  GMTBasedMType;  /* minutes since Jan. 1, 1970 GMT */
typedef icLong  GMTBasedHType;  /* hours since Jan. 1, 1970 GMT */
typedef icLong  GMTBasedDType;  /* days since Jan. 1, 1970 GMT */

/*
 *
 * Local Data Value Type
 *
 */

typedef struct ldValue
{
    short               type;
} ldValue;

typedef ldValue *ldValueType;

/*
 * ES data Types
 */

#define PT_STATE               0  /* ldUniversalDataAreaType.d0/d1 */
#define PT_DISCRETE            1  /* ldUniversalDataAreaType.d2/d3 */
#define PT_REAL                2  /* ldUniversalDataAreaType.d2/d3 */

/*
 * Iccp Type definitions
 */

#define PT_DATA_STATE             IC_TYPE_STATE               /* = 0  */
#define PT_DATA_STATEQ            IC_TYPE_STATE_Q             /* = 1  */
#define PT_DATA_STATEQ_TIMETAG    IC_TYPE_STATE_Q_TIME_TAG    /* = 2  */
#define PT_DATA_STATEQ_EXT        IC_TYPE_STATE_EXTENDED      /* = 3  */

#define PT_DATA_DISCRETE          IC_TYPE_DISCRETE            /* = 4  */
#define PT_DATA_DISCRETEQ         IC_TYPE_DISCRETE_Q          /* = 5  */
#define PT_DATA_DISCRETEQ_TIMETAG IC_TYPE_DISCRETE_Q_TIME_TAG /* = 6  */
#define PT_DATA_DISCRETEQ_EXT     IC_TYPE_DISCRETE_Q_EXTENDED /* = 7  */

#define PT_DATA_REAL              IC_TYPE_REAL                /* = 8  */
#define PT_DATA_REALQ             IC_TYPE_REAL_Q              /* = 9  */
#define PT_DATA_REALQ_TIMETAG     IC_TYPE_REAL_Q_TIME_TAG     /* = 10 */
#define PT_DATA_REALQ_EXT         IC_TYPE_REAL_EXTENDED       /* = 11 */

#define PT_DATA_USER_DEFINED      IC_TYPE_USER_DEFINED        /* = 12 */
#define MAX_LD_PT                PT_DATA_USER_DEFINED

/*
 *
 * Data Point Definition Type
 *
 */

typedef struct ldStateDefType
{
    short                  type;          /* ICCP data type, could be
                                             PT_DATA_STATE,
                                             PT_DATA_STATEQ,
                                             PT_DATA_STATEQ_TIMETAG   */
    short                  scope;         /* be VMD_SPEC, DOM_SPEC,
                                             or AA_SPEC               */
    union ldUniversalValueAreaType *SDKvaluePtr; /* Pointer to SDK value*/
    icVariableId           SDKvariableId; /* SDK variable ID          */
    unsigned char          source;        /* telemetered or calculated*/
    unsigned char          normalState;   /* state normally in        */
    short                  nameSize;      /* Num of chars in name, not
                                             including zero byte
                                             terminator               */
    char                   name[1];       /* Name, nameSize+1 is actual
                                             array size               */
} ldStateDefType;

typedef struct ldStateExtDefType
{
    short                  type;          /* ICCP data type, always is
                                                PT_DATA_STATEQ_EXT    */
    short                  scope;         /* be VMD_SPEC, DOM_SPEC,
                                             or AA_SPEC               */
    union ldUniversalValueAreaType *SDKvaluePtr; /* Pointer to SDK value*/
    icVariableId           SDKvariableId; /* SDK variable ID          */
    unsigned char          source;        /* telemetered or calculate */
    unsigned char          normalState;   /* state normally in        */
    short                  nameSize;      /* Num of chars in name, not
                                             including zero byte
                                             terminator               */
    char                   name[1];       /* Name, nameSize+1 is actual
                                             array size               */
} ldStateExtDefType;

typedef struct ldDataDefType
{
    short                  type;          /* ICCP data types, could be
                                             PT_DATA_REAL,
                                             PT_DATA_REALQ,
                                             PT_DATA_REALQ_TIMETAG,
                                             PT_DATA_DISCRETE,
                                             PT_DATA_DISCRETEQ,
                                             PT_DATA_DISCRETEQ_TIMETAG*/
    short                  scope;         /* be VMD_SPEC, DOM_SPEC,
                                             or AA_SPEC               */
    union ldUniversalValueAreaType *SDKvaluePtr; /* Pointer to SDK value*/
    icVariableId           SDKvariableId; /* SDK variable ID          */
    unsigned char          source;        /* telemetered or calculate */
    short                  nameSize;      /* Num of chars in name, not
                                             including zero byte
                                             terminator               */
    char                   name[1];       /* Name, nameSize+1 is actual
                                             array size               */
} ldDataDefType;

typedef struct ldDataExtDefType
{
    short                  type;          /* ICCP data type, could be
                                             PT_DATA_REALQ_EXT,
                                             PT_DATA_DISCRETEQ_EXT   */
    short                  scope;         /* be VMD_SPEC, DOM_SPEC,
                                             or AA_SPEC               */
    union ldUniversalValueAreaType *SDKvaluePtr; /* Pointer to SDK value*/
    icVariableId           SDKvariableId; /* SDK variable ID          */
    unsigned char          source;        /* telemetered or calculate */
    short                  nameSize;      /* Num of chars in name, not
                                             including zero byte
                                             terminator               */
    char                   name[1];       /* Name, nameSize+1 is actual
                                             array size               */
} ldDataExtDefType;

/*
 *
 * ICCP Real Time Data Point Type Descriptions
 *
typedef GMTBasedSType    data_TimeStampType;   in <def_c/icapi.h>

 */
typedef icGMTBasedSType    data_TimeStampType;

typedef float            data_RealType;       /* format 24, exponent 8 */
typedef unsigned char    data_StateType;      /* 8 bits                */
typedef int              data_DiscreteType;   /* integer 32            */
typedef unsigned char    data_FlagType;       /* 8 bits                */
typedef unsigned short   data_CovCounterType; /* unsigned width 16     */


/*
 *
 * ICCP Status Point Type
 *
 */


typedef data_FlagType ldDataStateType;    /* type = PT_DATA_STATE */

typedef data_FlagType ldDataStateQType;   /* type = PT_DATA_STATEQ */

typedef struct ldDataStateQTimeTagType /* type= PT_DATA_STATEQ_TIMETAG*/
{
    data_TimeStampType     TimeStamp;     /* time stamp        */
    data_FlagType          Flags;         /* quality code      */
} ldDataStateQTimeTagType;

typedef struct ldDataStateQExtType        /* type= PT_DATA_STATEQ_EXT */
{
    data_TimeStampType     TimeStamp;     /* time stamp        */
    data_FlagType          Flags;         /* quality code      */
    data_CovCounterType    COVCount;      /* COV Counter       */
} ldDataStateQExtType;

/*
 *
 * ICCP Discrete Point Type
 *
 */

typedef struct ldDataDiscreteType         /* type = PT_DATA_DISCRETE */
{
    data_DiscreteType      Value;         /* point value       */
} ldDataDiscreteType;

typedef struct ldDataDiscreteQType        /* type = PT_DATA_DISCRETEQ */
{
    data_DiscreteType      Value;         /* point value       */
    data_FlagType          Flags;         /* quality code      */
} ldDataDiscreteQType;

typedef struct ldDataDiscreteQTimeTagType
                                  /* type = PT_DATA_DISCRETEQ_TIMETAG */
{
    data_DiscreteType      Value;         /* point value       */
    data_TimeStampType     TimeStamp;     /* time stamp        */
    data_FlagType          Flags;         /* quality code      */
} ldDataDiscreteQTimeTagType;

typedef struct ldDataDiscreteQExtType /* type = PT_DATA_DISCRETEQ_EXT */
{