error.h

Go to the documentation of this file.
00001 // ////////////////////////////////////////////////////////////////////////////
00002 // ////////////////////////////////////////////////////////////////////////////
00018 // ////////////////////////////////////////////////////////////////////////////
00019 // ////////////////////////////////////////////////////////////////////////////
00020 
00021 
00022 #ifndef ERROR_H
00023 
00024 #define     ERROR_H
00025 
00026 
00027 // ////////////////////////////////////////////////////////////////////////////
00028 // Includes
00029 // ////////////////////////////////////////////////////////////////////////////
00030 
00031 
00032 // ////////////////////////////////////////////////////////////////////////////
00033 // Defines
00034 // ////////////////////////////////////////////////////////////////////////////
00035 
00036 #ifdef ERROR_C
00037     #define PROTO
00038 #else
00039     #define PROTO extern
00040 #endif
00041 
00042 
00043 // ////////////////////////////////////////////////////////////////////////////
00044 // Typedefs
00045 // ////////////////////////////////////////////////////////////////////////////
00046 
00047 /* This enum lists all possible error codes of the application. If the display 
00048 shows a common error, please refer to this list to get mor knowledge about the
00049 error reason.
00050 */
00051 typedef enum
00052 {
00053     COMMON_ERROR_LOADING_SRCP_PROTOCOL = 1, // 1
00054     COMMON_ERROR_OUT_OF_MEMORY,             // 2
00055     COMMON_ERROR_NULL_POINTER,              // 3
00056     COMMON_ERROR_SRCP_NO_POWER_DEVICE,      // 4
00057     COMMON_ERROR_ROCRAIL_LOCO_NOT_FOUND     // 5
00058 } eCommonErrorCodes;
00059 
00060 
00061 // ////////////////////////////////////////////////////////////////////////////
00062 // Function prototypes
00063 // ////////////////////////////////////////////////////////////////////////////
00064 
00065 /* This function prints the code as formated string on the display.
00066 \param eErrorCode A error code to print.
00067 */
00068 PROTO void PrintCommonError(eCommonErrorCodes eErrorCode);
00069 
00072 // ////////////////////////////////////////////////////////////////////////////
00073 // Epilogue
00074 // ////////////////////////////////////////////////////////////////////////////
00075 
00076     #undef      PROTO
00077 
00078 #endif  // #ifndef ERROR_H

Generated on Sun Nov 27 20:02:38 2011 for eWicht by  doxygen 1.5.5