ICommInterface.hpp

Go to the documentation of this file.

#pragma once
#include <spdlog/spdlog.h>
 
#include <asio.hpp>
#include <mutex>
#include <string>
 
class MockCommInterface;
 
namespace OpenSRX {

enum class ErrCode {
    CMD_UNDEFINED = 0,                   
    MISMATCHED_CMD_FMT = 1,              
    PARAM1_OUT_OF_RANGE = 2,             
    PARAM2_OUT_OF_RANGE = 3,             
    PARAM2_NOT_IN_HEX = 4,               
    PARAM2_IN_HEX_BUT_OUT_OF_RANGE = 5,  
    TWO_OR_MORE_MARKS_IN_PRESET_DATA = 10,   
    AREA_SPECIFICATION_DATA_INCORRECT = 11,  
    FILE_DOES_NOT_EXIST = 12,                
    TMM_LON_MM_OUT_OF_RANGE = 13,            
    TMM_KEYENCE_COMMUNICATION_CANNOT_BE_CHECKED = 14,  
    COMMAND_NOT_EXECUTABLE_IN_CURRENT_STATUS = 20,  
    BUFFER_OVERFLOW = 21,                           
    PARAMETER_LOAD_OR_SAVE_ERROR = 22,              
    CONNECTED_TO_AUTOID_NETWORK_NAVIGATOR = 23,     
    DEVICE_FAULT = 99,                              
};

enum class CommFormat {
    NO_HEADER_CR_IN_CR_OUT = 0,     
    NO_HEADER_CRLF_IN_CR_OUT = 1,   
    STX_HEADER_ETX_IN_ETX_OUT = 2,  
};

class ICommInterface {
   public:
    template <typename StreamT>
    friend class AsioInterface;
 
    friend class MockCommInterface;
 
    virtual ~ICommInterface() = default;

    virtual std::string sendCommand(const std::string& command) = 0;

    virtual std::string sendCommandUnlocked(const std::string& command) = 0;

    virtual std::string describe() const = 0;

    void setCommFormat(CommFormat format);

    CommFormat getCommFormat() { return commFormat; }
 
   private:
    std::string stripEcho(const std::string& response, const std::string& command);

    std::string addHeaderAndTerminator(const std::string& command);
 
    CommFormat commFormat = CommFormat::NO_HEADER_CR_IN_CR_OUT;  
    std::string inTermStr = "\r";  
 
   protected:
    std::mutex commMutex;
};
}  // namespace OpenSRX