icb8t.h

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

/*                                SPECTRUM: C                            txt off
 * Copyright (C) Siemens AG 1995 All Rights Reserved.Confidential
 * description - ICCP Block 8 sdk type definitions
 *
 * $Id: icb8t.h,v 1.000.1.08 1997/10/20 22:38:41 sbecchet Exp $
 *
 * $NewRev$
 * $NewRevEnd$
 *
 * $Log: icb8t.h,v $
 * Revision 1.000.1.08  1997/10/20  22:38:41  sbecchet
 * Add Curve and Curve Segment Description.
 * Add Forecast. EMP14325
 *
 * Revision 1.000.1.07  1997/08/29  19:50:28  nancyl
 * Changes needed to allow ICCP code to be merged into Vienna base
 * EMP13971
 *
 * Revision 1.000.1.06  1997/06/18  14:48:23  sbecchet
 * Add new ICCP Block 4 and Block 8 functionality EMP13388
 *
 * Revision 1.000.1.05  1997/04/18  22:01:22  shri
 * Multi-threading changes & SISCO recomended changes EMP12885
 *
 * Revision 1.000.1.04  1997/03/11  18:50:17  nancyl
 * Change VNAME_REQUEST_ID from RequestId to Request_Id EMP12519
 *
 * Revision 1.000.1.03  1996/09/30  19:53:52  bjmao
 * ICCP Block 8 Version 1996-08 update. EMP10569
 *
 * Revision 1.000.1.02  1996/09/11  00:03:30  kevinr
 *  EMP10251
 * Moved this file from def_c to iccp/icapi.  Removed several sections
 * of the file that were basically commented out by a '#if 0'.  Sections
 * had previously been moved to icapi.h.  Added function prototypes
 * for several blk 8 functions.
 *
 * Revision 1.000.1.01  1996/06/28  19:32:18  rwoodruf
 * Upgrade ICCP SDK Block 8 processing for versions 6.0 and 1996_06.
 * EMP8859
 *
 * Revision 1.000.1.00  1996/03/05  14:56:39  bjmao
 * -- revision created by srcinit -- EMP7086
 *
 * Revision 1.000  1996/03/05  14:56:37  bjmao
 * Initial revision EMP7086
 *
 * $Logend$
 *                                                                       txt on-
 */                                                                      /*-*/

#ifndef _ICB8T_H
#define _ICB8T_H

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

NAME
    icb8t.h  -  include file for Block 8

************************************************************************
*/

#ifndef ICAPI

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

#else /* ICAPI */

#include "icapi.h"

#endif /* ICAPI */


/* -- Define a Account Object -- */

/*
 *  User Account Object Types
 */
#define PT_B8_FIRST            IC_TYPE_MATRIX_ACCOUNT      /* = 809 */
#define PT_B8_USER_TYPE_MIN    IC_TYPE_MATRIX_ACCOUNT      /* = 809 */
#define PT_TA_MATRIX_ACCOUNT   IC_TYPE_MATRIX_ACCOUNT      /* = 809 */

#define PT_TA_SEG_PERIODIC     810
#define PT_TA_NO_SEG_PRD       811
#define PT_TA_SEG_PROFILE      812
#define PT_TA_NO_SEG_PRF       813

#define PT_B8_USER_TYPE_MAX    PT_TA_NO_SEG_PRF 

/* 
 *  Additional Block 8 types
 */
#define PT_TA_CONDITIONS    (1 + PT_TA_NO_SEG_PRF)     /* 814 TACondition */
#define PT_TA_REQUEST       (1 + PT_TA_CONDITIONS)     /* 815 AccountRequest */
#define PT_TA_TRANSFER_SET  (1 + PT_TA_REQUEST)        /* 816 TATransferSet */
#define PT_TA_REQUEST_ID    (1 + PT_TA_TRANSFER_SET)   /* 817 request Id */
#define PT_TA_REFERENCE_NUM (1 + PT_TA_REQUEST_ID)     /* 818 reference num*/
#define PT_TA_TRANS_SEG     (1 + PT_TA_REFERENCE_NUM)  /* 819 Transn Segmnt */
#define PT_TA_PROFILE_VALUE (1 + PT_TA_TRANS_SEG)      /* 820 profile values */
#define PT_TA_FLOAT_VALUE   (1 + PT_TA_PROFILE_VALUE)  /* 821 float val array */
#define PT_TA_INTEGER_VALUE (1 + PT_TA_FLOAT_VALUE)    /* 822 int val array */

#define PT_B8_LAST             PT_TA_INTEGER_VALUE

#define PT_TA_SEG_PERIODIC_NAME   "TA_Segments_Periodic"
#define PT_TA_NO_SEG_PRD_NAME     "TA_NoSegments_Periodic"
#define PT_TA_SEG_PROFILE_NAME    "TA_Segments_Profile"
#define PT_TA_NO_SEG_PRF_NAME     "TA_NoSegments_Profile"

#define VNAME_TA_TRANSFER_SET         "TA_Transfer_Set"
#define VNAME_TA_CONDITIONS_DET       "TAConditions_Detected"
#define VNAME_REQUEST_ID              "Request_Id"
#define VNAME_REFERENCE_NUM           "Reference_Num"
#define VNAME_TA_TRANS_SEG            "TA_Transmission_Segment"
#define VNAME_TA_REQUEST              "TA_Account_Request"
#define VNAME_FLOAT_ARRAY1            "Float_Array_1"
#define VNAME_FLOAT_ARRAY_            "Float_Array_"
#define VNAME_INTEGER_ARRAY1          "Integer_Array_1"
#define VNAME_INTEGER_ARRAY_          "Integer_Array_"
#define VNAME_TA_PROFILE              "TA_Profile_Value"
#define VNAME_MATRIX_ID               "Matrix_Id"

#define BLK8PREFIX    "TAR"

/* 
 * foundation types for Account Objects are defined in icapi.h
 */

/*
 * Define TAConditions Object Types.
 */

#define PT_TA_CONDITIONS_NAME  "TAConditions"
#define PT_TA_CONDITIONS_TDL   "Bstring8"

typedef icChar icTypeTAConditions;

/*
 * Define TATransferSet Object Types
 */

#define PT_TA_TRANSFER_SET_NAME  "TATransferSet"
#define PT_TA_TRANSFER_SET_TDL        \
    "{(TAConditionsRequested)Bstring8,(BlockData)Bool,(Status)Bool}"

typedef struct _ictypetatransferset
{
    icTypeTAConditions        TAConditionsRequested;
    icBoolean                   BlockData;      /* TRUE (non 0), FALSE (0)   */
    icBoolean                   Status;         /* ENABLED (1), DISABLED (0) */
} icTypeTATransferSet;

#define PT_TA_TRANSFER_SET_V6x_TDL        \
    "{(TAConditionsRequested)Bstring8,(Status)Bool}"

typedef struct _ictypetatransfersetv6x
{
    icTypeTAConditions        TAConditionsRequested;
    icBoolean                   Status;         /* ENABLED (1), DISABLED (0) */
} icTypeTATransferSetV6x;

/*
 * Define RequestId Types
 */

#define PT_TA_REQUEST_ID_NAME  "RequestId"
#define PT_TA_REQUEST_ID_TDL     "Long"

typedef int  icTypeRequestId;

/* 
 *  Account Request Object
 */
  
#define PT_TA_REQUEST_NAME  "TAAccountRequest"
#define PT_TA_REQUEST_TDL         \
    "{(ReferenceTar)Long,(StartTime)Long,(Duration)Long,(RequestId)Long,(TAConditionsRequested)Bstring8}"

typedef struct icTypeAccountReq
{
    icReferenceNumType      ReferenceTar;      
    icScheduleTimeType      StartTime;        
    icDurationType          Duration;        
    icReferenceNumType      RequestId;
    icTypeTAConditions      TAConditionsRequested;
} icTypeAccountReq;
  
/*
 * Define ReferenceNumber Types
 */

#define PT_TA_REFERENCE_NUM_NAME  "ReferenceNum"
#define PT_TA_REFERENCE_NUM_TDL     "Long"

/*
 * Define FloatMatrixValueId, IntegerMatrixValueId Types

#define PT_TA_REFERENCE_NUM_NAME  "ReferenceNum"
#define PT_TA_REFERENCE_NUM_TDL     "Long"
   
 */

typedef int  icTypeMatrixId;     /* integer 32 */

/*
 * Define FloatArray Value Types
 */

#define PT_TA_FLOAT_VALUE_NAME  "Float"
#define PT_TA_FLOAT_VALUE_TDL     "Float"
   
#define PT_TA_FLOAT_ARRAY_N_NAME  "FloatArray"
#define PT_TA_FLOAT_ARRAY_NAME  "FloatArray1"
#define PT_TA_FLOAT_ARRAY_TDL     "[1:Float]"
   
typedef float icFloatValue;

/*
 * Define IntegerArray Value Types
 */

#define PT_TA_INTEGER_VALUE_NAME  "Integer"
#define PT_TA_INTEGER_VALUE_TDL     "Long"
   
#define PT_TA_INTEGER_ARRAY_N_NAME  "IntegerArray"
#define PT_TA_INTEGER_ARRAY_NAME  "IntegerArray1"
#define PT_TA_INTEGER_ARRAY_TDL     "[1:Long]"
   
typedef int icIntegerValue;

/* -- Define a Device Outage Object -- */

/*
 *  Device Outage Object Types
 */
#define PT_DO_NEW              IC_TYPE_DEV_OUT_NEW_REV
#define PT_DO_REVISED          IC_TYPE_DEV_OUT_NEW_REV
#define PT_DO_CANCEL           IC_TYPE_DEV_OUT_CANCEL
#define PT_DO_ACTUAL           IC_TYPE_DEV_OUT_ACTUAL

#define PT_DO_NEW_SCHED_NAME      "DO_New_Sched"
#define PT_DO_REV_SCHED_NAME      "DO_Rev_Sched"
#define PT_DO_CANCEL_NAME         "DO_Cancel"
#define PT_DO_ACTUAL_NAME         "DO_Actual"

/* -- Define a Power Plant Object -- */

/*
 *  Power Plant Object Types
 */
#define PT_PL_AVAILABLE         IC_TYPE_POWER_PLANT_AVAIL
#define PT_PL_UNAVAILABLE       IC_TYPE_POWER_PLANT_UNAVAIL
#define PT_PL_RT_STATUS_AVAIL   IC_TYPE_POWER_PLANT_RT_AVAIL
#define PT_PL_RT_STATUS_UNAVAIL IC_TYPE_POWER_PLANT_RT_UNAVAIL

#define PT_PL_AVAILABLE_NAME      "Available"
#define PT_PL_UNAVAIL_NAME        "UnAvailable"
#define PT_PL_STAT_AVAIL_NAME     "StatusAvailable"
#define PT_PL_STAT_UN_AVAIL_NAME  "StatusUnAvailable"

/* -- Define a Forecast Object -- */

/*
 *  Forecast Object Types
 */
#define PT_FORECAST             IC_TYPE_FORECAST

#define PT_FORECAST_NAME        "Forecast"

/* -- Define a Curve Object -- */

/*
 *  Curve Object Types
 */
#define PT_CURVE                IC_TYPE_CURVE
#define PT_CURVE_SEG_DESCR      IC_TYPE_CURVE_SEG_DESCR

#define PT_CURVE_NAME           "Curve"
#define PT_CURVE_SEG_DESCR_NAME "Curve_Segment_Description"

/* -- Define a General Data Report Object -- */

/*
 *  General Data Report Object Types
 */
#define PT_GD_REPORT            IC_TYPE_GEN_DATA_REPORT

#define PT_GD_REPORT_NAME       "General_Data_Report"

/* -- Define a General Data Response Object -- */

/*
 *  General Data Response Object Types
 */
#define PT_GD_RESPONSE          IC_TYPE_GEN_DATA_RESPONSE

#define PT_GD_RESPONSE_NAME     "General_Data_Response"

/*
 * Define Text32Array Value Types
 */

#define PT_B8_TEXT32_VALUE_NAME  "Text32"
#define PT_B8_TEXT32_VALUE_TDL     "Vstring32"

#define PT_B8_TEXT32_ARRAY_N_NAME  "Text32Array"
#define PT_B8_TEXT32_ARRAY_NAME  "Text32Array1"
#define PT_B8_TEXT32_ARRAY_TDL     "[1:Vstring32]"

typedef char icText32Value [MAX_IDENT_LEN+1];

/* 
 * SDK types for User Account Objects 
 */

typedef struct icTAVariable {
    /* -- Information created and maintained by API -- */
    icShort        Ctype ; /* 'C'ommon type field used in iccp.c */
    /* -- Information passed in by user application -- */
    icChar        *variableName; /* this must follow 'Ctype' ! */
    icInt          accountRefNum;
    icInt          variableScope;
    icInt          variableType;
    icTypeId       typeId;
    void          *varValuePtr;  /* address of storage for header value */
    icInt          accountValueType;    /* float, integer, or profile */
    icUserData     userData;
    icRemoteId     remoteId ;
    icTAInfoRcvProcType   infoReceive;    /* Call after receives info report */
    icTAInfoSendProcType  infoSend;       /* Call after receives info request */
    icReqTACondProcType   reqTAConditions; /* Call after rcvs TAConditions req*/
    struct icTAVariable  *next ;          /* ptr to next variable in chain */
}  icTAVariable ;

typedef struct icMatrixTAVariable {
    /* -- Information created and maintained by API -- */
    icShort         Ctype ; /* 'C'ommon type field used in iccp.c */
    /* -- Information passed in by user application -- */
    icChar         *variableName; /* this must follow 'Ctype' ! */
    icInt           variableScope;
    icInt           variableType;
    icInt           numFloatAccounts;  /* max number of FloatMatrixIds */
    icTypeId        floatArrayTypeId;  /* asn1 type ID for floatArrayNN */
    icTAVariableId *floatValIdPtr;     /* ptr to array of simple accounts */
    icInt           numIntAccounts;    /* max number of IntegerMatrixIds */
    icTypeId        intArrayTypeId;    /* asn1 type ID for integerArrayMM*/
    icTAVariableId *intValIdPtr;       /* ptr to array of simple accounts */
    icUserData      userData;
    icRemoteId      remoteId ;
    struct icMatrixTAVariable    *next ; /* ptr to next variable in chain */
}  icMatrixTAVariable ;

typedef icMatrixTAVariable *icMatrixTAVariableId;

typedef struct icTATypeId {
    icInt                iccpAccountType;
    icTypeId             typeId;
    struct icTATypeId    *next ; /* ptr to next variable in chain */
}  icTATypeId ;

typedef icTATypeId *icTypeIdPtr;

/* Block 8 prototype functions */
icTypeId  icGetAccountTypeId ( icInt   iccpAccountType);

icTypeId  icGetFloatArrayTypeId ( icInt   arraySize);

icTypeId  icGetIntArrayTypeId ( icInt   arraySize);

char   *icStrSaveAccount( icInt   accountRef);

icTypeId  icGetText32ArrayTypeId ( icInt   arraySize);

icInt icGetBlock4TypeIdForSize (icInt messageSize,
             icInt *bufferSize,
             icTypeId *typeId);

#endif /* _ICB8T_H */