_BaslerUniversalInterfaceParams.h 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298
  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 interfaces
  9. */
  10. //-----------------------------------------------------------------------------
  11. // This file is generated automatically
  12. // Do not modify!
  13. //-----------------------------------------------------------------------------
  14. #ifndef BASLER_PYLON_UNIVERSALINTERFACEPARAMS_H
  15. #define BASLER_PYLON_UNIVERSALINTERFACEPARAMS_H
  16. #pragma once
  17. // common parameter types
  18. #include <pylon/ParameterIncludes.h>
  19. #include <pylon/EnumParameterT.h>
  20. namespace Basler_UniversalInterfaceParams
  21. {
  22. //**************************************************************************************************
  23. // Enumerations
  24. //**************************************************************************************************
  25. //! Valid values for CxpLinkConfiguration
  26. enum CxpLinkConfigurationEnums
  27. {
  28. CxpLinkConfiguration_Auto, //!< Link speed is controlled automatically
  29. CxpLinkConfiguration_CXP10_X1, //!< 1 connection is operating at CXP-10 speed (10 0 Gbps)
  30. CxpLinkConfiguration_CXP12_X1, //!< 1 connection is operating at CXP-12 speed (12 50 Gbps)
  31. CxpLinkConfiguration_CXP1_X1, //!< 1 connection is operating at CXP-1 speed (1 25 Gbps)
  32. CxpLinkConfiguration_CXP2_X1, //!< 1 connection is operating at CXP-2 speed (2 50 Gbps)
  33. CxpLinkConfiguration_CXP3_X1, //!< 1 connection is operating at CXP-3 speed (3 125 Gbps)
  34. CxpLinkConfiguration_CXP5_X1, //!< 1 connection is operating at CXP-5 speed (5 00 Gbps)
  35. CxpLinkConfiguration_CXP6_X1 //!< 1 connection is operating at CXP-6 speed (6 25 Gbps)
  36. };
  37. //! Valid values for CxpPoCxpStatus
  38. enum CxpPoCxpStatusEnums
  39. {
  40. CxpPoCxpStatus_Auto, //!< PoCXP operation is set to automatic
  41. CxpPoCxpStatus_Off, //!< PoCXP is forced off
  42. CxpPoCxpStatus_Tripped //!< The link has shut down because of an over-current trip
  43. };
  44. //! Valid values for CxpPort0PowerState
  45. enum CxpPort0PowerStateEnums
  46. {
  47. CxpPort0PowerState_AdcFault, //!< The PoCXP state can't be determined because of an A/D converter fault
  48. CxpPort0PowerState_Disabled, //!< PoCXP is disabled
  49. CxpPort0PowerState_HighCurrent, //!< PoCXP is off because of an over current trip
  50. CxpPort0PowerState_HighVoltage, //!< PoCXP is off because the voltage is too high
  51. CxpPort0PowerState_Initializing, //!< The PoCXP state machine is looking for devices
  52. CxpPort0PowerState_InvalidValue, //!< The PoCXP state can't be determined
  53. CxpPort0PowerState_LowVoltage, //!< PoCXP is off because the voltage is too low
  54. CxpPort0PowerState_On //!< PoCXP is active
  55. };
  56. //! Valid values for CxpPort1PowerState
  57. enum CxpPort1PowerStateEnums
  58. {
  59. CxpPort1PowerState_AdcFault, //!< The PoCXP state can't be determined because of an A/D converter fault
  60. CxpPort1PowerState_Disabled, //!< PoCXP is disabled
  61. CxpPort1PowerState_HighCurrent, //!< PoCXP is off because of an over current trip
  62. CxpPort1PowerState_HighVoltage, //!< PoCXP is off because the voltage is too high
  63. CxpPort1PowerState_Initializing, //!< The PoCXP state machine is looking for devices
  64. CxpPort1PowerState_InvalidValue, //!< The PoCXP state can't be determined
  65. CxpPort1PowerState_LowVoltage, //!< PoCXP is off because the voltage is too low
  66. CxpPort1PowerState_On //!< PoCXP is active
  67. };
  68. //! Valid values for CxpPort2PowerState
  69. enum CxpPort2PowerStateEnums
  70. {
  71. CxpPort2PowerState_AdcFault, //!< The PoCXP state can't be determined because of an A/D converter fault
  72. CxpPort2PowerState_Disabled, //!< PoCXP is disabled
  73. CxpPort2PowerState_HighCurrent, //!< PoCXP is off because of an over current trip
  74. CxpPort2PowerState_HighVoltage, //!< PoCXP is off because the voltage is too high
  75. CxpPort2PowerState_Initializing, //!< The PoCXP state machine is looking for devices
  76. CxpPort2PowerState_InvalidValue, //!< The PoCXP state can't be determined
  77. CxpPort2PowerState_LowVoltage, //!< PoCXP is off because the voltage is too low
  78. CxpPort2PowerState_On //!< PoCXP is active
  79. };
  80. //! Valid values for CxpPort3PowerState
  81. enum CxpPort3PowerStateEnums
  82. {
  83. CxpPort3PowerState_AdcFault, //!< The PoCXP state can't be determined because of an A/D converter fault
  84. CxpPort3PowerState_Disabled, //!< PoCXP is disabled
  85. CxpPort3PowerState_HighCurrent, //!< PoCXP is off because of an over current trip
  86. CxpPort3PowerState_HighVoltage, //!< PoCXP is off because the voltage is too high
  87. CxpPort3PowerState_Initializing, //!< The PoCXP state machine is looking for devices
  88. CxpPort3PowerState_InvalidValue, //!< The PoCXP state can't be determined
  89. CxpPort3PowerState_LowVoltage, //!< PoCXP is off because the voltage is too low
  90. CxpPort3PowerState_On //!< PoCXP is active
  91. };
  92. //! Valid values for DeviceAccessStatus
  93. enum DeviceAccessStatusEnums
  94. {
  95. DeviceAccessStatus_Busy, //!< The device is already opened by another entity
  96. DeviceAccessStatus_NoAccess, //!< You can't connect to the device
  97. DeviceAccessStatus_OpenReadOnly, //!< The device is opened in Read-only mode by this GenTL host
  98. DeviceAccessStatus_OpenReadWrite, //!< The device is opened in Read/Write mode by this GenTL host
  99. DeviceAccessStatus_ReadOnly, //!< The device offers read-only access
  100. DeviceAccessStatus_ReadWrite, //!< The device offers read/write access
  101. DeviceAccessStatus_Unknown //!< The status is unknown
  102. };
  103. //! Valid values for EventNotification
  104. enum EventNotificationEnums
  105. {
  106. EventNotification_Off, //!< The selected Event notification is disabled
  107. EventNotification_On, //!< The selected Event notification is enabled
  108. EventNotification_Once //!< The selected Event notification is enabled for one event then return to Off state
  109. };
  110. //! Valid values for EventSelector
  111. enum EventSelectorEnums
  112. {
  113. EventSelector_DeviceListChanged, //!< The DeviceListChanged event is selected
  114. EventSelector_InterfaceLost //!< The Interface Lost event is selected
  115. };
  116. //! Valid values for InterfaceApplet
  117. enum InterfaceAppletEnums
  118. {
  119. InterfaceApplet_Acq_DualCXP12Area, //!< The Acq_DualCXP12Area applet is used to initialize the interface
  120. InterfaceApplet_Acq_QuadCXP12Area, //!< The Acq_QuadCXP12Area applet is used to initialize the interface
  121. InterfaceApplet_Acq_SingleCXP12Area, //!< The Acq_SingleCXP12Area applet is used to initialize the interface
  122. InterfaceApplet_Acq_SingleCXP12x1Area, //!< The Acq_SingleCXP12x1Area applet is used to initialize the interface
  123. InterfaceApplet_Acq_SingleCXP12x1Area_01, //!< The Acq_SingleCXP12x1Area_01 applet is used to initialize the interface
  124. InterfaceApplet_Acq_SingleCXP12x1Area_02, //!< The Acq_SingleCXP12x1Area_02 applet is used to initialize the interface
  125. InterfaceApplet_Acq_TripleCXP12Area, //!< The Acq_TripleCXP12Area applet is used to initialize the interface
  126. InterfaceApplet_FrameGrabberTest //!<
  127. };
  128. //! Valid values for InterfaceAppletStatus
  129. enum InterfaceAppletStatusEnums
  130. {
  131. InterfaceAppletStatus_Acq_DualCXP12Area, //!< The status of the Acq_DualCXP12Area applet is returned
  132. InterfaceAppletStatus_Acq_QuadCXP12Area, //!< The status of the Acq_QuadCXP12Area applet is returned
  133. InterfaceAppletStatus_Acq_SingleCXP12Area, //!< The status of the Acq_SingleCXP12Area applet is returned
  134. InterfaceAppletStatus_Acq_TripleCXP12Area, //!< The status of the Acq_TripleCXP12Area applet is returned
  135. InterfaceAppletStatus_FrameGrabberTest, //!<
  136. InterfaceAppletStatus_Loading, //!< The status of the applet is Loading
  137. InterfaceAppletStatus_NotLoaded //!< The status of the applet is NotLoaded
  138. };
  139. //! Valid values for InterfaceType
  140. enum InterfaceTypeEnums
  141. {
  142. InterfaceType_CL, //!< The interface uses the Camera Link transport layer
  143. InterfaceType_CLHS, //!< The interface uses the Camera Link HS transport layer
  144. InterfaceType_CXP, //!< The interface uses the CoaXPress transport layer
  145. InterfaceType_CameraLink, //!< Camera Link
  146. InterfaceType_CameraLinkHS, //!< Camera Link High Speed
  147. InterfaceType_CoaXPress, //!< CoaXPress
  148. InterfaceType_Custom, //!< The interface uses a custom transport layer
  149. InterfaceType_GEV, //!< The interface uses the GigE Vision transport layer
  150. InterfaceType_GigEVision, //!< GigE Vision
  151. InterfaceType_Mixed, //!< Different interface modules of the GenTL Producer are of different types
  152. InterfaceType_U3V, //!< The interface uses the USB3 Vision transport layer
  153. InterfaceType_USB3Vision //!< USB3 Vision
  154. };
  155. //**************************************************************************************************
  156. // Parameter class CUniversalInterfaceParams_Params_v6_3_0
  157. //**************************************************************************************************
  158. //! A parameter class containing all parameters as members that are available for pylon interfaces
  159. class PYLONBASE_API CUniversalInterfaceParams_Params_v6_3_0
  160. {
  161. //----------------------------------------------------------------------------------------------------------------
  162. // Implementation
  163. //----------------------------------------------------------------------------------------------------------------
  164. protected:
  165. // If you want to show the following methods in the help file
  166. // add the string HIDE_CLASS_METHODS to the ENABLED_SECTIONS tag in the doxygen file
  167. //! \cond HIDE_CLASS_METHODS
  168. //! Constructor
  169. CUniversalInterfaceParams_Params_v6_3_0( void );
  170. //! Destructor
  171. ~CUniversalInterfaceParams_Params_v6_3_0( void );
  172. //! Initializes the references
  173. void _Initialize( GENAPI_NAMESPACE::INodeMap* );
  174. //! \endcond
  175. private:
  176. class CUniversalInterfaceParams_Params_v6_3_0_Data;
  177. CUniversalInterfaceParams_Params_v6_3_0_Data* m_pCUniversalInterfaceParams_Params_v6_3_0_Data;
  178. //----------------------------------------------------------------------------------------------------------------
  179. // References to features
  180. //----------------------------------------------------------------------------------------------------------------
  181. public:
  182. //! \name Categories: BoardSensors
  183. //@{
  184. /*!
  185. \brief Ambient temperature at the board
  186. Visibility: Beginner
  187. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=AmbientTemperature" target="_blank">Basler Product Documentation</a> may provide more information.
  188. */
  189. Pylon::IFloatEx& AmbientTemperature;
  190. //@}
  191. //! \name Categories: CoaXPress and TransportLayerControl
  192. //@{
  193. /*!
  194. \brief Sets the physical CoaXPress connection to control
  195. Visibility: Beginner
  196. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpConnectionSelector" target="_blank">Basler Product Documentation</a> may provide more information.
  197. */
  198. Pylon::IIntegerEx& CxpConnectionSelector;
  199. //@}
  200. //! \name Categories: TransportLayerControl
  201. //@{
  202. /*!
  203. \brief Sets the link configuration for the communication between the receiver and transmitter device
  204. Visibility: Beginner
  205. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpLinkConfiguration" target="_blank">Basler Product Documentation</a> may provide more information.
  206. */
  207. Pylon::IEnumParameterT<CxpLinkConfigurationEnums>& CxpLinkConfiguration;
  208. //@}
  209. //! \name Categories: CoaXPress and TransportLayerControl
  210. //@{
  211. /*!
  212. \brief Enables automatic control of Power over CoaXPress (PoCXP) for the port
  213. Visibility: Expert
  214. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPoCxpAuto" target="_blank">Basler Product Documentation</a> may provide more information.
  215. */
  216. Pylon::ICommandEx& CxpPoCxpAuto;
  217. //@}
  218. //! \name Categories: CoaXPress and TransportLayerControl
  219. //@{
  220. /*!
  221. \brief Returns the Power over CoaXPress (PoCXP) status of the device
  222. Visibility: Expert
  223. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPoCxpStatus" target="_blank">Basler Product Documentation</a> may provide more information.
  224. */
  225. Pylon::IEnumParameterT<CxpPoCxpStatusEnums>& CxpPoCxpStatus;
  226. //@}
  227. //! \name Categories: CoaXPress and TransportLayerControl
  228. //@{
  229. /*!
  230. \brief Resets Power over CoaXPress (PoCXP) link after an over-current trip on the device connection(s)
  231. Visibility: Expert
  232. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPoCxpTripReset" target="_blank">Basler Product Documentation</a> may provide more information.
  233. */
  234. Pylon::ICommandEx& CxpPoCxpTripReset;
  235. //@}
  236. //! \name Categories: CoaXPress and TransportLayerControl
  237. //@{
  238. /*!
  239. \brief Disables Power over CoaXPress (PoCXP) for the port
  240. Visibility: Expert
  241. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPoCxpTurnOff" target="_blank">Basler Product Documentation</a> may provide more information.
  242. */
  243. Pylon::ICommandEx& CxpPoCxpTurnOff;
  244. //@}
  245. //! \name Categories: Port0Status
  246. //@{
  247. /*!
  248. \brief CXP port 0 current
  249. Visibility: Beginner
  250. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort0Current" target="_blank">Basler Product Documentation</a> may provide more information.
  251. */
  252. Pylon::IFloatEx& CxpPort0Current;
  253. //@}
  254. //! \name Categories: Port0Status
  255. //@{
  256. /*!
  257. \brief Number of CXP port 0 disparity errors
  258. Visibility: Beginner
  259. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort0DisparityErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  260. */
  261. Pylon::IIntegerEx& CxpPort0DisparityErrorCount;
  262. //@}
  263. //! \name Categories: Port0Status
  264. //@{
  265. /*!
  266. \brief Link speed of CXP port 0
  267. Visibility: Beginner
  268. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort0LinkSpeed" target="_blank">Basler Product Documentation</a> may provide more information.
  269. */
  270. Pylon::IFloatEx& CxpPort0LinkSpeed;
  271. //@}
  272. //! \name Categories: Port0Status
  273. //@{
  274. /*!
  275. \brief Number of CXP port 0 not-in-table errors
  276. Visibility: Beginner
  277. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort0NotInTableErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  278. */
  279. Pylon::IIntegerEx& CxpPort0NotInTableErrorCount;
  280. //@}
  281. //! \name Categories: Port0Status
  282. //@{
  283. /*!
  284. \brief CXP port 0 power
  285. Visibility: Beginner
  286. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort0Power" target="_blank">Basler Product Documentation</a> may provide more information.
  287. */
  288. Pylon::IFloatEx& CxpPort0Power;
  289. //@}
  290. //! \name Categories: Port0Status
  291. //@{
  292. /*!
  293. \brief Returns the Power over CXP (PoCXP) state of CXP port 0
  294. Visibility: Beginner
  295. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort0PowerState" target="_blank">Basler Product Documentation</a> may provide more information.
  296. */
  297. Pylon::IEnumParameterT<CxpPort0PowerStateEnums>& CxpPort0PowerState;
  298. //@}
  299. //! \name Categories: Port0Status
  300. //@{
  301. /*!
  302. \brief CXP port 0 voltage
  303. Visibility: Beginner
  304. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort0Voltage" target="_blank">Basler Product Documentation</a> may provide more information.
  305. */
  306. Pylon::IFloatEx& CxpPort0Voltage;
  307. //@}
  308. //! \name Categories: Port1Status
  309. //@{
  310. /*!
  311. \brief CXP port 1 current
  312. Visibility: Beginner
  313. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort1Current" target="_blank">Basler Product Documentation</a> may provide more information.
  314. */
  315. Pylon::IFloatEx& CxpPort1Current;
  316. //@}
  317. //! \name Categories: Port1Status
  318. //@{
  319. /*!
  320. \brief Number of CXP port 1 disparity errors
  321. Visibility: Beginner
  322. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort1DisparityErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  323. */
  324. Pylon::IIntegerEx& CxpPort1DisparityErrorCount;
  325. //@}
  326. //! \name Categories: Port1Status
  327. //@{
  328. /*!
  329. \brief Link speed of CXP port 1
  330. Visibility: Beginner
  331. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort1LinkSpeed" target="_blank">Basler Product Documentation</a> may provide more information.
  332. */
  333. Pylon::IFloatEx& CxpPort1LinkSpeed;
  334. //@}
  335. //! \name Categories: Port1Status
  336. //@{
  337. /*!
  338. \brief Number of CXP port 1 not-in-table errors
  339. Visibility: Beginner
  340. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort1NotInTableErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  341. */
  342. Pylon::IIntegerEx& CxpPort1NotInTableErrorCount;
  343. //@}
  344. //! \name Categories: Port1Status
  345. //@{
  346. /*!
  347. \brief CXP port 1 power
  348. Visibility: Beginner
  349. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort1Power" target="_blank">Basler Product Documentation</a> may provide more information.
  350. */
  351. Pylon::IFloatEx& CxpPort1Power;
  352. //@}
  353. //! \name Categories: Port1Status
  354. //@{
  355. /*!
  356. \brief Returns the Power over CXP (PoCXP) state of CXP port 1
  357. Visibility: Beginner
  358. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort1PowerState" target="_blank">Basler Product Documentation</a> may provide more information.
  359. */
  360. Pylon::IEnumParameterT<CxpPort1PowerStateEnums>& CxpPort1PowerState;
  361. //@}
  362. //! \name Categories: Port1Status
  363. //@{
  364. /*!
  365. \brief CXP port 1 voltage
  366. Visibility: Beginner
  367. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort1Voltage" target="_blank">Basler Product Documentation</a> may provide more information.
  368. */
  369. Pylon::IFloatEx& CxpPort1Voltage;
  370. //@}
  371. //! \name Categories: Port2Status
  372. //@{
  373. /*!
  374. \brief CXP port 2 current
  375. Visibility: Beginner
  376. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort2Current" target="_blank">Basler Product Documentation</a> may provide more information.
  377. */
  378. Pylon::IFloatEx& CxpPort2Current;
  379. //@}
  380. //! \name Categories: Port2Status
  381. //@{
  382. /*!
  383. \brief Number of CXP port 2 disparity errors
  384. Visibility: Beginner
  385. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort2DisparityErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  386. */
  387. Pylon::IIntegerEx& CxpPort2DisparityErrorCount;
  388. //@}
  389. //! \name Categories: Port2Status
  390. //@{
  391. /*!
  392. \brief Link speed of CXP port 2
  393. Visibility: Beginner
  394. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort2LinkSpeed" target="_blank">Basler Product Documentation</a> may provide more information.
  395. */
  396. Pylon::IFloatEx& CxpPort2LinkSpeed;
  397. //@}
  398. //! \name Categories: Port2Status
  399. //@{
  400. /*!
  401. \brief Number of CXP port 2 not-in-table errors
  402. Visibility: Beginner
  403. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort2NotInTableErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  404. */
  405. Pylon::IIntegerEx& CxpPort2NotInTableErrorCount;
  406. //@}
  407. //! \name Categories: Port2Status
  408. //@{
  409. /*!
  410. \brief CXP port 2 power
  411. Visibility: Beginner
  412. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort2Power" target="_blank">Basler Product Documentation</a> may provide more information.
  413. */
  414. Pylon::IFloatEx& CxpPort2Power;
  415. //@}
  416. //! \name Categories: Port2Status
  417. //@{
  418. /*!
  419. \brief Returns the Power over CXP (PoCXP) state of CXP port 2
  420. Visibility: Beginner
  421. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort2PowerState" target="_blank">Basler Product Documentation</a> may provide more information.
  422. */
  423. Pylon::IEnumParameterT<CxpPort2PowerStateEnums>& CxpPort2PowerState;
  424. //@}
  425. //! \name Categories: Port2Status
  426. //@{
  427. /*!
  428. \brief CXP port 2 voltage
  429. Visibility: Beginner
  430. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort2Voltage" target="_blank">Basler Product Documentation</a> may provide more information.
  431. */
  432. Pylon::IFloatEx& CxpPort2Voltage;
  433. //@}
  434. //! \name Categories: Port3Status
  435. //@{
  436. /*!
  437. \brief CXP port 3 current
  438. Visibility: Beginner
  439. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort3Current" target="_blank">Basler Product Documentation</a> may provide more information.
  440. */
  441. Pylon::IFloatEx& CxpPort3Current;
  442. //@}
  443. //! \name Categories: Port3Status
  444. //@{
  445. /*!
  446. \brief Number of CXP port 3 disparity errors
  447. Visibility: Beginner
  448. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort3DisparityErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  449. */
  450. Pylon::IIntegerEx& CxpPort3DisparityErrorCount;
  451. //@}
  452. //! \name Categories: Port3Status
  453. //@{
  454. /*!
  455. \brief Link speed of CXP port 3
  456. Visibility: Beginner
  457. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort3LinkSpeed" target="_blank">Basler Product Documentation</a> may provide more information.
  458. */
  459. Pylon::IFloatEx& CxpPort3LinkSpeed;
  460. //@}
  461. //! \name Categories: Port3Status
  462. //@{
  463. /*!
  464. \brief Number of CXP port 3 not-in-table errors
  465. Visibility: Beginner
  466. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort3NotInTableErrorCount" target="_blank">Basler Product Documentation</a> may provide more information.
  467. */
  468. Pylon::IIntegerEx& CxpPort3NotInTableErrorCount;
  469. //@}
  470. //! \name Categories: Port3Status
  471. //@{
  472. /*!
  473. \brief CXP port 3 power
  474. Visibility: Beginner
  475. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort3Power" target="_blank">Basler Product Documentation</a> may provide more information.
  476. */
  477. Pylon::IFloatEx& CxpPort3Power;
  478. //@}
  479. //! \name Categories: Port3Status
  480. //@{
  481. /*!
  482. \brief Returns the Power over CXP (PoCXP) state of CXP port 3
  483. Visibility: Beginner
  484. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort3PowerState" target="_blank">Basler Product Documentation</a> may provide more information.
  485. */
  486. Pylon::IEnumParameterT<CxpPort3PowerStateEnums>& CxpPort3PowerState;
  487. //@}
  488. //! \name Categories: Port3Status
  489. //@{
  490. /*!
  491. \brief CXP port 3 voltage
  492. Visibility: Beginner
  493. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=CxpPort3Voltage" target="_blank">Basler Product Documentation</a> may provide more information.
  494. */
  495. Pylon::IFloatEx& CxpPort3Voltage;
  496. //@}
  497. //! \name Categories: DeviceEnumeration
  498. //@{
  499. /*!
  500. \brief Returns the device's access status at the moment when the Device Update List command was last executed
  501. Returns the device's access status at the moment when the Device Update List command was last executed. This value only changes when the Device Update List command is executed.
  502. Visibility: Expert
  503. Selected by: DeviceSelector
  504. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceAccessStatus" target="_blank">Basler Product Documentation</a> may provide more information.
  505. */
  506. Pylon::IEnumParameterT<DeviceAccessStatusEnums>& DeviceAccessStatus;
  507. //@}
  508. //! \name Categories: DeviceEnumeration
  509. //@{
  510. /*!
  511. \brief Interface-wide unique ID of the selected device
  512. Interface-wide unique ID of the selected device. This value only changes when the Device Update List command is executed.
  513. Visibility: Expert
  514. Selected by: DeviceSelector
  515. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceID" target="_blank">Basler Product Documentation</a> may provide more information.
  516. */
  517. Pylon::IStringEx& DeviceID;
  518. //@}
  519. //! \name Categories: DeviceEnumeration
  520. //@{
  521. /*!
  522. \brief Name of the device model
  523. Name of the device model. This value only changes when the Device Update List command is executed.
  524. Visibility: Expert
  525. Selected by: DeviceSelector
  526. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceModelName" target="_blank">Basler Product Documentation</a> may provide more information.
  527. */
  528. Pylon::IStringEx& DeviceModelName;
  529. //@}
  530. //! \name Categories: DeviceEnumeration
  531. //@{
  532. /*!
  533. \brief Device selected in this interface
  534. Device selected in this interface. This value only changes when the Device Update List command is executed. The parameter is 0-based in order to match the index of the C interface.
  535. Visibility: Expert
  536. Selecting Parameters: DeviceAccessStatus, DeviceID, DeviceModelName, DeviceSerialNumber, DeviceTLVersionMajor, DeviceTLVersionMinor, DeviceVendorName, GevDeviceIPAddress, GevDeviceMACAddress and GevDeviceSubnetMask
  537. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceSelector" target="_blank">Basler Product Documentation</a> may provide more information.
  538. */
  539. Pylon::IIntegerEx& DeviceSelector;
  540. //@}
  541. //! \name Categories: DeviceEnumeration
  542. //@{
  543. /*!
  544. \brief Serial number of the remote device
  545. Serial number of the remote device. This value only changes when the Device Update List command is executed.
  546. Visibility: Expert
  547. Selected by: DeviceSelector
  548. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceSerialNumber" target="_blank">Basler Product Documentation</a> may provide more information.
  549. */
  550. Pylon::IStringEx& DeviceSerialNumber;
  551. //@}
  552. //! \name Categories: DeviceEnumeration
  553. //@{
  554. /*!
  555. \brief Major version number of the transport layer specification that the remote device complies with
  556. Visibility: Expert
  557. Selected by: DeviceSelector
  558. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceTLVersionMajor" target="_blank">Basler Product Documentation</a> may provide more information.
  559. */
  560. Pylon::IIntegerEx& DeviceTLVersionMajor;
  561. //@}
  562. //! \name Categories: DeviceEnumeration
  563. //@{
  564. /*!
  565. \brief Minor version number of the transport layer specification that the remote device complies with
  566. Visibility: Expert
  567. Selected by: DeviceSelector
  568. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceTLVersionMinor" target="_blank">Basler Product Documentation</a> may provide more information.
  569. */
  570. Pylon::IIntegerEx& DeviceTLVersionMinor;
  571. //@}
  572. //! \name Categories: DeviceEnumeration
  573. //@{
  574. /*!
  575. \brief Updates the internal device list
  576. Visibility: Expert
  577. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceUpdateList" target="_blank">Basler Product Documentation</a> may provide more information.
  578. */
  579. Pylon::ICommandEx& DeviceUpdateList;
  580. //@}
  581. //! \name Categories: DeviceEnumeration
  582. //@{
  583. /*!
  584. \brief Timeout for the Device Update List command
  585. Visibility: Expert
  586. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceUpdateTimeout" target="_blank">Basler Product Documentation</a> may provide more information.
  587. */
  588. Pylon::IIntegerEx& DeviceUpdateTimeout;
  589. //@}
  590. //! \name Categories: DeviceEnumeration
  591. //@{
  592. /*!
  593. \brief User-settable ID of the remote device
  594. User-settable ID of the remote device. This value only changes when the Device Update List command is executed.
  595. Visibility: Expert
  596. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceUserID" target="_blank">Basler Product Documentation</a> may provide more information.
  597. */
  598. Pylon::IStringEx& DeviceUserID;
  599. //@}
  600. //! \name Categories: DeviceEnumeration
  601. //@{
  602. /*!
  603. \brief Name of the device vendor
  604. Name of the device vendor. This value only changes when the Device Update List command is executed.
  605. Visibility: Expert
  606. Selected by: DeviceSelector
  607. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=DeviceVendorName" target="_blank">Basler Product Documentation</a> may provide more information.
  608. */
  609. Pylon::IStringEx& DeviceVendorName;
  610. //@}
  611. //! \name Categories: EventDeviceListChangedData
  612. //@{
  613. /*!
  614. \brief Returns the unique identifier of the Device List Changed event
  615. Visibility: Expert
  616. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=EventDeviceListChanged" target="_blank">Basler Product Documentation</a> may provide more information.
  617. */
  618. Pylon::IIntegerEx& EventDeviceListChanged;
  619. //@}
  620. //! \name Categories: EventInterfaceLostData
  621. //@{
  622. /*!
  623. \brief Returns the unique identifier of the Interface Lost event
  624. Returns the unique identifier for the Interface Lost event.
  625. Visibility: Expert
  626. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=EventInterfaceLost" target="_blank">Basler Product Documentation</a> may provide more information.
  627. */
  628. Pylon::IIntegerEx& EventInterfaceLost;
  629. //@}
  630. //! \name Categories: EventControl
  631. //@{
  632. /*!
  633. \brief Activate or deactivate the notification to the host application of the occurrence of the selected Event
  634. Visibility: Expert
  635. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=EventNotification" target="_blank">Basler Product Documentation</a> may provide more information.
  636. */
  637. Pylon::IEnumParameterT<EventNotificationEnums>& EventNotification;
  638. //@}
  639. //! \name Categories: EventControl
  640. //@{
  641. /*!
  642. \brief Sets which event to signal to the host application
  643. Visibility: Expert
  644. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=EventSelector" target="_blank">Basler Product Documentation</a> may provide more information.
  645. */
  646. Pylon::IEnumParameterT<EventSelectorEnums>& EventSelector;
  647. //@}
  648. //! \name Categories: BoardSensors
  649. //@{
  650. /*!
  651. \brief Indicates whether an external power source has been detected
  652. Visibility: Beginner
  653. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=ExternalPowerPresent" target="_blank">Basler Product Documentation</a> may provide more information.
  654. */
  655. Pylon::IBooleanEx& ExternalPowerPresent;
  656. //@}
  657. //! \name Categories: BoardSensors
  658. //@{
  659. /*!
  660. \brief FPGA aux voltage
  661. Visibility: Beginner
  662. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=FpgaAuxVoltage" target="_blank">Basler Product Documentation</a> may provide more information.
  663. */
  664. Pylon::IFloatEx& FpgaAuxVoltage;
  665. //@}
  666. //! \name Categories: BoardSensors
  667. //@{
  668. /*!
  669. \brief FPGA BRAM voltage
  670. Visibility: Beginner
  671. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=FpgaBRamVoltage" target="_blank">Basler Product Documentation</a> may provide more information.
  672. */
  673. Pylon::IFloatEx& FpgaBRamVoltage;
  674. //@}
  675. //! \name Categories: BoardSensors
  676. //@{
  677. /*!
  678. \brief FPGA core temperature
  679. Visibility: Beginner
  680. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=FpgaCoreTemperature" target="_blank">Basler Product Documentation</a> may provide more information.
  681. */
  682. Pylon::IFloatEx& FpgaCoreTemperature;
  683. //@}
  684. //! \name Categories: BoardSensors
  685. //@{
  686. /*!
  687. \brief FPGA core voltage
  688. Visibility: Beginner
  689. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=FpgaCoreVoltage" target="_blank">Basler Product Documentation</a> may provide more information.
  690. */
  691. Pylon::IFloatEx& FpgaCoreVoltage;
  692. //@}
  693. //! \name Categories: DeviceEnumeration
  694. //@{
  695. /*!
  696. \brief Current IP address of the GVCP interface of the selected remote device
  697. Current IP address of the GVCP interface of the selected remote device. This value only changes on execution of the DeviceUpdateList command.
  698. Visibility: Expert
  699. Selected by: DeviceSelector
  700. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=GevDeviceIPAddress" target="_blank">Basler Product Documentation</a> may provide more information.
  701. */
  702. Pylon::IIntegerEx& GevDeviceIPAddress;
  703. //@}
  704. //! \name Categories: DeviceEnumeration
  705. //@{
  706. /*!
  707. \brief 48-bit MAC address of the GVCP interface of the selected remote device
  708. 48-bit MAC address of the GVCP interface of the selected remote device. This value only changes when the DeviceUpdateList command is executed.
  709. Visibility: Expert
  710. Selected by: DeviceSelector
  711. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=GevDeviceMACAddress" target="_blank">Basler Product Documentation</a> may provide more information.
  712. */
  713. Pylon::IIntegerEx& GevDeviceMACAddress;
  714. //@}
  715. //! \name Categories: DeviceEnumeration
  716. //@{
  717. /*!
  718. \brief Current subnet mask of the GVCP interface of the selected remote device
  719. Current subnet mask of the GVCP interface of the selected remote device. This value only changes on execution of the DeviceUpdateList command. This value only changes when the DeviceUpdateList command is executed.
  720. Visibility: Expert
  721. Selected by: DeviceSelector
  722. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=GevDeviceSubnetMask" target="_blank">Basler Product Documentation</a> may provide more information.
  723. */
  724. Pylon::IIntegerEx& GevDeviceSubnetMask;
  725. //@}
  726. //! \name Categories: InterfaceApplets
  727. //@{
  728. /*!
  729. \brief Sets the applet with which to initialize the interface
  730. Sets the applet with which to initialize the interface. Applets are specific DLLs used to initialize the frame grabber. Each applet has different characteristics and functionalities.
  731. Visibility: Beginner
  732. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceApplet" target="_blank">Basler Product Documentation</a> may provide more information.
  733. */
  734. Pylon::IEnumParameterT<InterfaceAppletEnums>& InterfaceApplet;
  735. //@}
  736. //! \name Categories: InterfaceApplets
  737. //@{
  738. /*!
  739. \brief Returns the status of the applet currently being loaded
  740. Returns the status of the applet currently being loaded. While the applet is loading, the status is Loading. When the loading is complete, this parameter displays the name of the applet loaded.
  741. Visibility: Beginner
  742. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceAppletStatus" target="_blank">Basler Product Documentation</a> may provide more information.
  743. */
  744. Pylon::IEnumParameterT<InterfaceAppletStatusEnums>& InterfaceAppletStatus;
  745. //@}
  746. //! \name Categories: InterfaceInformation
  747. //@{
  748. /*!
  749. \brief User-friendly name of the interface
  750. Visibility: Expert
  751. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceDisplayName" target="_blank">Basler Product Documentation</a> may provide more information.
  752. */
  753. Pylon::IStringEx& InterfaceDisplayName;
  754. //@}
  755. //! \name Categories: InterfaceInformation
  756. //@{
  757. /*!
  758. \brief Firmware version of the interface
  759. Visibility: Expert
  760. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceFirmwareVersion" target="_blank">Basler Product Documentation</a> may provide more information.
  761. */
  762. Pylon::IStringEx& InterfaceFirmwareVersion;
  763. //@}
  764. //! \name Categories: InterfaceInformation
  765. //@{
  766. /*!
  767. \brief GenTL Producer-wide unique ID of the selected interface
  768. Visibility: Expert
  769. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceID" target="_blank">Basler Product Documentation</a> may provide more information.
  770. */
  771. Pylon::IStringEx& InterfaceID;
  772. //@}
  773. //! \name Categories: InterfaceInformation
  774. //@{
  775. /*!
  776. \brief Major version number of the transport layer specification that the GenTL Producer interface complies with
  777. Major version number of the transport layer specification that the GenTL Producer interface complies with. The transport layer version of the interface should match the transport layer version of the device to assure compatibility.
  778. Visibility: Expert
  779. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceTLVersionMajor" target="_blank">Basler Product Documentation</a> may provide more information.
  780. */
  781. Pylon::IIntegerEx& InterfaceTLVersionMajor;
  782. //@}
  783. //! \name Categories: InterfaceInformation
  784. //@{
  785. /*!
  786. \brief Minor version number of the transport layer specification that the GenTL Producer interface complies with
  787. Minor version number of the transport layer specification that the GenTL Producer interface complies with. The transport layer version of the interface should match the transport layer version of the device to assure compatibility.
  788. Visibility: Expert
  789. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceTLVersionMinor" target="_blank">Basler Product Documentation</a> may provide more information.
  790. */
  791. Pylon::IIntegerEx& InterfaceTLVersionMinor;
  792. //@}
  793. //! \name Categories: InterfaceInformation
  794. //@{
  795. /*!
  796. \brief Sets the transport layer of the interface
  797. Visibility: Expert
  798. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=InterfaceType" target="_blank">Basler Product Documentation</a> may provide more information.
  799. */
  800. Pylon::IEnumParameterT<InterfaceTypeEnums>& InterfaceType;
  801. //@}
  802. //! \name Categories: BoardSensors
  803. //@{
  804. /*!
  805. \brief Temperature of the board power supply
  806. Visibility: Beginner
  807. The <a href="https://docs.baslerweb.com/?rhcsh=1&rhmapid=PowerSupplyTemperature" target="_blank">Basler Product Documentation</a> may provide more information.
  808. */
  809. Pylon::IFloatEx& PowerSupplyTemperature;
  810. //@}
  811. private:
  812. //! \cond HIDE_CLASS_METHODS
  813. //! not implemented copy constructor
  814. CUniversalInterfaceParams_Params_v6_3_0(CUniversalInterfaceParams_Params_v6_3_0&);
  815. //! not implemented assignment operator
  816. CUniversalInterfaceParams_Params_v6_3_0& operator=(CUniversalInterfaceParams_Params_v6_3_0&);
  817. //! \endcond
  818. };
  819. //! A parameter class containing all parameters as members that are available for pylon interfaces
  820. class CUniversalInterfaceParams_Params : public CUniversalInterfaceParams_Params_v6_3_0
  821. {
  822. //----------------------------------------------------------------------------------------------------------------
  823. // Implementation
  824. //----------------------------------------------------------------------------------------------------------------
  825. protected:
  826. // If you want to show the following methods in the help file
  827. // add the string HIDE_CLASS_METHODS to the ENABLED_SECTIONS tag in the doxygen file
  828. //! \cond HIDE_CLASS_METHODS
  829. //! Constructor
  830. CUniversalInterfaceParams_Params( void )
  831. {
  832. }
  833. //! Destructor
  834. ~CUniversalInterfaceParams_Params( void )
  835. {
  836. }
  837. //! Initializes the references
  838. void _Initialize( GENAPI_NAMESPACE::INodeMap* pNodeMap )
  839. {
  840. CUniversalInterfaceParams_Params_v6_3_0::_Initialize( pNodeMap );
  841. }
  842. //! \endcond
  843. };
  844. } // namespace Basler_UniversalInterfaceParams
  845. #endif // BASLER_PYLON_UNIVERSALINTERFACEPARAMS_H