Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
formatError.h
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file formatError.h
1 /*
2 ** formatError.h
3 **
4 ** Author: $Author: purschke $
5 ** Date: $Date: 2000/07/21 01:51:13 $
6 **
7 ** $Log: formatError.h,v $
8 ** Revision 1.1.1.1 2000/07/21 01:51:13 purschke
9 ** mlp -- adding the new automakified "basic" module to CVS.
10 **
11 **
12 ** Revision 1.5 1998/12/17 21:57:06 phoncs
13 ** (stephen markacs) better bounds checking in version gets
14 **
15 ** Revision 1.4 1998/12/11 22:01:18 markacs
16 ** (stephen markacs) adding log into cvs tags
17 **
18 */
19 /*
20 ** formatError.h
21 **
22 ** Definitions of various error-handling macros, prototypes, variables etc
23 */
24 
25 #ifndef _FORMATERROR_
26 #define _FORMATERROR_
27 
28 #include "phenixOnline.h"
29 
30 /*
31 ** Use C linkage for error routines
32 */
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 typedef UINT ERRORVALUE;
38 
39 #define FORMAT_ERROR_SUBTYPE_FRAME 1
40 #define FORMAT_ERROR_SUBTYPE_PACKET 2
41 #define FORMAT_ERROR_SUBTYPE_USER 3
42 
43 CONSTANT UINT errorTypeFrame = FORMAT_ERROR_SUBTYPE_FRAME;
44 CONSTANT UINT errorTypePacket = FORMAT_ERROR_SUBTYPE_PACKET;
45 CONSTANT UINT errorTypeUser = FORMAT_ERROR_SUBTYPE_USER;
46 
47 /*
48 ** Some function prototypes
49 */
50 void setFrameError(ERRORVALUE, PHDWORD*, PHDWORD);
51 
52 void setPacketError(ERRORVALUE, PHDWORD*, PHDWORD);
53 
54 void setUserError(ERRORVALUE, PHDWORD);
55 
56 void setFrameSuccess ();
57 
58 void setPacketSuccess ();
59 
60 ERRORVALUE formatGetError (UINT*, PHDWORD**, PHDWORD*);
61 
62 ERRORVALUE formatGetErrorNumber ( );
63 
64 PHDWORD* formatGetErrorPointer ( );
65 
66 PHDWORD formatGetErrorAdditionalData ( );
67 
68 /*
69 ** Error code definitions
70 */
71 enum formatErrorCodes {
72  FORAMT_ERR_SUCCESS = 0,
73  FORMAT_ERR_INVALID_HEADER,
74  FORMAT_ERR_INVALID_HDRVERSION,
75  FORMAT_ERR_INVALID_PACKET_HDRVERSION,
76  FORMAT_ERR_INVALID_DATA,
77  FORMAT_ERR_HISTORY_OVERFLOW,
78  FORMAT_ERR_ERROR_OVERFLOW,
79  FORMAT_ERR_BUFFER_OVERFLOW,
80  FORMAT_ERR_INVALID_MODIFY,
81  FORMAT_ERR_INVALID_FRAMEMARK,
82  FORMAT_ERR_LENGTH_OVERFLOW,
83  FORMAT_ERR_INVALID_HDRLENGTH,
84  FORMAT_ERR_INVALID_APPEND,
85  FORMAT_ERR_WRONG_STRUCTURE,
86  FORMAT_ERR_HDR_INCONSISTENCY,
87  FORMAT_ERR_DATA_INCONSISTENCY,
88  FORMAT_ERR_NONEMPTY_PACKET
89 };
90 
91 /*
92 ** Use C linkage for below structures
93 */
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif
99 
100 
101 
102 
103