_BaslerUniversalStreamParams.h 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150
  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 pylon stream grabbers
  9. The parameter class is used by the \c Pylon::CBaslerUniversalInstantCamera class.
  10. The \ref sample_ParametrizeCamera_NativeParameterAccess code sample shows how to access camera parameters via the \c Pylon::CBaslerUniversalInstantCamera class.
  11. */
  12. //-----------------------------------------------------------------------------
  13. // This file is generated automatically
  14. // Do not modify!
  15. //-----------------------------------------------------------------------------
  16. #ifndef BASLER_PYLON_UNIVERSALSTREAMPARAMS_H
  17. #define BASLER_PYLON_UNIVERSALSTREAMPARAMS_H
  18. #pragma once
  19. // common parameter types
  20. #include <pylon/ParameterIncludes.h>
  21. #include <pylon/EnumParameterT.h>
  22. namespace Basler_UniversalStreamParams
  23. {
  24. //**************************************************************************************************
  25. // Enumerations
  26. //**************************************************************************************************
  27. //! Valid values for AccessMode
  28. enum AccessModeEnums
  29. {
  30. AccessMode_Control, //!< The application has control access to the device - Applies to: GigE and blaze
  31. AccessMode_Exclusive, //!< The application has exclusive access to the device - Applies to: GigE and blaze
  32. AccessMode_Monitor, //!< The application has monitoring, i e , read-only, access to the device - Applies to: GigE and blaze
  33. AccessMode_NotInitialized //!< Access to the device has not been initialized - Applies to: GigE and blaze
  34. };
  35. //! Valid values for PixelPerClockCycle
  36. enum PixelPerClockCycleEnums
  37. {
  38. PixelPerClockCycle_One, //!< During each clock cycle, the device transmits data for one pixel - Applies to: BCON
  39. PixelPerClockCycle_Two //!< During each clock cycle, the device transmits data for two pixels - Applies to: BCON
  40. };
  41. //! Valid values for Status
  42. enum StatusEnums
  43. {
  44. Status_Closed, //!< The stream grabber is closed - Applies to: GigE
  45. Status_Locked, //!< The stream grabber is locked - Applies to: GigE
  46. Status_NotInitialized, //!< The stream grabber is not initialized - Applies to: GigE
  47. Status_Open //!< The stream grabber is open - Applies to: GigE
  48. };
  49. //! Valid values for StreamBufferHandlingMode
  50. enum StreamBufferHandlingModeEnums
  51. {
  52. StreamBufferHandlingMode_NewestOnly, //!< The application always gets the latest completed buffer (i e , the newest) - Applies to: CoaXPress and blaze
  53. StreamBufferHandlingMode_OldestFirst, //!< The application always gets the buffer from the head of the output buffer queue (i e , the oldest available) - Applies to: CoaXPress and blaze
  54. StreamBufferHandlingMode_OldestFirstOverwrite //!< The application always gets the buffer from the head of the output buffer queue (i e , the oldest available) - Applies to: CoaXPress and blaze
  55. };
  56. //! Valid values for StreamType
  57. enum StreamTypeEnums
  58. {
  59. StreamType_CL, //!< The data stream uses the Camera Link transport layer - Applies to: CoaXPress
  60. StreamType_CLHS, //!< The data stream uses the Camera Link HS transport layer - Applies to: CoaXPress
  61. StreamType_CXP, //!< The data stream uses the CoaXPress transport layer - Applies to: CoaXPress
  62. StreamType_CameraLink, //!< Camera Link - Applies to: CoaXPress
  63. StreamType_CameraLinkHS, //!< Camera Link High Speed - Applies to: CoaXPress
  64. StreamType_CoaXPress, //!< CoaXPress - Applies to: CoaXPress
  65. StreamType_Custom, //!< The data stream uses a custom transport layer - Applies to: CoaXPress
  66. StreamType_GEV, //!< The data stream uses the GigE Vision transport layer - Applies to: CoaXPress
  67. StreamType_GigEVision, //!< GigE Vision - Applies to: CoaXPress
  68. StreamType_Mixed, //!< Different interface modules of the GenTL Producer are of different types - Applies to: CoaXPress
  69. StreamType_U3V, //!< The data stream uses the USB3 Vision transport layer - Applies to: CoaXPress
  70. StreamType_USB3Vision //!< USB3 Vision - Applies to: CoaXPress
  71. };
  72. //! Valid values for TransmissionType
  73. enum TransmissionTypeEnums
  74. {
  75. TransmissionType_LimitedBroadcast, //!< The stream data is sent to all devices in the local area network (255 255 255 255) - Applies to: GigE
  76. TransmissionType_Multicast, //!< The stream data is sent to selected devices in the local network - Applies to: GigE
  77. TransmissionType_SubnetDirectedBroadcast, //!< The stream data is sent to all devices in the same subnet as the camera - Applies to: GigE
  78. TransmissionType_Unicast, //!< The stream data is sent to a single device in the local network - Applies to: GigE and blaze
  79. TransmissionType_UseCameraConfig //!< The stream transmission configuration is read from the camera - Applies to: GigE and blaze
  80. };
  81. //! Valid values for Type
  82. enum TypeEnums
  83. {
  84. Type_NoDriverAvailable, //!< No suitable driver is installed - Applies to: GigE and blaze
  85. Type_SocketDriver, //!< The socket driver is used - Applies to: GigE and blaze
  86. Type_WindowsFilterDriver, //!< The pylon GigE Vision Filter Driver is used - Applies to: GigE and blaze
  87. Type_WindowsIntelPerformanceDriver //!< The pylon GigE Vision Performance Driver is used - Applies to: GigE and blaze
  88. };
  89. //**************************************************************************************************
  90. // Parameter class CUniversalStreamParams_Params_v6_3_0
  91. //**************************************************************************************************
  92. /*!
  93. \brief A parameter class containing all parameters as members that are available for pylon stream grabbers
  94. The parameter class is used by the \c Pylon::CBaslerUniversalInstantCamera class.
  95. The \ref sample_ParametrizeCamera_NativeParameterAccess code sample shows how to access camera parameters via the \c Pylon::CBaslerUniversalInstantCamera class.
  96. */
  97. class PYLONBASE_API CUniversalStreamParams_Params_v6_3_0
  98. {
  99. //----------------------------------------------------------------------------------------------------------------
  100. // Implementation
  101. //----------------------------------------------------------------------------------------------------------------
  102. protected:
  103. // If you want to show the following methods in the help file
  104. // add the string HIDE_CLASS_METHODS to the ENABLED_SECTIONS tag in the doxygen file
  105. //! \cond HIDE_CLASS_METHODS
  106. //! Constructor
  107. CUniversalStreamParams_Params_v6_3_0( void );
  108. //! Destructor
  109. ~CUniversalStreamParams_Params_v6_3_0( void );
  110. //! Initializes the references
  111. void _Initialize( GENAPI_NAMESPACE::INodeMap* );
  112. //! \endcond
  113. private:
  114. class CUniversalStreamParams_Params_v6_3_0_Data;
  115. CUniversalStreamParams_Params_v6_3_0_Data* m_pCUniversalStreamParams_Params_v6_3_0_Data;
  116. //----------------------------------------------------------------------------------------------------------------
  117. // References to features
  118. //----------------------------------------------------------------------------------------------------------------
  119. public:
  120. //! \name Categories: Debug
  121. //@{
  122. /*!
  123. \brief Indicates the mode of access the current application has to the device - Applies to: GigE and blaze
  124. Visibility: Guru
  125. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=AccessMode" target="_blank">Basler Product Documentation</a> may provide more information.
  126. */
  127. Pylon::IEnumParameterT<AccessModeEnums>& AccessMode;
  128. //@}
  129. //! \name Categories: Root
  130. //@{
  131. /*!
  132. \brief Enables negotiation of the packet size to find the largest possible packet size - Applies to: GigE
  133. Enables negotiation of the packet size to find the largest possible packet size. Using large packets reduces the overhead for transferring images. The maximum packet size depends on the network hardware and its configuration.
  134. Visibility: Guru
  135. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=AutoPacketSize" target="_blank">Basler Product Documentation</a> may provide more information.
  136. */
  137. Pylon::IBooleanEx& AutoPacketSize;
  138. //@}
  139. //! \name Categories: GrabberSettings
  140. //@{
  141. /*!
  142. \brief Clock frequency on the host side in Hertz - Applies to: BCON
  143. Clock frequency on the host side in Hertz. This parameter is linked with the BconClockFrequency camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
  144. Visibility: Expert
  145. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ClockFrequency" target="_blank">Basler Product Documentation</a> may provide more information.
  146. */
  147. Pylon::IIntegerEx& ClockFrequency;
  148. //@}
  149. //! \name Categories: IPConfig
  150. //@{
  151. /*!
  152. \brief IP address to which the stream grabber sends all stream data - Applies to: GigE and blaze
  153. Visibility: Expert
  154. Selected by: TransmissionType
  155. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DestinationAddr" target="_blank">Basler Product Documentation</a> may provide more information.
  156. */
  157. Pylon::IStringEx& DestinationAddr;
  158. //@}
  159. //! \name Categories: IPConfig
  160. //@{
  161. /*!
  162. \brief Port to which the stream grabber sends all stream data - Applies to: GigE and blaze
  163. Port to which the stream grabber sends all stream data. If the parameter is set to zero, pylon automatically selects an unused port.
  164. Visibility: Expert
  165. Selected by: TransmissionType
  166. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DestinationPort" target="_blank">Basler Product Documentation</a> may provide more information.
  167. */
  168. Pylon::IIntegerEx& DestinationPort;
  169. //@}
  170. //! \name Categories: ExtendedStreamControl and Root
  171. //@{
  172. /*!
  173. \brief Enables the packet resend mechanism - Applies to: GigE and blaze
  174. Enables the packet resend mechanism. The pylon GigE Vision Filter Driver and the GigE Vision Performance Driver use different packet resend mechanisms.
  175. Visibility: Expert
  176. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=EnableResend" target="_blank">Basler Product Documentation</a> may provide more information.
  177. */
  178. Pylon::IBooleanEx& EnableResend;
  179. //@}
  180. //! \name Categories: Root
  181. //@{
  182. /*!
  183. \brief Firewall traversal interval value in milliseconds This applies to the stream channel If set to 0, this feature is disabled - Applies to: GigE
  184. Visibility: Guru
  185. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=FirewallTraversalInterval" target="_blank">Basler Product Documentation</a> may provide more information.
  186. */
  187. Pylon::IIntegerEx& FirewallTraversalInterval;
  188. //@}
  189. //! \name Categories: ExtendedStreamControl and Root
  190. //@{
  191. /*!
  192. \brief Maximum time in milliseconds to receive all packets of a frame - Applies to: GigE and blaze
  193. Maximum time in milliseconds to receive all packets of a frame. The timer starts when the first packet has been received. If the transmission is not completed within the given time, the corresponding frame is delivered with the status 'Failed'.
  194. Visibility: Guru
  195. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=FrameRetention" target="_blank">Basler Product Documentation</a> may provide more information.
  196. */
  197. Pylon::IIntegerEx& FrameRetention;
  198. //@}
  199. //! \name Categories: GrabberSettings
  200. //@{
  201. /*!
  202. \brief Height of the image ROI on the host side - Applies to: BCON
  203. Height of the image ROI on the host side. This parameter is linked with the Height camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
  204. Visibility: Expert
  205. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Height" target="_blank">Basler Product Documentation</a> may provide more information.
  206. */
  207. Pylon::IIntegerEx& Height;
  208. //@}
  209. //! \name Categories: ExtendedStreamControl and Root
  210. //@{
  211. /*!
  212. \brief Maximum size (in bytes) of a buffer used for grabbing images - Applies to: BCON, GigE, USB and blaze
  213. Maximum size (in bytes) of a buffer used for grabbing images. A grab application must set this parameter before grabbing starts.
  214. Visibility: Expert
  215. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=MaxBufferSize" target="_blank">Basler Product Documentation</a> may provide more information.
  216. */
  217. Pylon::IIntegerEx& MaxBufferSize;
  218. //@}
  219. //! \name Categories: ExtendedStreamControl and Root
  220. //@{
  221. /*!
  222. \brief Maximum number of buffers that can be used simultaneously for grabbing images - Applies to: BCON, GigE, USB and blaze
  223. Visibility: Expert
  224. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=MaxNumBuffer" target="_blank">Basler Product Documentation</a> may provide more information.
  225. */
  226. Pylon::IIntegerEx& MaxNumBuffer;
  227. //@}
  228. //! \name Categories: Root
  229. //@{
  230. /*!
  231. \brief Maximum USB data transfer size in bytes - Applies to: USB
  232. Maximum USB data transfer size in bytes. The default value is appropriate for most applications. Decreasing the value may increase the CPU load. USB host adapter drivers may require decreasing the value if the application fails to receive the image stream. The maximum value also depends on the operating system.
  233. Visibility: Guru
  234. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=MaxTransferSize" target="_blank">Basler Product Documentation</a> may provide more information.
  235. */
  236. Pylon::IIntegerEx& MaxTransferSize;
  237. //@}
  238. //! \name Categories: ExtendedStreamControl and Root
  239. //@{
  240. /*!
  241. \brief Maximum number of resend requests per missing packet - Applies to: GigE and blaze
  242. Maximum number of resend requests per missing packet. Only available if the pylon GigE Vision Performance Driver is used.
  243. Visibility: Guru
  244. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=MaximumNumberResendRequests" target="_blank">Basler Product Documentation</a> may provide more information.
  245. */
  246. Pylon::IIntegerEx& MaximumNumberResendRequests;
  247. //@}
  248. //! \name Categories: Root
  249. //@{
  250. /*!
  251. \brief Maximum number of USB request blocks (URBs) to be enqueued simultaneously - Applies to: USB
  252. Maximum number of USB request blocks (URBs) to be enqueued simultaneously. Increasing this value may improve stability and reduce jitter, but requires more resources on the host computer.
  253. Visibility: Guru
  254. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=NumMaxQueuedUrbs" target="_blank">Basler Product Documentation</a> may provide more information.
  255. */
  256. Pylon::IIntegerEx& NumMaxQueuedUrbs;
  257. //@}
  258. //! \name Categories: ExtendedStreamControl and Root
  259. //@{
  260. /*!
  261. \brief Timeout period in milliseconds between two packets within one frame - Applies to: GigE and blaze
  262. Timeout period in milliseconds between two packets within one frame. The timeout is reset each time a packet is received. If the timeout expires, e.g., no packet was received during the given period, the packet resend mechanism takes effect. For more information, see the Enable Resends parameter.
  263. Visibility: Guru
  264. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=PacketTimeout" target="_blank">Basler Product Documentation</a> may provide more information.
  265. */
  266. Pylon::IIntegerEx& PacketTimeout;
  267. //@}
  268. //! \name Categories: BufferHandlingControl and GrabberSettings
  269. //@{
  270. /*!
  271. \brief Size of the payload in bytes - Applies to: BCON and CoaXPress
  272. Size of the payload in bytes. This is the total number of bytes of the image data payload produced by the frame grabber. This value is computed by the frame grabber implementation. The pylon stream grabber needs to be open to be able to compute the payload size.
  273. Visibility: Expert
  274. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=PayloadSize" target="_blank">Basler Product Documentation</a> may provide more information.
  275. */
  276. Pylon::IIntegerEx& PayloadSize;
  277. //@}
  278. //! \name Categories: GrabberSettings
  279. //@{
  280. /*!
  281. \brief Pixel format on the host side - Applies to: BCON
  282. Pixel format on the host side. This parameter is linked with the Pixel Format camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
  283. Visibility: Expert
  284. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=PixelFormatValue" target="_blank">Basler Product Documentation</a> may provide more information.
  285. */
  286. Pylon::IIntegerEx& PixelFormatValue;
  287. //@}
  288. //! \name Categories: GrabberSettings
  289. //@{
  290. /*!
  291. \brief Sets the number of pixels per clock cycle on the host side - Applies to: BCON
  292. Sets the number of pixels per clock cycle on the host side. This parameter is linked with the Pixels per Clock Cycle camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
  293. Visibility: Expert
  294. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=PixelPerClockCycle" target="_blank">Basler Product Documentation</a> may provide more information.
  295. */
  296. Pylon::IEnumParameterT<PixelPerClockCycleEnums>& PixelPerClockCycle;
  297. //@}
  298. //! \name Categories: Root
  299. //@{
  300. /*!
  301. \brief Determines the largest possible packet size - Applies to: GigE
  302. Determines the largest possible packet size. Using large packets reduces the overhead for transmitting images. Whether large packets can be transmitted depends on the network hardware used and its configuration.
  303. Visibility: Guru
  304. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ProbePacketSize" target="_blank">Basler Product Documentation</a> may provide more information.
  305. */
  306. Pylon::ICommandEx& ProbePacketSize;
  307. //@}
  308. //! \name Categories: Root
  309. //@{
  310. /*!
  311. \brief Thread priority of the receive thread - Applies to: GigE
  312. Thread priority of the receive thread. Only available if the socket driver is used. To assign the priority, the Receive Thread Priority Override parameter must be set to true.
  313. Visibility: Guru
  314. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ReceiveThreadPriority" target="_blank">Basler Product Documentation</a> may provide more information.
  315. */
  316. Pylon::IIntegerEx& ReceiveThreadPriority;
  317. //@}
  318. //! \name Categories: Root
  319. //@{
  320. /*!
  321. \brief Enables assigning a custom priority to the thread which receives incoming stream packets - Applies to: GigE
  322. Enables assigning a custom priority to the thread which receives incoming stream packets. Only available if the socket driver is used. To assign the priority, use the Receive Thread Priority parameter.
  323. Visibility: Guru
  324. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ReceiveThreadPriorityOverride" target="_blank">Basler Product Documentation</a> may provide more information.
  325. */
  326. Pylon::IBooleanEx& ReceiveThreadPriorityOverride;
  327. //@}
  328. //! \name Categories: ExtendedStreamControl and Root
  329. //@{
  330. /*!
  331. \brief Size (in frames) of the receive window in which the stream grabber looks for missing packets - Applies to: GigE and blaze
  332. Size (in frames) of the receive window in which the stream grabber looks for missing packets. Only available if the pylon GigE Vision Performance Driver is used.
  333. Visibility: Guru
  334. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ReceiveWindowSize" target="_blank">Basler Product Documentation</a> may provide more information.
  335. */
  336. Pylon::IIntegerEx& ReceiveWindowSize;
  337. //@}
  338. //! \name Categories: ExtendedStreamControl and Root
  339. //@{
  340. /*!
  341. \brief Amount of packet resend requests to be batched, i e , sent together - Applies to: GigE and blaze
  342. Amount of packet resend requests to be batched, i.e., sent together. The parameter value is set in percent of the amount of frames between the resend request threshold and the start of the receive window. Only available if the pylon GigE Vision Performance Driver is used.
  343. Visibility: Guru
  344. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ResendRequestBatching" target="_blank">Basler Product Documentation</a> may provide more information.
  345. */
  346. Pylon::IIntegerEx& ResendRequestBatching;
  347. //@}
  348. //! \name Categories: ExtendedStreamControl and Root
  349. //@{
  350. /*!
  351. \brief Time to wait (in milliseconds) between sending a resend request and considering the request as lost - Applies to: GigE and blaze
  352. Time to wait (in milliseconds) between sending a resend request and considering the request as lost. Only available if the pylon GigE Vision Performance Driver is used.
  353. Visibility: Guru
  354. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ResendRequestResponseTimeout" target="_blank">Basler Product Documentation</a> may provide more information.
  355. */
  356. Pylon::IIntegerEx& ResendRequestResponseTimeout;
  357. //@}
  358. //! \name Categories: ExtendedStreamControl and Root
  359. //@{
  360. /*!
  361. \brief Threshold after which resend requests are initiated - Applies to: GigE and blaze
  362. Threshold after which resend requests are initiated. The parameter value is set in percent of the receive window size (Receive Window Size parameter). Only available if the pylon GigE Vision Performance Driver is used.
  363. Visibility: Guru
  364. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ResendRequestThreshold" target="_blank">Basler Product Documentation</a> may provide more information.
  365. */
  366. Pylon::IIntegerEx& ResendRequestThreshold;
  367. //@}
  368. //! \name Categories: ExtendedStreamControl and Root
  369. //@{
  370. /*!
  371. \brief Time to wait (in milliseconds) between detecting a missing packet and sending a resend request - Applies to: GigE and blaze
  372. Time to wait (in milliseconds) between detecting a missing packet and sending a resend request. Only available if the pylon GigE Vision Performance Driver is used.
  373. Visibility: Guru
  374. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ResendTimeout" target="_blank">Basler Product Documentation</a> may provide more information.
  375. */
  376. Pylon::IIntegerEx& ResendTimeout;
  377. //@}
  378. //! \name Categories: ExtendedStreamControl and Root
  379. //@{
  380. /*!
  381. \brief Socket buffer size in kilobytes - Applies to: GigE and blaze
  382. Socket buffer size in kilobytes. Only available if the socket driver is used.
  383. Visibility: Guru
  384. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=SocketBufferSize" target="_blank">Basler Product Documentation</a> may provide more information.
  385. */
  386. Pylon::IIntegerEx& SocketBufferSize;
  387. //@}
  388. //! \name Categories: Statistic
  389. //@{
  390. /*!
  391. \brief Number of frames lost because there were no buffers in the queue - Applies to: GigE and blaze
  392. Visibility: Expert
  393. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Buffer_Underrun_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  394. */
  395. Pylon::IIntegerEx& Statistic_Buffer_Underrun_Count;
  396. //@}
  397. //! \name Categories: Statistic
  398. //@{
  399. /*!
  400. \brief GigE cameras: Number of buffers with at least one failed packet A packet is considered failed if its status is not 'success' Other cameras: Number of buffers that returned with an error status - Applies to: BCON, GigE, USB and blaze
  401. GigE cameras: Number of buffers with at least one failed packet. A packet is considered failed if its status is not 'success'. Other cameras: Number of buffers that returned an error.
  402. Visibility: Expert
  403. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Failed_Buffer_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  404. */
  405. Pylon::IIntegerEx& Statistic_Failed_Buffer_Count;
  406. //@}
  407. //! \name Categories: Statistic
  408. //@{
  409. /*!
  410. \brief Number of failed packets - Applies to: GigE and blaze
  411. Number of failed packets, i.e., the number of packets whose status is not 'success'.
  412. Visibility: Expert
  413. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Failed_Packet_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  414. */
  415. Pylon::IIntegerEx& Statistic_Failed_Packet_Count;
  416. //@}
  417. //! \name Categories: Statistic
  418. //@{
  419. /*!
  420. \brief Last grabbed block ID - Applies to: BCON and USB
  421. Visibility: Expert
  422. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Last_Block_Id" target="_blank">Basler Product Documentation</a> may provide more information.
  423. */
  424. Pylon::IIntegerEx& Statistic_Last_Block_Id;
  425. //@}
  426. //! \name Categories: Statistic
  427. //@{
  428. /*!
  429. \brief Status code of the last failed buffer - Applies to: BCON and USB
  430. Visibility: Expert
  431. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Last_Failed_Buffer_Status" target="_blank">Basler Product Documentation</a> may provide more information.
  432. */
  433. Pylon::IIntegerEx& Statistic_Last_Failed_Buffer_Status;
  434. //@}
  435. //! \name Categories: Statistic
  436. //@{
  437. /*!
  438. \brief Status code of the last failed buffer - Applies to: BCON and USB
  439. Visibility: Expert
  440. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Last_Failed_Buffer_Status_Text" target="_blank">Basler Product Documentation</a> may provide more information.
  441. */
  442. Pylon::IStringEx& Statistic_Last_Failed_Buffer_Status_Text;
  443. //@}
  444. //! \name Categories: Statistic
  445. //@{
  446. /*!
  447. \brief Number of corrupt or lost frames between successfully grabbed images - Applies to: BCON and USB
  448. Visibility: Expert
  449. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Missed_Frame_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  450. */
  451. Pylon::IIntegerEx& Statistic_Missed_Frame_Count;
  452. //@}
  453. //! \name Categories: Statistic
  454. //@{
  455. /*!
  456. \brief Number of out-of-memory errors - Applies to: USB
  457. Visibility: Expert
  458. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Out_Of_Memory_Error_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  459. */
  460. Pylon::IIntegerEx& Statistic_Out_Of_Memory_Error_Count;
  461. //@}
  462. //! \name Categories: Statistic
  463. //@{
  464. /*!
  465. \brief Number of packets requested by packet resend commands - Applies to: GigE and blaze
  466. Visibility: Expert
  467. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Resend_Packet_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  468. */
  469. Pylon::IIntegerEx& Statistic_Resend_Packet_Count;
  470. //@}
  471. //! \name Categories: Statistic
  472. //@{
  473. /*!
  474. \brief Number of emitted packet resend commands sent - Applies to: GigE and blaze
  475. Visibility: Expert
  476. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Resend_Request_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  477. */
  478. Pylon::IIntegerEx& Statistic_Resend_Request_Count;
  479. //@}
  480. //! \name Categories: Statistic
  481. //@{
  482. /*!
  483. \brief Number of stream resynchronizations - Applies to: USB
  484. Visibility: Expert
  485. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Resynchronization_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  486. */
  487. Pylon::IIntegerEx& Statistic_Resynchronization_Count;
  488. //@}
  489. //! \name Categories: Statistic
  490. //@{
  491. /*!
  492. \brief GigE cameras: Number of frames received Other cameras: Number of buffers processed - Applies to: BCON, GigE, USB and blaze
  493. Visibility: Expert
  494. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Total_Buffer_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  495. */
  496. Pylon::IIntegerEx& Statistic_Total_Buffer_Count;
  497. //@}
  498. //! \name Categories: Statistic
  499. //@{
  500. /*!
  501. \brief Number of packets received - Applies to: GigE and blaze
  502. Visibility: Expert
  503. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Statistic_Total_Packet_Count" target="_blank">Basler Product Documentation</a> may provide more information.
  504. */
  505. Pylon::IIntegerEx& Statistic_Total_Packet_Count;
  506. //@}
  507. //! \name Categories: Debug
  508. //@{
  509. /*!
  510. \brief Indicates the current status of the stream grabber - Applies to: GigE
  511. Visibility: Guru
  512. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Status" target="_blank">Basler Product Documentation</a> may provide more information.
  513. */
  514. Pylon::IEnumParameterT<StatusEnums>& Status;
  515. //@}
  516. //! \name Categories: BufferHandlingControl
  517. //@{
  518. /*!
  519. \brief Minimum number of buffers to announce to enable selected buffer handling mode - Applies to: CoaXPress and blaze
  520. Visibility: Expert
  521. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamAnnounceBufferMinimum" target="_blank">Basler Product Documentation</a> may provide more information.
  522. */
  523. Pylon::IIntegerEx& StreamAnnounceBufferMinimum;
  524. //@}
  525. //! \name Categories: BufferHandlingControl
  526. //@{
  527. /*!
  528. \brief Number of announced (known) buffers on this stream - Applies to: CoaXPress and blaze
  529. Number of announced (known) buffers on this stream. This value is volatile. It may change if additional buffers are announced and/or buffers are revoked by the GenTL Consumer.
  530. Visibility: Expert
  531. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamAnnouncedBufferCount" target="_blank">Basler Product Documentation</a> may provide more information.
  532. */
  533. Pylon::IIntegerEx& StreamAnnouncedBufferCount;
  534. //@}
  535. //! \name Categories: BufferHandlingControl
  536. //@{
  537. /*!
  538. \brief Alignment size in bytes of the buffers passed to DSAnnounceBuffer - Applies to: CoaXPress and blaze
  539. Visibility: Expert
  540. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamBufferAlignment" target="_blank">Basler Product Documentation</a> may provide more information.
  541. */
  542. Pylon::IIntegerEx& StreamBufferAlignment;
  543. //@}
  544. //! \name Categories: BufferHandlingControl
  545. //@{
  546. /*!
  547. \brief Sets the buffer handling mode of this data stream - Applies to: CoaXPress and blaze
  548. Visibility: Beginner
  549. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamBufferHandlingMode" target="_blank">Basler Product Documentation</a> may provide more information.
  550. */
  551. Pylon::IEnumParameterT<StreamBufferHandlingModeEnums>& StreamBufferHandlingMode;
  552. //@}
  553. //! \name Categories: BufferHandlingControl
  554. //@{
  555. /*!
  556. \brief Maximum number of chunks to be expected in a buffer - Applies to: CoaXPress
  557. Maximum number of chunks to be expected in a buffer (can be used to allocate the array for the DSGetBufferChunkData function).
  558. Visibility: Expert
  559. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamChunkCountMaximum" target="_blank">Basler Product Documentation</a> may provide more information.
  560. */
  561. Pylon::IIntegerEx& StreamChunkCountMaximum;
  562. //@}
  563. //! \name Categories: BufferHandlingControl
  564. //@{
  565. /*!
  566. \brief Number of delivered frames since last acquisition start - Applies to: CoaXPress and blaze
  567. Number of delivered frames since last acquisition start. It isn't reset until the stream is closed.
  568. Visibility: Expert
  569. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamDeliveredFrameCount" target="_blank">Basler Product Documentation</a> may provide more information.
  570. */
  571. Pylon::IIntegerEx& StreamDeliveredFrameCount;
  572. //@}
  573. //! \name Categories: StreamInformation
  574. //@{
  575. /*!
  576. \brief Device-wide unique ID of the data stream - Applies to: CoaXPress and blaze
  577. Visibility: Expert
  578. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamID" target="_blank">Basler Product Documentation</a> may provide more information.
  579. */
  580. Pylon::IStringEx& StreamID;
  581. //@}
  582. //! \name Categories: BufferHandlingControl
  583. //@{
  584. /*!
  585. \brief Number of buffers in the input buffer pool plus the buffers currently being filled - Applies to: CoaXPress and blaze
  586. Visibility: Expert
  587. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamInputBufferCount" target="_blank">Basler Product Documentation</a> may provide more information.
  588. */
  589. Pylon::IIntegerEx& StreamInputBufferCount;
  590. //@}
  591. //! \name Categories: BufferHandlingControl
  592. //@{
  593. /*!
  594. \brief Indicates whether the acquisition engine is started or not - Applies to: CoaXPress and blaze
  595. Indicates whether the acquisition engine is started or not. This is independent of the acquisition status of the remote device.
  596. Visibility: Expert
  597. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamIsGrabbing" target="_blank">Basler Product Documentation</a> may provide more information.
  598. */
  599. Pylon::IBooleanEx& StreamIsGrabbing;
  600. //@}
  601. //! \name Categories: BufferHandlingControl
  602. //@{
  603. /*!
  604. \brief Number of lost frames due to queue underrun - Applies to: CoaXPress and blaze
  605. Number of lost frames due to queue underrun. This number is initialized with zero at the time the stream is opened and incremented every time data couldn't be acquired because there was no buffer in the input buffer pool. It isn't reset until the stream is closed.
  606. Visibility: Expert
  607. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamLostFrameCount" target="_blank">Basler Product Documentation</a> may provide more information.
  608. */
  609. Pylon::IIntegerEx& StreamLostFrameCount;
  610. //@}
  611. //! \name Categories: BufferHandlingControl
  612. //@{
  613. /*!
  614. \brief Number of buffers in the output buffer queue - Applies to: CoaXPress and blaze
  615. Visibility: Expert
  616. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamOutputBufferCount" target="_blank">Basler Product Documentation</a> may provide more information.
  617. */
  618. Pylon::IIntegerEx& StreamOutputBufferCount;
  619. //@}
  620. //! \name Categories: BufferHandlingControl
  621. //@{
  622. /*!
  623. \brief Number of frames started in the acquisition engine - Applies to: CoaXPress and blaze
  624. Number of frames started in the acquisition engine. This number is incremented every time a new buffer is started and then filled regardless of whether the buffer is later delivered to the user or discarded for any reason. This number is initialized with 0 at at the time the stream is opened. It isn't reset until the stream is closed.
  625. Visibility: Expert
  626. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamStartedFrameCount" target="_blank">Basler Product Documentation</a> may provide more information.
  627. */
  628. Pylon::IIntegerEx& StreamStartedFrameCount;
  629. //@}
  630. //! \name Categories: StreamInformation
  631. //@{
  632. /*!
  633. \brief Sets the transport layer of the data stream - Applies to: CoaXPress
  634. Visibility: Expert
  635. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=StreamType" target="_blank">Basler Product Documentation</a> may provide more information.
  636. */
  637. Pylon::IEnumParameterT<StreamTypeEnums>& StreamType;
  638. //@}
  639. //! \name Categories: Root
  640. //@{
  641. /*!
  642. \brief Priority of the thread that handles USB requests from the stream interface - Applies to: USB
  643. Visibility: Guru
  644. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=TransferLoopThreadPriority" target="_blank">Basler Product Documentation</a> may provide more information.
  645. */
  646. Pylon::IIntegerEx& TransferLoopThreadPriority;
  647. //@}
  648. //! \name Categories: IPConfig
  649. //@{
  650. /*!
  651. \brief Sets how stream data is transferred within the network - Applies to: GigE and blaze
  652. Sets how stream data is transferred within the network. The stream grabber can send the stream data to one specific device or to multiple devices in the network.
  653. Visibility: Expert
  654. Selecting Parameters: DestinationAddr and DestinationPort
  655. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=TransmissionType" target="_blank">Basler Product Documentation</a> may provide more information.
  656. */
  657. Pylon::IEnumParameterT<TransmissionTypeEnums>& TransmissionType;
  658. //@}
  659. //! \name Categories: ExtendedStreamControl and Root
  660. //@{
  661. /*!
  662. \brief Sets the driver type to be used by the stream grabber - Applies to: GigE and blaze
  663. Visibility: Beginner
  664. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Type" target="_blank">Basler Product Documentation</a> may provide more information.
  665. */
  666. Pylon::IEnumParameterT<TypeEnums>& Type;
  667. //@}
  668. //! \name Categories: Debug
  669. //@{
  670. /*!
  671. \brief Indicates whether the socket driver is currently available - Applies to: GigE and blaze
  672. Visibility: Guru
  673. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=TypeIsSocketDriverAvailable" target="_blank">Basler Product Documentation</a> may provide more information.
  674. */
  675. Pylon::IIntegerEx& TypeIsSocketDriverAvailable;
  676. //@}
  677. //! \name Categories: Debug
  678. //@{
  679. /*!
  680. \brief Indicates whether the pylon GigE Vision Filter Driver is currently available - Applies to: GigE and blaze
  681. Visibility: Guru
  682. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=TypeIsWindowsFilterDriverAvailable" target="_blank">Basler Product Documentation</a> may provide more information.
  683. */
  684. Pylon::IIntegerEx& TypeIsWindowsFilterDriverAvailable;
  685. //@}
  686. //! \name Categories: Debug
  687. //@{
  688. /*!
  689. \brief Indicates whether the pylon GigE Vision Performance Driver is currently available - Applies to: GigE and blaze
  690. Visibility: Guru
  691. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=TypeIsWindowsIntelPerformanceDriverAvailable" target="_blank">Basler Product Documentation</a> may provide more information.
  692. */
  693. Pylon::IIntegerEx& TypeIsWindowsIntelPerformanceDriverAvailable;
  694. //@}
  695. //! \name Categories: GrabberSettings
  696. //@{
  697. /*!
  698. \brief Width of the image ROI on the host side - Applies to: BCON
  699. Width of the image ROI on the host side. This parameter is linked with the Width camera parameter. If the camera parameter changes, the host parameter changes accordingly, but not vice versa. The host parameter should not be set to a value different from the camera parameter.
  700. Visibility: Expert
  701. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=Width" target="_blank">Basler Product Documentation</a> may provide more information.
  702. */
  703. Pylon::IIntegerEx& Width;
  704. //@}
  705. private:
  706. //! \cond HIDE_CLASS_METHODS
  707. //! not implemented copy constructor
  708. CUniversalStreamParams_Params_v6_3_0(CUniversalStreamParams_Params_v6_3_0&);
  709. //! not implemented assignment operator
  710. CUniversalStreamParams_Params_v6_3_0& operator=(CUniversalStreamParams_Params_v6_3_0&);
  711. //! \endcond
  712. };
  713. /*!
  714. \brief A parameter class containing all parameters as members that are available for pylon stream grabbers
  715. The parameter class is used by the \c Pylon::CBaslerUniversalInstantCamera class.
  716. The \ref sample_ParametrizeCamera_NativeParameterAccess code sample shows how to access camera parameters via the \c Pylon::CBaslerUniversalInstantCamera class.
  717. */
  718. class CUniversalStreamParams_Params : public CUniversalStreamParams_Params_v6_3_0
  719. {
  720. //----------------------------------------------------------------------------------------------------------------
  721. // Implementation
  722. //----------------------------------------------------------------------------------------------------------------
  723. protected:
  724. // If you want to show the following methods in the help file
  725. // add the string HIDE_CLASS_METHODS to the ENABLED_SECTIONS tag in the doxygen file
  726. //! \cond HIDE_CLASS_METHODS
  727. //! Constructor
  728. CUniversalStreamParams_Params( void )
  729. {
  730. }
  731. //! Destructor
  732. ~CUniversalStreamParams_Params( void )
  733. {
  734. }
  735. //! Initializes the references
  736. void _Initialize( GENAPI_NAMESPACE::INodeMap* pNodeMap )
  737. {
  738. CUniversalStreamParams_Params_v6_3_0::_Initialize( pNodeMap );
  739. }
  740. //! \endcond
  741. };
  742. } // namespace Basler_UniversalStreamParams
  743. #endif // BASLER_PYLON_UNIVERSALSTREAMPARAMS_H