ECLabInterface.h

Go to the documentation of this file.

/*************************************************************************\ 
* Copyright (c) 2013 Science and Technology Facilities Council (STFC), GB. 
* All rights reverved. 
* This file is distributed subject to a Software License Agreement found 
* in the file LICENSE.txt that is included with this distribution. 
\*************************************************************************/ 

#ifndef ECLabInterface_H
#define ECLabInterface_H


#include <string>
#include <sstream>
#include <BLFunctions.h>

#include "BLFunctionsStub.h"

#define BLCONCAT(A,B) A##B

class ECLabException : public std::runtime_error
{
 public:
    explicit ECLabException(const std::string& what) : std::runtime_error(what) { }
    explicit ECLabException(const std::string& func, int code) : std::runtime_error(std::string(func + " failed: " + translateCode(code))) { }
    static std::string translateCode(int code)
        {
            char mesg[256];
                std::ostringstream oss;
                unsigned int mesg_size = sizeof(mesg);
                if ( BL_GetErrorMsg(code, mesg, &mesg_size) == 0)
                {
                    return mesg;
                }
                else
                {
                    oss << "unknown error code: " << code;
                    return oss.str();
                }
        }
};

#define BL_CALL(__func, ... ) \
    int status; \
    if (BLSIM) \
    { \
        status = BLCONCAT(__func,Stub) ( __VA_ARGS__ ); \
        } \
        else \
        { \
        status = __func ( __VA_ARGS__ ); \
        } \
    if ( status != 0 ) \
        { \
            throw ECLabException(#__func, status); \
        }
        
struct ECLabInterface
{
    static bool BLSIM;
        
    static void GetLibVersion(char*  pVersion, unsigned int* psize)
        {
            BL_CALL(BL_GetLibVersion, pVersion, psize); 
        }
        
        static void Connect(const char* address, uint8 TimeOut, int* pID, TDeviceInfos_t* pInfos)
        {
                BL_CALL(BL_Connect, address, TimeOut, pID, pInfos );
        }
        
        static void testConnect(int ID)
        {
                BL_CALL(BL_TestConnection, ID);
        }
        
        static void Disconnect(int ID)
        {
                BL_CALL(BL_Disconnect, ID);
        }
        
    static void LoadFirmware(int ID, uint8* pChannels, int* pResults, uint8 Length, 
                             bool ShowGauge, bool ForceReload, const char* BinFile, const char* XlxFile)
    {
            BL_CALL(BL_LoadFirmware, ID, pChannels, pResults, Length, ShowGauge, ForceReload, BinFile, XlxFile);
    }
        
        static void LoadTechnique(int ID, uint8 channel, char* pFName, TEccParams_t Params, bool FirstTechnique, bool LastTechnique, bool DisplayParams)
        {
                BL_CALL(BL_LoadTechnique, ID, channel, pFName, Params, FirstTechnique, LastTechnique, DisplayParams);
        }
        
        static void GetChannelInfos (int ID, uint8 ch, TChannelInfos_t *pInfos)
        {
                BL_CALL(BL_GetChannelInfos, ID, ch, pInfos);
        }
        
        static void StopChannel (int ID, uint8 channel)
        {
                BL_CALL(BL_StopChannel, ID, channel);
        }
        
        static void StartChannel (int ID, uint8 channel)
        {
                BL_CALL(BL_StartChannel, ID, channel);
        }

        static bool IsChannelPlugged( int ID, uint8 ch )
        {
            if (BLSIM)
                {
                    return BL_IsChannelPluggedStub(ID, ch);
                }
                else
                {
                    return BL_IsChannelPlugged(ID, ch);
                }
        }

        static void GetCurrentValues (int ID, uint8 channel, TCurrentValues_t *pValues) 
        {
                BL_CALL(BL_GetCurrentValues, ID, channel, pValues);
        }

    static void UpdateParameters( int ID, uint8 channel, int TechIndx, TEccParams_t Params, const char* EccFileName )
    {
                BL_CALL(BL_UpdateParameters, ID, channel, TechIndx, Params, EccFileName);
    }   

        static void GetData( int ID, uint8 channel, TDataBuffer_t* pBuf, TDataInfos_t* pInfos, TCurrentValues_t* pValues ) 
    {
            BL_CALL(BL_GetData, ID, channel, pBuf, pInfos, pValues);
        }

        static void SetExperimentInfos( int ID, uint8 channel, TExperimentInfos_t TExpInfos ) 
        {
            BL_CALL(BL_SetExperimentInfos, ID, channel, TExpInfos);
        }
        
        static void GetExperimentInfos( int ID, uint8 channel, TExperimentInfos_t* TExpInfos )
        {
            BL_CALL(BL_GetExperimentInfos, ID, channel, TExpInfos);
        }
        
};

#undef BLCONCAT

#endif /* ECLabInterface_H */