xsens_std.h

Go to the documentation of this file.

#ifndef XSENS_STD_H
#define XSENS_STD_H


#if defined(_WIN32) && !defined(_WIN32_WINNT)
#       define _WIN32_WINNT 0x0502
#endif

#ifdef _WIN32
#       include <windows.h>
#endif

// NOTE!!! When adding a value to this list, also add its description in xsens_std.cpp
enum XsensResultValue {
        // general OK
         XRV_OK                                 = 0             

        // communication protocol
        ,XRV_NOBUS                              = 1             
        ,XRV_BUSNOTREADY                = 2             
        ,XRV_INVALIDPERIOD              = 3             
        ,XRV_INVALIDMSG                 = 4             
        ,XRV_INITBUSFAIL1               = 16    
        ,XRV_INITBUSFAIL2               = 17    
        ,XRV_INITBUSFAIL3               = 18    
        ,XRV_SETBIDFAIL1                = 20    
        ,XRV_SETBIDFAIL2                = 21    
        ,XRV_MEASUREMENTFAIL1   = 24    
        ,XRV_MEASUREMENTFAIL2   = 25    
        ,XRV_MEASUREMENTFAIL3   = 26    
        ,XRV_MEASUREMENTFAIL4   = 27    
        ,XRV_MEASUREMENTFAIL5   = 28    
        ,XRV_MEASUREMENTFAIL6   = 29    
        ,XRV_TIMEROVERFLOW              = 30    
        ,XRV_BAUDRATEINVALID    = 32    
        //,XRV_PARAMINVALID             = 33    //!< 33: An invalid parameter is supplied
        ,XRV_INVALIDPARAM               = 33    
        ,XRV_MEASUREMENTFAIL7   = 35    
        ,XRV_MEASUREMENTFAIL8   = 36    
        ,XRV_DEVICEERROR                = 40    

        // CMT / XME / etc
        ,XRV_ERROR                                      = 256   
        ,XRV_NOTIMPLEMENTED                     = 257   
        ,XRV_TIMEOUT                            = 258   
        ,XRV_TIMEOUTNODATA                      = 259   
        ,XRV_CHECKSUMFAULT                      = 260   
        ,XRV_OUTOFMEMORY                        = 261   
        ,XRV_NOTFOUND                           = 262   
        ,XRV_UNEXPECTEDMSG                      = 263   
        ,XRV_INVALIDID                          = 264   
        ,XRV_INVALIDOPERATION           = 265           
        ,XRV_INSUFFICIENTSPACE          = 266   
        ,XRV_INPUTCANNOTBEOPENED        = 267   
        ,XRV_OUTPUTCANNOTBEOPENED       = 268   
        ,XRV_ALREADYOPEN                        = 269   
        ,XRV_ENDOFFILE                          = 270   
        ,XRV_COULDNOTREADSETTINGS       = 271   
        ,XRV_NODATA                                     = 272   
        ,XRV_READONLY                           = 273   
        ,XRV_NULLPTR                            = 274   
        ,XRV_INSUFFICIENTDATA           = 275   
        ,XRV_BUSY                                       = 276   
        ,XRV_INVALIDINSTANCE            = 277   
        ,XRV_DATACORRUPT                        = 278   

        ,XRV_READINITFAILED                     = 279   
        ,XRV_NOXMFOUND                          = 280   
        ,XRV_ONLYONEXMFOUND                     = 281   
        ,XRV_MTCOUNTZERO                        = 282   
        ,XRV_MTLOCATIONINVALID          = 283   
        ,XRV_INSUFFICIENTMTS            = 284   
        ,XRV_INITFUSIONFAILED           = 285   
        ,XRV_OTHER                                      = 286   

        ,XRV_NOFILEOPEN                         = 287   
        ,XRV_NOPORTOPEN                         = 288   
        ,XRV_NOFILEORPORTOPEN           = 289   
        ,XRV_PORTNOTFOUND                       = 290   
        ,XRV_INITPORTFAILED                     = 291   
        ,XRV_CALIBRATIONFAILED          = 292   

        ,XRV_CONFIGCHECKFAIL            = 293   
        ,XRV_ALREADYDONE                        = 294   

        ,XRV_SYNC_SINGLE_SLAVE          = 295   
        ,XRV_SYNC_SECOND_MASTER         = 296   
        ,XRV_SYNC_NO_SYNC                       = 297   
        ,XRV_SYNC_NO_MASTER                     = 298   
        ,XRV_SYNC_DATA_MISSING          = 299   

        ,XRV_VERSION_TOO_LOW            = 300   
        ,XRV_VERSION_PROBLEM            = 301   

        ,XRV_ABORTED                            = 302   
};


#ifndef DELNUL
#define DELNUL(ptr)             do { delete ptr; ptr = NULL; } while (0);
#define CHKDELNUL(ptr)  do { if (ptr != NULL) { delete ptr; ptr = NULL; } } while (0);
#define LSTDELNUL(ptr)          do { delete[] ptr; ptr = NULL; } while (0);
#define LSTCHKDELNUL(ptr)       do { if (ptr != NULL) { delete[] ptr; ptr = NULL; } } while (0);

#define FREENUL(ptr)    do { free(ptr); ptr = NULL; } while (0);
#define CHKFREENUL(ptr) do { if (ptr != NULL) { free(ptr); ptr = NULL; } } while (0);
#endif


/* \brief Retrieve a string corresponding to the given result code.

        This function uses the CmtResultText list to return a string with the relevant result 
        code in a textual format. If the supplied result code is invalid the
        "!!Invalid result code!!" string is returned.
*/
#if !defined(_CMT_DLL_IMPORT) && !defined(_XME_DLL_IMPORT)
const char* xsensResultText(const XsensResultValue result);
#endif


#define XSENS_LABEL_SIZE                        256             
#define XSENS_SHORT_STRING_SIZE         256             
#define XSENS_LONG_STRING_SIZE          16384   


#endif  // XSENS_STD_H