hspscanner_impl.h 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. #ifndef LIBFRAMEWORK_HSPS_IMPL_H
  2. #define LIBFRAMEWORK_HSPS_IMPL_H
  3. #include "HSPScannerClass.h"
  4. #include "DeviceSimulator.h"
  5. #define EntityName "HSPScanner"
  6. class HSPSClassImpl : public CHSPSClass
  7. {
  8. public:
  9. HSPSClassImpl();
  10. ~HSPSClassImpl();
  11. //DeviceBaseClass
  12. ErrorCodeEnum GetDevCategory(DevCategoryInfo &devCategory);
  13. ErrorCodeEnum Reset();
  14. ErrorCodeEnum DevClose();
  15. ErrorCodeEnum GetLastErr(DevErrorInfo &devErrInfo);
  16. virtual ErrorCodeEnum DevOpen();
  17. //
  18. // Set param, more detail please to see ParamType and its according ParamTypeValue.
  19. //
  20. virtual ErrorCodeEnum SetParam(ParamType type, ParamTypeValue value);
  21. //
  22. // Command the device to start to preview or stop previewing.
  23. // -nValue[in] set 1 means StartPreview while 0 means StopPreview.
  24. // If the device' state had been setted before what the nValue commanded, ignore it and
  25. // return Error_Succeed.
  26. // The function returns only the specified behavior is done completely, StartPreview in special.
  27. // 更新20161117: nValue值为 1 时打开预览,确保当前打开预览过程执行结束且窗口处于显示状态才返回Error_Succeed,
  28. // nValue值为 0 时关闭预览并隐藏窗口
  29. //
  30. //
  31. virtual ErrorCodeEnum SetPreview(short nValue);
  32. //
  33. // Scan Image from device and store the image.
  34. // -pszFileName[in] Store the path and name using suffix ".jpg"
  35. // specifies that where the image will be located and what it would be named.
  36. // 拍摄照片,传入的文件名已带绝对路径,无需再进行拼接处理
  37. //
  38. virtual ErrorCodeEnum ScanImage(const char* pszFileName);
  39. //
  40. // Scan Image from device and return the image data in byte format.
  41. // -pBtImg[out] The buffer used to store the scanned image data.
  42. // 存储图片字节流的缓冲区,大小为 nBtLen 字节
  43. // -nBtLen[in,out] Indicate the max byte-type size of pBtImg could be stored
  44. // and Store the real byte-type size of pBtImg had used when returned.
  45. // when detect value of nBtLen is 0 or smaller that necessary size, please
  46. // set nBtlen with real byte-type size and return Error_TooSmallBuffer.
  47. // 如果nBtLen指定的字节数过小,那么对nBtLen赋值实际所需的大小并返回 Error_TooSmallBuffer,此操作仅允许一次
  48. // -pszFileName[in] Store the path and name where the image file should be located
  49. // while "" indicates that the image file shouldn't be stored at locate.
  50. // 文件名长度为零表示不在本地生成图片文件
  51. //
  52. //
  53. virtual ErrorCodeEnum ScanImageEx(BYTE* pBtImg, int& nBtLen, const char* pszFileName = "");
  54. //
  55. // Set position and width of preview dialog with the rate of length to width: 16:9.
  56. // -nX[in] The X coordinate of leftTop point.
  57. // -nY[in] The Y coordinate of leftTop point.
  58. // -nWidth[in] The Width of Preview Dialog .
  59. // 传入预览窗口显示的坐标,左上角的横坐标nX,左上角的纵坐标nY,以及预览窗口的宽,宽与高的比例为 16:9
  60. //
  61. virtual ErrorCodeEnum SetViewPos(int nX, int nY, int nWidth);
  62. //
  63. // Show property dialog of HSPS of LiangTian.
  64. // If there is no property dialog function, ignore it and return Error_NotImpl(更新20161117).
  65. // 更新20161117:用于打开良田高拍仪设备的设置属性页,可能用不到
  66. //
  67. virtual ErrorCodeEnum SetProperty();
  68. //
  69. // Get current status of device.
  70. //
  71. virtual ErrorCodeEnum GetDevStatus(HspsDevStatus& status);
  72. private:
  73. int m_mode;
  74. };
  75. #endif //LIBFRAMEWORK_HSPS_IMPL_H