online_distribution/newbasic/dataBlockHdr.h

0001 /*
0002 ** dataBlockHdr.h
0003 **
0004 ** Author: $Author: purschke $
0005 **   Date: $Date: 2000/07/21 01:51:11 $
0006 **
0007 ** $Log: dataBlockHdr.h,v $
0008 ** Revision 1.1.1.1  2000/07/21 01:51:11  purschke
0009 ** mlp -- adding the new automakified "basic" module to CVS.
0010 **
0011 **
0012 ** Revision 1.3  1998/12/11 22:01:15  markacs
0013 ** (stephen markacs) adding log into cvs tags
0014 **
0015 */
0016 /*
0017 **
0018 **  dataBlockHdr.h
0019 **
0020 **  This file defines the descriptor for the data block and some constants
0021 **  used for interpreting, accessing or storing data in the descriptor.
0022 **  It also defines the default setting for all of the data descriptor
0023 **  fields, even those set by the user.
0024 **/
0025
0026
0027 #ifndef _DATABLOCKHDR_
0028 #define _DATABLOCKHDR_
0029
0030 /*
0031 **  Use C linkage
0032 */
0033 #ifdef __cplusplus
0034 extern "C" {
0035 #endif
0036
0037   typedef
0038     struct dataBlockHdr {
0039
0040       BYTE      wordSize        ; /* "Word" size used to store packet data   */
0041       BYTE      addrLength      ; /* number of bytes used for channel address*/
0042       BYTE      hitLength       ; /* Length of a single "hit" in bytes       */
0043       BYTE              dataPadding             ; /* Padding of the data block               */
0044
0045       SWORD     hitFormat       ; /* Format of a single hit                  */
0046       SWORD     numEntries      ; /* Number of "objects" stored in packet    *
0047                            * (definition depends on packetStruct)    */
0048     } DATABLOCKHDR, * DATABLOCKHDR_ptr;
0049   /*
0050   **   These are the default settings for all of the fields
0051   **   in the data descriptor.  Some of the fields are user specified,
0052   **   but still have default values listed here.
0053   */
0054
0055 #define CURRENT_NUM_ENTRIES 0
0056 #define CURRENT_WORD_SIZE 0
0057 #define CURRENT_HIT_LENGTH 0
0058 #define CURRENT_HIT_FORMAT 0
0059 #define CURRENT_ADDR_LENGTH 0
0060 #define CURRENT_DATA_PADDING 0
0061 #define CURRENT_DESC_LENGTH 2
0062 #define CURRENT_UNSTRUCT_DESC_LENGTH 1
0063
0064 CONSTANT UINT currentNumEntries = CURRENT_NUM_ENTRIES;
0065 CONSTANT UINT currentWordSize = CURRENT_WORD_SIZE;
0066 CONSTANT UINT currentHitLength = CURRENT_HIT_LENGTH;
0067 CONSTANT UINT currentHitFormat = CURRENT_HIT_FORMAT;
0068 CONSTANT UINT currentAddrLength = CURRENT_ADDR_LENGTH;
0069 CONSTANT UINT currentDataPadding = CURRENT_DATA_PADDING;
0070 CONSTANT UINT currentDescLength = CURRENT_DESC_LENGTH;
0071 CONSTANT UINT currentUnstructDescLength = CURRENT_UNSTRUCT_DESC_LENGTH;
0072 #ifdef __cplusplus
0073 }
0074 /* end of extern "C" */
0075 #endif
0076
0077 #endif
0078 /* end the ifndef in _DATABLOCKHDR_ block */