IIxxatInterface.hpp

Go to the documentation of this file.

#ifndef IV_SRC_COMMS_IXXAT_IIXXATINTERFACE_HPP_
#define IV_SRC_COMMS_IXXAT_IIXXATINTERFACE_HPP_
 
#include <ECI/ECI_hwtype.h>
#include <string>
 
namespace iv::comms::ixxat
{
 
class IIxxatInterface
{
public:
    [[nodiscard]] virtual IIxxatInterface *clone() const = 0;
 
    virtual ~IIxxatInterface() = default;
 
    virtual ECI_RESULT ctrlClose(ECI_CTRL_HDL hCtrl) = 0;
    virtual ECI_RESULT ctrlOpen(ECI_CTRL_HDL *phCtrl, DWORD dwHwIndex, DWORD dwCtrlIndex,
                                const ECI_CTRL_CONFIG *pStcCtrlConfig) = 0;
    virtual ECI_RESULT ctrlReceive(ECI_CTRL_HDL hCtrl, DWORD *pdwCount, ECI_CTRL_MESSAGE *pStcMessage,
                                   DWORD dwTimeout) = 0;
    virtual ECI_RESULT ctrlSend(ECI_CTRL_HDL hCtrl, const ECI_CTRL_MESSAGE *pStcMessage, DWORD dwTimeout) = 0;
    virtual ECI_RESULT ctrlStart(ECI_CTRL_HDL hCtrl) = 0;
    virtual ECI_RESULT ctrlStop(ECI_CTRL_HDL hCtrl, DWORD dwMode) = 0;
    virtual ECI_RESULT initialize() = 0;
    virtual ECI_RESULT reinitialize() = 0;
    virtual ECI_RESULT release() = 0;
 
    virtual std::string getErrorString(ECI_RESULT result) = 0;
    [[nodiscard]] virtual std::string getHardwareName() const = 0;
    virtual ECI_RESULT getInfo(uint64_t dwHwIndex, ECI_HW_INFO *pStcHwInfo) = 0;
    virtual ECI_RESULT getStatus(ECI_CTRL_HDL hCtrl, ECI_CTRL_STATUS *pStcStatus) = 0;
};
 
}// namespace iv::comms::ixxat
 
#endif// IV_SRC_COMMS_IXXAT_IIXXATINTERFACE_HPP_