nivisa.h

Go to the documentation of this file.

#ifndef NIVISA_H
#define NIVISA_H

#include "isisvme.h"
#include "visa.h"

class NIVisa : public ISISVME
{
    protected:  // variables
                bool m_init_done;
                bool m_block_transfers;
                static bool m_endian_workaround;  // workaround for MXI2 little endian bug
                ViSession m_default_rm;
                ViSession m_instr_le;   // little endian session
                ViSession m_instr_be;   // big endian session
                ViSession m_instr_le_bt;        // little endian block transfer session
                ViSession m_instr_be_bt;        // big endian block transfer session
                ViSession m_instr_backplane;
                std::string m_device;
                std::string m_device_bp;
                static const int m_tries;      
                static const int m_retry_time;   
                typedef std::map<ViJobId, ViStatus> jobid_map_t;
                jobid_map_t m_jobid_map;
                CRITICAL_SECTION m_job_critical;
                CRITICAL_SECTION m_visa_critical;
                trigger_func_t* m_trigger_func;
                void* m_trigger_func_arg;

    protected:  // functions
                int printError(ViSession session, const char * func, ViStatus status, std::ostream& os);
                int printError(ViSession session, const char * func, ViStatus status, 
                        unsigned long address, long nitems, std::ostream& os);
                int addError(ViSession session, const char * func, ViStatus status, const std::string& message, DAEstatus& dstatus);
                int addError(ViSession session, const char * func, ViStatus status, 
                        unsigned long address, long nitems, const std::string& message, DAEstatus& dstatus);
                bool resetBusDevice(const char* name, DAEstatus& dstatus);
                int setEndian(ViSession session, bool little_endian, DAEstatus& dstatus);
                int enableBlockTransfers(ViSession session, DAEstatus& dstatus);
                int disableBlockTransfers(ViSession session, DAEstatus& dstatus);
                int restoreTransferMode(ViSession session, int mode, DAEstatus& dstatus);
                int reinit(DAEstatus& dstatus);

                template <typename F, typename T> 
                        int retrySingle(F pFunc, unsigned long address, T data, TransferProps props, DAEstatus& dstatus);
                template <typename F, typename T>
                        int retryBlock(F pFunc, unsigned long address, T data, long nitems, TransferProps props, DAEstatus& dstatus);

                int readU16impl(unsigned long address, isisU16_t* data16, TransferProps props, DAEstatus& dstatus);
                int readU32impl(unsigned long address, isisU32_t* data32, TransferProps props, DAEstatus& dstatus);
                int readBlockU16impl(unsigned long address, isisU16_t* data16, long nitems, TransferProps props, DAEstatus& dstatus);
                int readBlockU32impl(unsigned long address, isisU32_t* data32, long nitems, TransferProps props, DAEstatus& dstatus);
                int readBlockU64impl(unsigned long address, uint64_t* data64, long nitems, TransferProps props, DAEstatus& dstatus);
                int writeU16impl(unsigned long address, isisU16_t data16, TransferProps props, DAEstatus& dstatus);
                int writeU32impl(unsigned long address, isisU32_t data32, TransferProps props, DAEstatus& dstatus);
                int writeBlockU16impl(unsigned long address, isisU16_t* data16, long nitems, TransferProps props, DAEstatus& dstatus);
                int writeBlockU32impl(unsigned long address, isisU32_t* data32, long nitems, TransferProps props, DAEstatus& dstatus);
                int writeBlockU64impl(unsigned long address, uint64_t* data64, long nitems, TransferProps props, DAEstatus& dstatus);

                static ViStatus _VI_FUNCH IOEventHandler(ViSession vi, ViEventType eventType, ViEvent context, ViAddr userHandle);
                static ViStatus _VI_FUNCH TriggerHandler(ViSession vi, ViEventType eventType, ViEvent context, ViAddr userHandle);
                static char* m_visa_lock_name;
                ViSession getSession(TransferProps props);
                int onTrigger(time_t the_secs, unsigned short the_ms, ViInt16 trig_id);

        public: // functions
                NIVisa(DAEstatus& dstatus);
                virtual ~NIVisa();
                int open(const char* device, DAEstatus& dstatus);
                int openBackplane(const char* device_bp, DAEstatus& dstatus);
                int lockDevice(int timeout, DAEstatus& dstatus);
                int unlockDevice(DAEstatus& dstatus);
                void lockInterface(int timeout, DAEstatus& dstatus);
                void unlockInterface(DAEstatus& dstatus);
                int readU16noRetry(unsigned long address, isisU16_t* data16, TransferProps props, DAEstatus& dstatus);
                int readU32noRetry(unsigned long address, isisU32_t* data32, TransferProps props, DAEstatus& dstatus);
                int readU16(unsigned long address, isisU16_t* data16, TransferProps props, DAEstatus& dstatus);
                int readU32(unsigned long address, isisU32_t* data32, TransferProps props, DAEstatus& dstatus);
                int readBlockU16(unsigned long address, isisU16_t* data16, long nitems, TransferProps props, DAEstatus& dstatus);
                int readBlockU32(unsigned long address, isisU32_t* data32, long nitems, TransferProps props, DAEstatus& dstatus);
                int readBlockU64(unsigned long address, uint64_t* data64, long nitems, TransferProps props, DAEstatus& dstatus);
                int writeU16(unsigned long address, isisU16_t data16, TransferProps props, DAEstatus& dstatus);
                int writeU32(unsigned long address, isisU32_t data32, TransferProps props, DAEstatus& dstatus);
                int writeBlockU16(unsigned long address, isisU16_t* data16, long nitems, TransferProps props, DAEstatus& dstatus);
                int writeBlockU32(unsigned long address, isisU32_t* data32, long nitems, TransferProps props, DAEstatus& dstatus);
                int writeBlockU64(unsigned long address, uint64_t* data64, long nitems, TransferProps props, DAEstatus& dstatus);
                int writeBlock(unsigned long address, isisU32_t* data, long nitems, TransferProps props, DAEstatus& status);
                int writeBlock(unsigned long address, uint64_t* data, long nitems, TransferProps props, DAEstatus& status);
                int readBlock(unsigned long address, isisU32_t* data, long nitems, TransferProps props, DAEstatus& status);
                int readBlock(unsigned long address, uint64_t* data, long nitems, TransferProps props, DAEstatus& status);
                int close(DAEstatus& status);
                int scanBus(DAEstatus& status);
                bool resetBus(DAEstatus& status);
                bool initOK();
                const char* device() { return m_device.c_str(); }
                const char* deviceBackplane() { return m_device_bp.c_str(); }
                int addJobid(ViJobId jobId, ViStatus vi_status);
                void setTriggerFunc(trigger_func_t* func, void* arg) { m_trigger_func = func; m_trigger_func_arg = arg; } 
                static void setEndianWorkaround(bool endian_workaround) { m_endian_workaround = endian_workaround; }
};

#endif /* NIVISA_H */