online_distribution/newbasic/dataBlockPublic.h

0001 /*
0002 ** dataBlockPublic.h
0003 **
0004 ** Author: $Author: purschke $
0005 **   Date: $Date: 2000/07/21 01:51:11 $
0006 **
0007 ** $Log: dataBlockPublic.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:16  markacs
0013 ** (stephen markacs) adding log into cvs tags
0014 **
0015 */
0016 /*
0017 ** dataBlockPublic.h
0018 **
0019 **   This file contains enumerations, typedefs etc. that public users of
0020 **   data descriptor C and C++ routines might need.
0021 **
0022 */
0023
0024 #include "phenixOnline.h"
0025 #include "dataBlockHdr.h"
0026 #include "packetPublic.h"
0027
0028 #ifndef _DATABLOCKPUBLIC_
0029 #define _DATABLOCKPUBLIC_
0030
0031 /*
0032 **  Use C linkage in C++ code
0033 */
0034 #ifdef __cplusplus
0035 extern "C" {
0036 #endif
0037
0038   /*
0039   **  We point to the data descriptor using a PHDWORD pointer.
0040   */
0041   typedef PHDWORD* DATABLOCK_ptr;
0042
0043   /*
0044   **  The error entry structure for the data descriptor should be the
0045   **  same as for the packet routines.  The typedef is given in
0046   **  packetPublic.h and the error waring is "PACKETERROR", rather
0047   **  than a seperate command for the descriptor.
0048   */
0049
0050   /*
0051   **  Presumably, when the various sorts of data sturctures are
0052   **  fully enumerated, there will be a set of enumerations corresponding
0053   **  to the various types of data descriptors used to describe
0054   **  those structures.  These should follow the packet structure types
0055   **  enumerated in packetPublic.h.  As of now there is only the one dword
0056   **  unstructured type of descriptor and a two dword type which has all
0057   **  possible fields set. The latter of these will probably never be
0058   **  actually used.
0059   */
0060
0061 #ifdef __cplusplus
0062 }  /* end extern C block */
0063 #endif
0064
0065 #endif
0066 /* end ifdef _DATABLOCKPUBLIC_ */
0067
0068
0069
0070
0071