sdh_return_codes.h

Go to the documentation of this file.

//======================================================================
//======================================================================

#ifndef SDH_COMPONENTS_SDH_RETURN_CODES_h_
#define SDH_COMPONENTS_SDH_RETURN_CODES_h_

//----------------------------------------------------------------------
// System Includes - include with <>
//----------------------------------------------------------------------


//----------------------------------------------------------------------
// Project Includes - include with ""
//----------------------------------------------------------------------


//----------------------------------------------------------------------
// Defines, enums, unions, structs
//----------------------------------------------------------------------

// since this file is included by other compilers which dont understand
// attributes we can only use it if SDH__attribute__ is not yet defined
#ifndef SDH__attribute__
# define SDH__attribute__( ... ) __attribute__(__VA_ARGS__)
#endif

#ifndef SDH_USE_VCC
# define SDH_USE_VCC 0
#endif


#if SDH_USE_VCC
#pragma pack(push,1)  // for VCC (MS Visual Studio) we have to set the necessary 1 byte packing with this pragma
#endif

enum eReturnCodeEnum
{
    RC_OK = 0,                 
    RC_NOT_AVAILABLE,          
    RC_NOT_INITIALIZED,        
    RC_ALREADY_RUNNING,        
    RC_FEATURE_NOT_SUPPORTED,
    RC_INCONSISTENT_DATA,
    RC_TIMEOUT,                
    RC_READ_ERROR,             
    RC_WRITE_ERROR,            
    RC_INSUFFICIENT_RESOURCES, 
    RC_CHECKSUM_ERROR,
    RC_NOT_ENOUGH_PARAMS,      
    RC_NO_PARAMS_EXPECTED,
    RC_CMD_UNKNOWN,            
    RC_CMD_FORMAT_ERROR,       
    RC_ACCESS_DENIED,
    RC_ALREADY_OPEN,
    RC_CMD_FAILED,
    RC_CMD_ABORTED,
    RC_INVALID_HANDLE,
    RC_DEVICE_NOT_FOUND,
    RC_DEVICE_NOT_OPENED,
    RC_IO_ERROR,               
    RC_INVALID_PARAMETER,      
    RC_RANGE_ERROR,
    RC_NO_DATAPIPE,
    RC_INDEX_OUT_OF_BOUNDS,    
    RC_HOMING_ERROR,
    RC_AXIS_DISABLED,
    RC_OVER_TEMPERATURE,
    RC_MAX_COMMANDS_EXCEEDED,  
    RC_INVALID_PASSWORD,       
    RC_MAX_COMMANDLINE_EXCEEDED, 
    RC_CRC_ERROR,              
    RC_NO_COMMAND,             

    RC_INTERNAL,               
    RC_UNKNOWN_ERROR,          

    // Dont forget to add new enums to ReturnCodeToString() too.
    RC_DIMENSION          
} SDH__attribute__((__packed__));

typedef enum eReturnCodeEnum eReturnCode;

#if SDH_USE_VCC
#pragma pack(pop)   // for VCC (MS Visual Studio) restore normal packing
#endif

//----------------------------------------------------------------------
// Global variables (declarations)
//----------------------------------------------------------------------

//----------------------------------------------------------------------
// External functions (function declarations)
//----------------------------------------------------------------------

//----------------------------------------------------------------------
// Function prototypes (function declarations)
//----------------------------------------------------------------------


#endif


//======================================================================
/*
  Here are some settings for the emacs/xemacs editor (and can be safely ignored):
  (e.g. to explicitely set C++ mode for *.h header files)

  Local Variables:
  mode:C
  mode:ELSE
  End:
*/
//======================================================================