_BaslerUniversalChunkDataParams.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732
  1. //-----------------------------------------------------------------------------
  2. // Basler pylon SDK
  3. // Copyright (c) 2019-2021 Basler AG
  4. // http://www.baslerweb.com
  5. //-----------------------------------------------------------------------------
  6. /*!
  7. \file
  8. \brief A parameter class containing all parameters as members that are available for chunk data of Basler camera devices
  9. The parameter class is used by the \link Pylon::CBaslerUniversalGrabResultPtr \c CBaslerUniversalGrabResultPtr \endlink class.
  10. More information can be found in the code of the \ref sample_Grab_ChunkImage sample.
  11. */
  12. //-----------------------------------------------------------------------------
  13. // This file is generated automatically
  14. // Do not modify!
  15. //-----------------------------------------------------------------------------
  16. #ifndef BASLER_PYLON_UNIVERSALCHUNKDATAPARAMS_H
  17. #define BASLER_PYLON_UNIVERSALCHUNKDATAPARAMS_H
  18. #pragma once
  19. // common parameter types
  20. #include <pylon/ParameterIncludes.h>
  21. #include <pylon/EnumParameterT.h>
  22. namespace Basler_UniversalChunkDataParams
  23. {
  24. //**************************************************************************************************
  25. // Enumerations
  26. //**************************************************************************************************
  27. //! Valid values for BslChunkAutoBrightnessStatus
  28. enum BslChunkAutoBrightnessStatusEnums
  29. {
  30. BslChunkAutoBrightnessStatus_Disabled, //!< Target brightness adjustments are disabled, i e , Gain Auto and Exposure Auto are set to Off - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  31. BslChunkAutoBrightnessStatus_TargetNotReached, //!< Target brightness adjustments are enabled, but the target brightness value has not been reached - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  32. BslChunkAutoBrightnessStatus_TargetReached //!< Target brightness adjustments are enabled, and the target brightness value has been reached - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  33. };
  34. //! Valid values for BslChunkTimestampSelector
  35. enum BslChunkTimestampSelectorEnums
  36. {
  37. BslChunkTimestampSelector_ExposureEnd, //!< The Chunk Timestamp Value parameter indicates when exposure of the current image ended - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  38. BslChunkTimestampSelector_ExposureStart, //!< The Chunk Timestamp Value parameter indicates when exposure of the current image started - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  39. BslChunkTimestampSelector_FrameStart //!< The Chunk Timestamp Value parameter indicates when acquisition of the current image started - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  40. };
  41. //! Valid values for ChunkCounterSelector
  42. enum ChunkCounterSelectorEnums
  43. {
  44. ChunkCounterSelector_Counter1, //!< Chunk data can be retrieved from counter 1 - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  45. ChunkCounterSelector_Counter2 //!< Chunk data can be retrieved from counter 2 - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  46. };
  47. //! Valid values for ChunkGainSelector
  48. enum ChunkGainSelectorEnums
  49. {
  50. ChunkGainSelector_All //!< Chunk data can be retrieved from all gain channels - Applies to: ace USB
  51. };
  52. //! Valid values for ChunkPixelFormat
  53. enum ChunkPixelFormatEnums
  54. {
  55. ChunkPixelFormat_BGR10Packed, //!< The pixel data in the acquired image is in the BGR 10 Packed format - Applies to: GigE
  56. ChunkPixelFormat_BGR12Packed, //!< The pixel data in the acquired image is in the BGR 12 Packed format - Applies to: GigE
  57. ChunkPixelFormat_BGR8Packed, //!< The pixel data in the acquired image is in the BGR 8 Packed format - Applies to: GigE
  58. ChunkPixelFormat_BGRA8Packed, //!< The pixel data in the acquired image is in the BGRA 8 Packed format - Applies to: GigE
  59. ChunkPixelFormat_BayerBG10, //!< The pixel data in the acquired image is in the Bayer BG 10 format - Applies to: GigE
  60. ChunkPixelFormat_BayerBG10p, //!< The pixel data in the acquired image is in the Bayer BG 10p format - Applies to: GigE
  61. ChunkPixelFormat_BayerBG12, //!< The pixel data in the acquired image is in the Bayer BG 12 format - Applies to: GigE
  62. ChunkPixelFormat_BayerBG12Packed, //!< The pixel data in the acquired image is in the Bayer BG 12 Packed format - Applies to: GigE
  63. ChunkPixelFormat_BayerBG16, //!< The pixel data in the acquired image is in the Bayer BG 16 format - Applies to: GigE
  64. ChunkPixelFormat_BayerBG8, //!< The pixel data in the acquired image is in the Bayer BG 8 format - Applies to: GigE
  65. ChunkPixelFormat_BayerGB10, //!< The pixel data in the acquired image is in the Bayer GB 10 format - Applies to: GigE
  66. ChunkPixelFormat_BayerGB10p, //!< The pixel data in the acquired image is in the Bayer GB 10p format - Applies to: GigE
  67. ChunkPixelFormat_BayerGB12, //!< The pixel data in the acquired image is in the Bayer GB 12 format - Applies to: GigE
  68. ChunkPixelFormat_BayerGB12Packed, //!< The pixel data in the acquired image is in the Bayer GB 12 Packed format - Applies to: GigE
  69. ChunkPixelFormat_BayerGB16, //!< The pixel data in the acquired image is in the Bayer GB 16 format - Applies to: GigE
  70. ChunkPixelFormat_BayerGB8, //!< The pixel data in the acquired image is in the Bayer GB 8 format - Applies to: GigE
  71. ChunkPixelFormat_BayerGR10, //!< The pixel data in the acquired image is in the Bayer GR 10 format - Applies to: GigE
  72. ChunkPixelFormat_BayerGR10p, //!< The pixel data in the acquired image is in the Bayer GR 10p format - Applies to: GigE
  73. ChunkPixelFormat_BayerGR12, //!< The pixel data in the acquired image is in the Bayer GR 12 format - Applies to: GigE
  74. ChunkPixelFormat_BayerGR12Packed, //!< The pixel data in the acquired image is in the Bayer GR 12 Packed format - Applies to: GigE
  75. ChunkPixelFormat_BayerGR16, //!< The pixel data in the acquired image is in the Bayer GR 16 format - Applies to: GigE
  76. ChunkPixelFormat_BayerGR8, //!< The pixel data in the acquired image is in the Bayer GR 8 format - Applies to: GigE
  77. ChunkPixelFormat_BayerRG10, //!< The pixel data in the acquired image is in the Bayer RG 10 format - Applies to: GigE
  78. ChunkPixelFormat_BayerRG10p, //!< The pixel data in the acquired image is in the Bayer RG 10p format - Applies to: GigE
  79. ChunkPixelFormat_BayerRG12, //!< The pixel data in the acquired image is in the Bayer RG 12 format - Applies to: GigE
  80. ChunkPixelFormat_BayerRG12Packed, //!< The pixel data in the acquired image is in the Bayer RG 12 Packed format - Applies to: GigE
  81. ChunkPixelFormat_BayerRG16, //!< The pixel data in the acquired image is in the Bayer RG 16 format - Applies to: GigE
  82. ChunkPixelFormat_BayerRG8, //!< The pixel data in the acquired image is in the Bayer RG 8 format - Applies to: GigE
  83. ChunkPixelFormat_Mono10, //!< The pixel data in the acquired image is in the Mono 10 format - Applies to: GigE
  84. ChunkPixelFormat_Mono10Packed, //!< The pixel data in the acquired image is in the Mono 10 Packed format - Applies to: GigE
  85. ChunkPixelFormat_Mono10p, //!< The pixel data in the acquired image is in the Mono 10p format - Applies to: GigE
  86. ChunkPixelFormat_Mono12, //!< The pixel data in the acquired image is in the Mono 12 format - Applies to: GigE
  87. ChunkPixelFormat_Mono12Packed, //!< The pixel data in the acquired image is in the Mono 12 Packed format - Applies to: GigE
  88. ChunkPixelFormat_Mono16, //!< The pixel data in the acquired image is in the Mono 16 format - Applies to: GigE
  89. ChunkPixelFormat_Mono8, //!< The pixel data in the acquired image is in the Mono 8 format - Applies to: GigE
  90. ChunkPixelFormat_Mono8Signed, //!< The pixel data in the acquired image is in the Mono 8 Signed format - Applies to: GigE
  91. ChunkPixelFormat_RGB10Packed, //!< The pixel data in the acquired image is in the RGB 10 Packed format - Applies to: GigE
  92. ChunkPixelFormat_RGB10Planar, //!< The pixel data in the acquired image is in the RGB 10 Planar format - Applies to: GigE
  93. ChunkPixelFormat_RGB10V1Packed, //!< The pixel data in the acquired image is in the RGB 10V1 Packed format - Applies to: GigE
  94. ChunkPixelFormat_RGB10V2Packed, //!< The pixel data in the acquired image is in the RGB 10V2 Packed format - Applies to: GigE
  95. ChunkPixelFormat_RGB12Packed, //!< The pixel data in the acquired image is in the RGB 12 Packed format - Applies to: GigE
  96. ChunkPixelFormat_RGB12Planar, //!< The pixel data in the acquired image is in the RGB 12 Planar format - Applies to: GigE
  97. ChunkPixelFormat_RGB12V1Packed, //!< The pixel data in the acquired image is in RGB 12 V1 Packed format - Applies to: GigE
  98. ChunkPixelFormat_RGB16Planar, //!< The pixel data in the acquired image is in the RGB 16 Planar format - Applies to: GigE
  99. ChunkPixelFormat_RGB8Packed, //!< The pixel data in the acquired image is in the RGB 8 Packed format - Applies to: GigE
  100. ChunkPixelFormat_RGB8Planar, //!< The pixel data in the acquired image is in the RGB 8 Planar format - Applies to: GigE
  101. ChunkPixelFormat_RGBA8Packed, //!< The pixel data in the acquired image is in the RGBA 8 Packed format - Applies to: GigE
  102. ChunkPixelFormat_YUV411Packed, //!< The pixel data in the acquired image is in the YUV 411 Packed format - Applies to: GigE
  103. ChunkPixelFormat_YUV422Packed, //!< The pixel data in the acquired image is in the YUV 422 Packed format - Applies to: GigE
  104. ChunkPixelFormat_YUV422_YUYV_Packed, //!< The pixel data in the acquired image is in the YUV 422 (YUYV) Packed format - Applies to: GigE
  105. ChunkPixelFormat_YUV444Packed //!< The pixel data in the acquired image is in the YUV 444 Packed format - Applies to: GigE
  106. };
  107. //**************************************************************************************************
  108. // Parameter class CUniversalChunkDataParams_Params_v6_3_0
  109. //**************************************************************************************************
  110. /*!
  111. \brief A parameter class containing all parameters as members that are available for chunk data of Basler camera devices
  112. The parameter class is used by the \link Pylon::CBaslerUniversalGrabResultPtr \c CBaslerUniversalGrabResultPtr \endlink class.
  113. More information can be found in the code of the \ref sample_Grab_ChunkImage sample.
  114. */
  115. class PYLONBASE_API CUniversalChunkDataParams_Params_v6_3_0
  116. {
  117. //----------------------------------------------------------------------------------------------------------------
  118. // Implementation
  119. //----------------------------------------------------------------------------------------------------------------
  120. protected:
  121. // If you want to show the following methods in the help file
  122. // add the string HIDE_CLASS_METHODS to the ENABLED_SECTIONS tag in the doxygen file
  123. //! \cond HIDE_CLASS_METHODS
  124. //! Constructor
  125. CUniversalChunkDataParams_Params_v6_3_0( void );
  126. //! Destructor
  127. ~CUniversalChunkDataParams_Params_v6_3_0( void );
  128. //! Initializes the references
  129. void _Initialize( GENAPI_NAMESPACE::INodeMap* );
  130. //! \endcond
  131. private:
  132. class CUniversalChunkDataParams_Params_v6_3_0_Data;
  133. CUniversalChunkDataParams_Params_v6_3_0_Data* m_pCUniversalChunkDataParams_Params_v6_3_0_Data;
  134. //----------------------------------------------------------------------------------------------------------------
  135. // References to features
  136. //----------------------------------------------------------------------------------------------------------------
  137. public:
  138. //! \name Categories: Root
  139. //@{
  140. /*!
  141. \brief Indicates the status of the target brightness adjustments performed by the Exposure Auto and Gain Auto auto functions - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  142. Visibility: Expert
  143. */
  144. Pylon::IEnumParameterT<BslChunkAutoBrightnessStatusEnums>& BslChunkAutoBrightnessStatus;
  145. //@}
  146. //! \name Categories: Root
  147. //@{
  148. /*!
  149. \brief Sets which information should be included in the Chunk Timestamp Value chunk - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  150. Visibility: Expert
  151. Selecting Parameters: BslChunkTimestampValue
  152. */
  153. Pylon::IEnumParameterT<BslChunkTimestampSelectorEnums>& BslChunkTimestampSelector;
  154. //@}
  155. //! \name Categories: Root
  156. //@{
  157. /*!
  158. \brief Value of the timestamp when the image was acquired - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  159. Visibility: Expert
  160. Selected by: BslChunkTimestampSelector
  161. */
  162. Pylon::IIntegerEx& BslChunkTimestampValue;
  163. //@}
  164. //! \name Categories: Root
  165. //@{
  166. /*!
  167. \brief Sets which counter to retrieve chunk data from - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  168. Visibility: Expert
  169. Selecting Parameters: ChunkCounterValue
  170. */
  171. Pylon::IEnumParameterT<ChunkCounterSelectorEnums>& ChunkCounterSelector;
  172. //@}
  173. //! \name Categories: Root
  174. //@{
  175. /*!
  176. \brief Value of the selected chunk counter - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  177. Visibility: Beginner
  178. Selected by: ChunkCounterSelector
  179. */
  180. Pylon::IIntegerEx& ChunkCounterValue;
  181. //@}
  182. //! \name Categories: Root
  183. //@{
  184. /*!
  185. \brief Maximum possible pixel value in the acquired image - Applies to: GigE
  186. Visibility: Beginner
  187. */
  188. Pylon::IIntegerEx& ChunkDynamicRangeMax;
  189. //@}
  190. //! \name Categories: Root
  191. //@{
  192. /*!
  193. \brief Minimum possible pixel value in the acquired image - Applies to: GigE
  194. Visibility: Beginner
  195. */
  196. Pylon::IIntegerEx& ChunkDynamicRangeMin;
  197. //@}
  198. //! \name Categories: Root
  199. //@{
  200. /*!
  201. \brief Exposure time used to acquire the image - Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  202. Visibility: Beginner
  203. */
  204. Pylon::IFloatEx& ChunkExposureTime;
  205. //@}
  206. //! \name Categories: Root
  207. //@{
  208. /*!
  209. \brief Unique identifier of the current frame - Applies to: ace 2 GigE, ace 2 USB and dart 2 USB
  210. Unique identifier of the current frame. The frame ID starts at 0 and keeps incrementing by 1 for each exposed image until the camera is powered off. The maximum value is 2^48.
  211. Visibility: Expert
  212. */
  213. Pylon::IIntegerEx& ChunkFrameID;
  214. //@}
  215. //! \name Categories: Root
  216. //@{
  217. /*!
  218. \brief Value of the Frame Trigger counter when the image was acquired - Applies to: GigE
  219. Visibility: Beginner
  220. */
  221. Pylon::IIntegerEx& ChunkFrameTriggerCounter;
  222. //@}
  223. //! \name Categories: Root
  224. //@{
  225. /*!
  226. \brief Value of the Frame Trigger Ignored counter when the image was acquired - Applies to: GigE
  227. Visibility: Beginner
  228. */
  229. Pylon::IIntegerEx& ChunkFrameTriggerIgnoredCounter;
  230. //@}
  231. //! \name Categories: Root
  232. //@{
  233. /*!
  234. \brief Value of the Frame counter when the image was acquired - Applies to: GigE
  235. Visibility: Beginner
  236. */
  237. Pylon::IIntegerEx& ChunkFramecounter;
  238. //@}
  239. //! \name Categories: Root
  240. //@{
  241. /*!
  242. \brief Value of the Frames per Trigger counter when the image was acquired - Applies to: GigE
  243. Visibility: Beginner
  244. */
  245. Pylon::IIntegerEx& ChunkFramesPerTriggerCounter;
  246. //@}
  247. //! \name Categories: Root
  248. //@{
  249. /*!
  250. \brief Gain used during image acquisition - Applies to: ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  251. Visibility: Beginner
  252. Selected by: ChunkGainSelector
  253. */
  254. Pylon::IFloatEx& ChunkGain;
  255. //@}
  256. //! \name Categories: Root
  257. //@{
  258. /*!
  259. \brief Gain All value of the acquired image - Applies to: GigE
  260. Visibility: Beginner
  261. */
  262. Pylon::IIntegerEx& ChunkGainAll;
  263. //@}
  264. //! \name Categories: Root
  265. //@{
  266. /*!
  267. \brief Sets which gain channel to retrieve chunk data from - Applies to: ace USB
  268. Visibility: Expert
  269. Selecting Parameters: ChunkGain
  270. */
  271. Pylon::IEnumParameterT<ChunkGainSelectorEnums>& ChunkGainSelector;
  272. //@}
  273. //! \name Categories: Root
  274. //@{
  275. /*!
  276. \brief AOI height of the acquired image - Applies to: GigE
  277. Visibility: Beginner
  278. */
  279. Pylon::IIntegerEx& ChunkHeight;
  280. //@}
  281. //! \name Categories: Root
  282. //@{
  283. /*!
  284. \brief Number of bits per line used for the Input Status At Line Trigger parameter - Applies to: GigE
  285. Visibility: Beginner
  286. */
  287. Pylon::IIntegerEx& ChunkInputStatusAtLineTriggerBitsPerLine;
  288. //@}
  289. //! \name Categories: Root
  290. //@{
  291. /*!
  292. \brief Index number used for the Input Status At Line Trigger parameter - Applies to: GigE
  293. Index number used for the Input Status At Line Trigger parameter. The index number can be used to get the state of the camera's input lines when a specific line was acquired. For example, if you want to know the state of the camera's input lines when line 30 was acquired, set the index to 30, then retrieve the value of Status Index parameter.
  294. Visibility: Beginner
  295. */
  296. Pylon::IIntegerEx& ChunkInputStatusAtLineTriggerIndex;
  297. //@}
  298. //! \name Categories: Root
  299. //@{
  300. /*!
  301. \brief Value indicating the status of the camera's input lines when a specific line was acquired - Applies to: GigE
  302. Value indicating the status of the camera's input lines when a specific line was acquired. The information is stored in a 4-bit value (bit 0 = input line 1 state, bit 1 = input line 2 state etc.). For more information, see the Status Index parameter documentation.
  303. Visibility: Beginner
  304. */
  305. Pylon::IIntegerEx& ChunkInputStatusAtLineTriggerValue;
  306. //@}
  307. //! \name Categories: Root
  308. //@{
  309. /*!
  310. \brief Bit field that indicates the status of all of the camera's input and output lines when the image was acquired - Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  311. Visibility: Beginner
  312. */
  313. Pylon::IIntegerEx& ChunkLineStatusAll;
  314. //@}
  315. //! \name Categories: Root
  316. //@{
  317. /*!
  318. \brief Value of the Line Trigger counter when the image was acquired - Applies to: GigE
  319. Visibility: Beginner
  320. */
  321. Pylon::IIntegerEx& ChunkLineTriggerCounter;
  322. //@}
  323. //! \name Categories: Root
  324. //@{
  325. /*!
  326. \brief Value of the Line Trigger End to End counter when the image was acquired - Applies to: GigE
  327. Visibility: Beginner
  328. */
  329. Pylon::IIntegerEx& ChunkLineTriggerEndToEndCounter;
  330. //@}
  331. //! \name Categories: Root
  332. //@{
  333. /*!
  334. \brief Value of the Line Trigger Ignored counter when the image was acquired - Applies to: GigE
  335. Visibility: Beginner
  336. */
  337. Pylon::IIntegerEx& ChunkLineTriggerIgnoredCounter;
  338. //@}
  339. //! \name Categories: Root
  340. //@{
  341. /*!
  342. \brief X offset of the AOI of the acquired image - Applies to: GigE
  343. Visibility: Beginner
  344. */
  345. Pylon::IIntegerEx& ChunkOffsetX;
  346. //@}
  347. //! \name Categories: Root
  348. //@{
  349. /*!
  350. \brief Y offset of the AOI of the acquired image - Applies to: GigE
  351. Visibility: Beginner
  352. */
  353. Pylon::IIntegerEx& ChunkOffsetY;
  354. //@}
  355. //! \name Categories: Root
  356. //@{
  357. /*!
  358. \brief CRC checksum of the acquired image - Applies to: GigE, ace 2 GigE, ace 2 USB, ace USB and dart 2 USB
  359. CRC checksum of the acquired image. The checksum is calculated using all of the image data and all of the appended chunks except for the checksum itself.
  360. Visibility: Beginner
  361. */
  362. Pylon::IIntegerEx& ChunkPayloadCRC16;
  363. //@}
  364. //! \name Categories: Root
  365. //@{
  366. /*!
  367. \brief Indicates the pixel format of the acquired image - Applies to: GigE
  368. Visibility: Beginner
  369. */
  370. Pylon::IEnumParameterT<ChunkPixelFormatEnums>& ChunkPixelFormat;
  371. //@}
  372. //! \name Categories: Root
  373. //@{
  374. /*!
  375. \brief Sequence set index number related to the acquired image - Applies to: GigE
  376. Visibility: Beginner
  377. */
  378. Pylon::IIntegerEx& ChunkSequenceSetIndex;
  379. //@}
  380. //! \name Categories: Root
  381. //@{
  382. /*!
  383. \brief Index of the active sequencer set - Applies to: ace USB
  384. Visibility: Beginner
  385. */
  386. Pylon::IIntegerEx& ChunkSequencerSetActive;
  387. //@}
  388. //! \name Categories: Root
  389. //@{
  390. /*!
  391. \brief Value of the Shaft Encoder counter when the image was acquired - Applies to: GigE
  392. Visibility: Beginner
  393. */
  394. Pylon::IIntegerEx& ChunkShaftEncoderCounter;
  395. //@}
  396. //! \name Categories: Root
  397. //@{
  398. /*!
  399. \brief Number of bytes of data between the beginning of one line in the acquired image and the beginning of the next line in the acquired image - Applies to: GigE
  400. Visibility: Beginner
  401. */
  402. Pylon::IIntegerEx& ChunkStride;
  403. //@}
  404. //! \name Categories: Root
  405. //@{
  406. /*!
  407. \brief Value of the timestamp when the image was acquired - Applies to: GigE and ace USB
  408. Visibility: Beginner
  409. */
  410. Pylon::IIntegerEx& ChunkTimestamp;
  411. //@}
  412. //! \name Categories: Root
  413. //@{
  414. /*!
  415. \brief Value of the Trigger Input counter when the image was acquired - Applies to: GigE
  416. Visibility: Beginner
  417. */
  418. Pylon::IIntegerEx& ChunkTriggerinputcounter;
  419. //@}
  420. //! \name Categories: Root
  421. //@{
  422. /*!
  423. \brief Status of all of the camera's virtual input and output lines when the image was acquired - Applies to: GigE
  424. Visibility: Beginner
  425. */
  426. Pylon::IIntegerEx& ChunkVirtLineStatusAll;
  427. //@}
  428. //! \name Categories: Root
  429. //@{
  430. /*!
  431. \brief Width of the AOI of the acquired image - Applies to: GigE
  432. Visibility: Beginner
  433. */
  434. Pylon::IIntegerEx& ChunkWidth;
  435. //@}
  436. private:
  437. //! \cond HIDE_CLASS_METHODS
  438. //! not implemented copy constructor
  439. CUniversalChunkDataParams_Params_v6_3_0(CUniversalChunkDataParams_Params_v6_3_0&);
  440. //! not implemented assignment operator
  441. CUniversalChunkDataParams_Params_v6_3_0& operator=(CUniversalChunkDataParams_Params_v6_3_0&);
  442. //! \endcond
  443. };
  444. /*!
  445. \brief A parameter class containing all parameters as members that are available for chunk data of Basler camera devices
  446. The parameter class is used by the \link Pylon::CBaslerUniversalGrabResultPtr \c CBaslerUniversalGrabResultPtr \endlink class.
  447. More information can be found in the code of the \ref sample_Grab_ChunkImage sample.
  448. */
  449. class CUniversalChunkDataParams_Params : public CUniversalChunkDataParams_Params_v6_3_0
  450. {
  451. //----------------------------------------------------------------------------------------------------------------
  452. // Implementation
  453. //----------------------------------------------------------------------------------------------------------------
  454. protected:
  455. // If you want to show the following methods in the help file
  456. // add the string HIDE_CLASS_METHODS to the ENABLED_SECTIONS tag in the doxygen file
  457. //! \cond HIDE_CLASS_METHODS
  458. //! Constructor
  459. CUniversalChunkDataParams_Params( void )
  460. {
  461. }
  462. //! Destructor
  463. ~CUniversalChunkDataParams_Params( void )
  464. {
  465. }
  466. //! Initializes the references
  467. void _Initialize( GENAPI_NAMESPACE::INodeMap* pNodeMap )
  468. {
  469. CUniversalChunkDataParams_Params_v6_3_0::_Initialize( pNodeMap );
  470. }
  471. //! \endcond
  472. };
  473. } // namespace Basler_UniversalChunkDataParams
  474. #endif // BASLER_PYLON_UNIVERSALCHUNKDATAPARAMS_H