CArcDevice.h

Go to the documentation of this file.

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcDevice.h                                                                                             |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the standard ARC device class. This is the class all user applications should use.   |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: ?                                                                           |
// |                                                                                                                  |
// |  Copyright Astronomical Research Cameras, Inc. All rights reserved.                                              |
// +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
#include <string_view>
#include <filesystem>
 
#include <CArcDeviceDllMain.h>
#include <CArcSystem.h>
#include <CExpIFace.h>
#include <CConIFace.h>
#include <TempCtrl.h>
#include <CArcLog.h>
 
#if defined( linux ) || defined( __linux )
    #include <sys/types.h>
#endif
 
using namespace std::string_literals;
 
 
namespace arc
{
    namespace gen3
    {
        namespace device
        {
 
            struct ImgBuf_t
            {
                std::uint16_t*  pUserAddr;          
                std::uint64_t   ulPhysicalAddr;     
                std::uint64_t   ulSize;             
            };
 
 
        }   // end device namespace
 
 
        class GEN3_CARCDEVICE_API CArcDevice
        {
            public:
 
                CArcDevice( void );
 
                virtual ~CArcDevice( void ) = default;
 
                virtual constexpr std::string_view toString( void ) = 0;
 
                //  Device access
                // +---------------------------------------------------------------+
 
                virtual bool isOpen( void ) noexcept;
 
                virtual void open( const std::uint32_t uiDeviceNumber = 0 ) = 0;
 
                virtual void open( const std::uint32_t uiDeviceNumber, const std::uint32_t uiBytes ) = 0;
 
                virtual void open( const std::uint32_t uiDeviceNumber, const std::uint32_t uiRows, const std::uint32_t uiCols ) = 0;
 
                virtual void close( void ) = 0;
 
                virtual void reset( void ) = 0;
 
                virtual void mapCommonBuffer( const std::size_t uiBytes = 0 ) = 0;
 
                virtual void unMapCommonBuffer( void ) = 0;
 
                virtual void reMapCommonBuffer( const std::uint32_t uiBytes = 0 );
 
                virtual void fillCommonBuffer( const std::uint16_t uwValue = 0 );
 
                virtual std::uint8_t* commonBufferVA( void );
 
                virtual std::uint64_t commonBufferPA( void );
 
                virtual std::uint64_t commonBufferSize( void );
 
                virtual std::uint32_t getId( void ) = 0;
 
                virtual std::uint32_t getStatus( void ) = 0;
 
                virtual void clearStatus( void ) = 0;
 
                virtual void set2xFOTransmitter( bool bOnOff ) = 0;
 
                virtual void loadDeviceFile( const std::filesystem::path& tFile ) = 0;
 
                //  Setup & General commands
                // +---------------------------------------------------------------+
 
                virtual std::uint32_t command( const std::initializer_list<const std::uint32_t>& tCmdList ) = 0;
 
                virtual void command( const std::initializer_list<const std::uint32_t>& tCmdList, std::uint32_t uiExpectedReply );
 
                virtual std::uint32_t getControllerId( void ) = 0;
 
                virtual void resetController( void ) = 0;
 
                virtual bool isControllerConnected( void ) = 0;
 
                virtual void setupController( bool bReset, bool bTdl, bool bPower, const std::uint32_t uiRows, const std::uint32_t uiCols, const std::filesystem::path& tTimFile,
                                              const std::filesystem::path& tUtilFile = std::filesystem::path(), const std::filesystem::path& tPciFile = std::filesystem::path(), 
                                              bool* pAbort = nullptr );
 
                virtual void loadControllerFile( const std::filesystem::path& tFilename, bool bValidate = true, bool* pAbort = nullptr );
 
                virtual void setImageSize( const std::uint32_t uiRows, const std::uint32_t uiCols );
 
                virtual std::uint32_t getImageRows( void );
 
                virtual std::uint32_t getImageCols( void );
 
                virtual std::uint32_t getCCParams( void );
 
                virtual bool isCCParamSupported( const std::uint32_t uiParameter );
 
                virtual bool isCCD( void );
 
                virtual bool isBinningSet( void );
 
                virtual void setBinning( const std::uint32_t uiRows, const std::uint32_t uiCols, const std::uint32_t uiRowFactor, const std::uint32_t uiColFactor, std::uint32_t* pBinRows = nullptr, std::uint32_t* pBinCols = nullptr );
 
                virtual void unSetBinning( const std::uint32_t uiRows, const std::uint32_t uiCols );
 
                virtual void setSubArray( std::uint32_t& uiOldRows, std::uint32_t& uiOldCols, const std::uint32_t uiRow, const std::uint32_t uiCol, const std::uint32_t uiSubRows, const std::uint32_t uiSubCols, const std::uint32_t uiBiasOffset, const std::uint32_t uiBiasWidth );
 
                virtual void unSetSubArray( const std::uint32_t uiRows, const std::uint32_t uiCols );
 
                virtual bool isSyntheticImageMode( void );
 
                virtual void setSyntheticImageMode( bool bMode );
 
 
                //  expose commands
                // +-------------------------------------------------+
 
                virtual void setOpenShutter( bool bShouldOpen );
 
                virtual void expose( const float fExpTime, const std::uint32_t uiRows, const std::uint32_t uiCols, const bool* pAbort = nullptr, arc::gen3::CExpIFace* pExpIFace = nullptr, bool bOpenShutter = true );
 
                virtual void stopExposure( void ) = 0;
 
                virtual void continuous( const std::uint32_t uiRows, const std::uint32_t uiCols, const std::uint32_t uiNumOfFrames, const float fExpTime, const bool* pAbort = nullptr, arc::gen3::CConIFace* pConIFace = nullptr, bool bOpenShutter = true );
 
                virtual void stopContinuous( void );
 
                virtual bool isReadout( void ) = 0;
 
                virtual std::uint32_t getPixelCount( void ) = 0;
    
                virtual std::uint32_t getCRPixelCount( void ) = 0;
 
                virtual std::uint32_t getFrameCount( void ) = 0;
 
 
                //  Error & Degug message access
                // +--------------------------------------------------------------------------------------+
 
                virtual bool containsError( const std::uint32_t uiWord ) noexcept;
 
                virtual bool containsError( const std::uint32_t uiWord, const std::uint32_t uiWordMin, const std::uint32_t uiWordMax ) noexcept;
 
                virtual const std::string getNextLoggedCmd( void );
 
                virtual std::uint32_t getLoggedCmdCount( void );
 
                virtual void setLogCmds( bool bOnOff ) noexcept;
 
 
                //  Temperature control
                // +----------------------------------------------------------------------------------------+
 
                virtual double getArrayTemperature( void );
 
                virtual double getArrayTemperatureDN( void );
 
                virtual void setArrayTemperature( double gTempVal );
 
                virtual void loadTemperatureCtrlData( const std::filesystem::path& tFilename );
 
                virtual void saveTemperatureCtrlData( const std::filesystem::path& tFilename );
 
 
                static constexpr auto CTLR_CMD_MAX = static_cast< std::uint32_t >( 6 );
 
 
                static constexpr auto READ_TIMEOUT = static_cast< std::uint32_t >( 200 );
 
 
                static constexpr auto NOPARAM = static_cast< std::uint32_t >( 0xFF000000 );
 
            protected:
 
                virtual bool getCommonBufferProperties( void ) = 0;
 
                virtual void setDefaultTemperatureValues( void ) noexcept;
 
                virtual double ADUToVoltage( const std::uint32_t uiAdu, bool bArc12 = false, bool bHighGain = false ) noexcept;
 
                virtual double voltageToADU( const double gVoltage, bool bArc12 = false, bool bHighGain = false ) noexcept;
 
                virtual double calculateAverageTemperature( void );
 
                virtual double calculateVoltage( const double gTemperature );
 
                virtual double calculateTemperature( const double gVoltage );
 
                virtual std::uint32_t getContinuousImageSize( const std::uint32_t uiImageSize ) = 0;
 
                virtual std::uint32_t smallCamDLoad( const std::uint32_t uiBoardId, const std::vector<std::uint32_t>* pvData ) = 0;
 
                virtual void loadSmallCamControllerFile( const std::filesystem::path& tFilename, [[maybe_unused]] bool bValidate, bool* pAbort = nullptr );
 
                virtual void loadGen23ControllerFile( const std::filesystem::path& tFilename, bool bValidate, bool* pAbort = nullptr ) = 0;
 
                virtual void setByteSwapping( void ) = 0;
 
                virtual const std::string formatDLoadString( const std::uint32_t uiReply, const std::uint32_t uiBoardId, const std::vector<std::uint32_t>* pvData );
 
                //  Temperature control variables
                // +-------------------------------------------------------------+
                double                                  m_gTmpCtrl_DT670Coeff1;             
                double                                  m_gTmpCtrl_DT670Coeff2;             
                double                                  m_gTmpCtrl_SDAduOffset;             
                double                                  m_gTmpCtrl_SDAduPerVolt;            
                double                                  m_gTmpCtrl_HGAduOffset;             
                double                                  m_gTmpCtrl_HGAduPerVolt;            
                double                                  m_gTmpCtrl_SDVoltTolerance;         
                double                                  m_gTmpCtrl_SDDegTolerance;          
                std::uint32_t                           m_gTmpCtrl_SDNumberOfReads;         
                std::uint32_t                           m_gTmpCtrl_SDVoltToleranceTrials;   
                TmpCtrlCoeff_t                          m_tTmpCtrl_SD_2_12K;                
                TmpCtrlCoeff_t                          m_tTmpCtrl_SD_12_24K;               
                TmpCtrlCoeff_t                          m_tTmpCtrl_SD_24_100K;              
                TmpCtrlCoeff_t                          m_tTmpCtrl_SD_100_475K;             
                arc::gen3::arcDevHandle_t               m_hDevice;                          
                std::unique_ptr<arc::gen3::CArcLog>     m_pCLog;                            
                arc::gen3::device::ImgBuf_t             m_tImgBuffer;                       
                std::uint32_t                           m_uiCCParam;                        
                bool                                    m_bStoreCmds;                       
        };
 
    }   // end gen3 namespace
}   // end arc namespace