MvDeviceBase.h 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. #ifndef __MV_DEVICE_BASE_H__
  2. #define __MV_DEVICE_BASE_H__
  3. #include "MvInclude.h"
  4. namespace MvCamCtrl
  5. {
  6. interface IMvDevice
  7. {
  8. // ch:打开设备
  9. // en:Open Device
  10. virtual int Open(unsigned int nAccessMode = MV_ACCESS_Exclusive, unsigned short nSwitchoverKey = 0) = 0;
  11. // ch:关闭设备
  12. // en:Close Device
  13. virtual int Close() = 0;
  14. // ch:判断设备的状态,仅当返回false时,可打开设备
  15. // en:Determines the status of the device, which can be opened only if false is returned
  16. virtual bool IsOpen() = 0;
  17. // ch:开启抓图
  18. // en:Start Grabbing
  19. virtual int StartGrabbing() = 0;
  20. // ch:停止抓图
  21. // en:Stop Grabbing
  22. virtual int StopGrabbing() = 0;
  23. // ch:获取设备信息
  24. // en:Get Device Information
  25. virtual int GetDeviceInfo(MV_CC_DEVICE_INFO&) = 0;
  26. /** @fn GetGenICamXML(unsigned char* pData, unsigned int nDataSize, unsigned int* pnDataLen)
  27. * @brief 获取设备的XML文件
  28. * @param pData [IN][OUT] - 待拷入的缓存地址
  29. nDataSize [IN] - 缓存大小
  30. pnDataLen [OUT] - xml 文件数据长度
  31. *
  32. * @return 成功,返回MV_OK;失败,返回错误码
  33. * @note 当pData为NULL或nDataSize比实际的xml文件小时,不拷贝数据,由pnDataLen返回xml文件大小;
  34. * 当pData为有效缓存地址,且缓存足够大时,拷贝完整数据,并由pnDataLen返回xml文件大小。
  35. * @fn GetGenICamXML(unsigned char* pData, unsigned int nDataSize, unsigned int* pnDataLen)
  36. * @brief Get the device XML file
  37. * @param pData [IN][OUT] - Cache Address to copy in
  38. nDataSize [IN] - Cache Size
  39. pnDataLen [OUT] - xml File Data Length
  40. *
  41. * @return Success, return MV_OK; Fail, return error code
  42. * @note When pData is NULL or nDataSize smaller than the actual xml file, do not copy the data, return xml file size from pnDataLen;
  43. * When pData is a valid cache address, and the cache is large enough, the full data is copied and the xml file size is returned by pnDataLen.
  44. */
  45. virtual int GetGenICamXML(unsigned char* pData, unsigned int nDataSize, unsigned int* pnDataLen) = 0;
  46. /** @fn GetOneFrame(unsigned char * pData , unsigned int nDataSize, MV_FRAME_OUT_INFO* pFrameInfo)
  47. * @brief 获取一帧图像数据
  48. * @param pData [IN][OUT] - 数据指针
  49. nDataLen [IN] - 数据长度
  50. pFrameInfo [OUT] - 输出的帧信息
  51. *
  52. * @return 成功,返回MV_OK;失败,返回错误码
  53. * @fn GetOneFrame(unsigned char * pData , unsigned int nDataSize, MV_FRAME_OUT_INFO* pFrameInfo)
  54. * @brief Get one frame image data
  55. * @param pData [IN][OUT] - Data Pointer
  56. nDataLen [IN] - Data Length
  57. pFrameInfo [OUT] - Output Frame Information
  58. *
  59. * @return Success, return MV_OK; Fail, return error code
  60. */
  61. virtual int GetOneFrame(unsigned char * pData , unsigned int nDataSize, MV_FRAME_OUT_INFO* pFrameInfo) = 0;
  62. // ch:获取GenICam使用的传输层代理类
  63. // en:Gets the transport layer agent class used by GenICam
  64. virtual TlProxy GetTlProxy() = 0;
  65. virtual ~IMvDevice( void ){};
  66. };
  67. interface IDeviceFactory
  68. {
  69. // ch:枚举子网内,指定的传输协议对应的所有设备
  70. // en:Enumerate all devices within the subnet that correspond to the specified transport protocol
  71. virtual int EnumDevices( unsigned int nTLayerType , MV_CC_DEVICE_INFO_LIST& stDevList ) = 0;
  72. // ch:创建设备代理类
  73. // en:Create a device agent class
  74. virtual IMvDevice* CreateDevice( const MV_CC_DEVICE_INFO& device ) = 0;
  75. // ch:销毁指定设备的内部资源
  76. // en:Destroy the internal resources of the specified device
  77. virtual int DestroyDevice( IMvDevice* ) = 0;
  78. // ch:判断指定的设备是否可以访问
  79. // en:Determines whether the specified device is accessible
  80. virtual bool IsDeviceAccessible( const MV_CC_DEVICE_INFO& deviceInfo) = 0;
  81. };
  82. }
  83. #endif /* __MV_DEVICE_BASE_H__ */