sbgErrorCodes.h

Go to the documentation of this file.

#ifndef SBG_ERROR_CODES_H
#define SBG_ERROR_CODES_H

// Local headers
#include "sbgDefines.h"

//----------------------------------------------------------------------//
//- Errors code definitions                                            -//
//----------------------------------------------------------------------//

typedef enum _SbgErrorCode
{
        SBG_NO_ERROR = 0,                                               
        SBG_ERROR,                                                              
        SBG_NULL_POINTER,                                               
        SBG_INVALID_CRC,                                                
        SBG_INVALID_FRAME,                                              
        SBG_TIME_OUT,                                                   
        SBG_WRITE_ERROR,                                                
        SBG_READ_ERROR,                                                 
        SBG_BUFFER_OVERFLOW,                                    
        SBG_INVALID_PARAMETER,                                  
        SBG_NOT_READY,                                                  
        SBG_MALLOC_FAILED,                                              
        SGB_CALIB_MAG_NOT_ENOUGH_POINTS,                
        SBG_CALIB_MAG_INVALID_TAKE,                             
        SBG_CALIB_MAG_SATURATION,                               
        SBG_CALIB_MAG_POINTS_NOT_IN_A_PLANE,    
        SBG_DEVICE_NOT_FOUND,                                   
        SBG_OPERATION_CANCELLED,                                
        SBG_NOT_CONTINUOUS_FRAME,                               
        SBG_INCOMPATIBLE_HARDWARE,                              
        SBG_INVALID_VERSION                                             
} SbgErrorCode;

//----------------------------------------------------------------------//
//- Error codes to string litteral conversion                          -//
//----------------------------------------------------------------------//

static inline const char *sbgErrorCodeToString(SbgErrorCode errorCode)
{
        static const char *sbgErrorCodeString[] =
        {
                "SBG_NO_ERROR",
                "SBG_ERROR",
                "SBG_NULL_POINTER",
                "SBG_INVALID_CRC",
                "SBG_INVALID_FRAME",
                "SBG_TIME_OUT",
                "SBG_WRITE_ERROR",
                "SBG_READ_ERROR",
                "SBG_BUFFER_OVERFLOW",
                "SBG_INVALID_PARAMETER",
                "SBG_NOT_READY",
                "SBG_MALLOC_FAILED",
                "SGB_CALIB_MAG_NOT_ENOUGH_POINTS",
                "SBG_CALIB_MAG_INVALID_TAKE",
                "SBG_CALIB_MAG_SATURATION",
                "SBG_CALIB_MAG_POINTS_NOT_IN_A_PLANE",
                "SBG_DEVICE_NOT_FOUND",
                "SBG_OPERATION_CANCELLED",
                "SBG_NOT_CONTINUOUS_FRAME",
                "SBG_INCOMPATIBLE_HARDWARE",
                "SBG_INVALID_VERSION"
        };

        assert(errorCode < SBG_ARRAY_SIZE(sbgErrorCodeString));
        return sbgErrorCodeString[errorCode];
}

#endif  /* SBG_ERROR_CODES_H */