_GigETLParams.h 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. //-----------------------------------------------------------------------------
  2. // Copyright (c) 2004-2021 Basler AG
  3. // Section: Vision Components
  4. // Project: GenApi
  5. //-----------------------------------------------------------------------------
  6. /*!
  7. \file
  8. \brief Interface to the GigE transport layer specific parameters
  9. */
  10. //-----------------------------------------------------------------------------
  11. // This file is generated automatically
  12. // Do not modify!
  13. //-----------------------------------------------------------------------------
  14. #ifndef Basler_GigETLParams_PARAMS_H
  15. #define Basler_GigETLParams_PARAMS_H
  16. #include <GenApi/IEnumerationT.h>
  17. #include <GenApi/NodeMapRef.h>
  18. #include <GenApi/DLLLoad.h>
  19. // common node types
  20. #include <GenApi/IBoolean.h>
  21. #include <GenApi/ICategory.h>
  22. #include <GenApi/ICommand.h>
  23. #include <GenApi/IEnumeration.h>
  24. #include <GenApi/IEnumEntry.h>
  25. #include <GenApi/IFloat.h>
  26. #include <GenApi/IInteger.h>
  27. #include <GenApi/IString.h>
  28. #include <GenApi/IRegister.h>
  29. #ifdef __GNUC__
  30. # undef GCC_VERSION
  31. # define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
  32. # undef GCC_DIAGNOSTIC_AWARE
  33. # define GCC_DIAGNOSTIC_AWARE (GCC_VERSION >= 40200)
  34. # undef GCC_DIAGNOSTIC_PUSH_POP_AWARE
  35. # define GCC_DIAGNOSTIC_PUSH_POP_AWARE (GCC_VERSION >= 40600)
  36. #else
  37. # undef GCC_DIAGNOSTIC_AWARE
  38. # define GCC_DIAGNOSTIC_AWARE 0
  39. #endif
  40. #ifdef __GNUC__
  41. // GCC_DIAGNOSTIC_AWARE ensures that the internal deprecated warnings can be ignored by gcc.
  42. // As a result older gcc will not generate warnings about really used deprecated features.
  43. # if GCC_DIAGNOSTIC_AWARE
  44. # define GENAPI_DEPRECATED_FEATURE __attribute__((deprecated))
  45. # else
  46. # define GENAPI_DEPRECATED_FEATURE
  47. # endif
  48. #elif defined(_MSC_VER)
  49. # define GENAPI_DEPRECATED_FEATURE __declspec(deprecated)
  50. #else
  51. # define GENAPI_DEPRECATED_FEATURE
  52. #endif
  53. #if GCC_DIAGNOSTIC_AWARE
  54. # if GCC_DIAGNOSTIC_PUSH_POP_AWARE
  55. # pragma GCC diagnostic push
  56. # endif
  57. # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  58. #endif
  59. //! The namespace containing the device's control interface and related enumeration types
  60. namespace Basler_GigETLParams
  61. {
  62. //**************************************************************************************************
  63. // Enumerations
  64. //**************************************************************************************************
  65. //**************************************************************************************************
  66. // Parameter class
  67. //**************************************************************************************************
  68. //! Interface to the GigE transport layer specific parameters
  69. class CGigETLParams_Params
  70. {
  71. //----------------------------------------------------------------------------------------------------------------
  72. // Implementation
  73. //----------------------------------------------------------------------------------------------------------------
  74. protected:
  75. // If you want to show the following methods in the help file
  76. // add the string HIDE_CLASS_METHODS to the ENABLED_SECTIONS tag in the doxygen file
  77. //! \cond HIDE_CLASS_METHODS
  78. //! Constructor
  79. CGigETLParams_Params( void );
  80. //! Destructor
  81. ~CGigETLParams_Params( void );
  82. //! Initializes the references
  83. void _Initialize( GENAPI_NAMESPACE::INodeMap* );
  84. //! Return the vendor of the camera
  85. const char* _GetVendorName( void );
  86. //! Returns the camera model name
  87. const char* _GetModelName( void );
  88. //! \endcond
  89. //----------------------------------------------------------------------------------------------------------------
  90. // References to features
  91. //----------------------------------------------------------------------------------------------------------------
  92. public:
  93. //! \name Root - Transport layer-specific parameter
  94. //@{
  95. /*!
  96. \brief Read access timeout value in milliseconds.
  97. \b Visibility = Beginner
  98. */
  99. GENAPI_NAMESPACE::IInteger& ReadTimeout;
  100. //@}
  101. //! \name Root - Transport layer-specific parameter
  102. //@{
  103. /*!
  104. \brief Write access timeout in milliseconds.
  105. \b Visibility = Beginner
  106. */
  107. GENAPI_NAMESPACE::IInteger& WriteTimeout;
  108. //@}
  109. //! \name Root - Transport layer-specific parameter
  110. //@{
  111. /*!
  112. \brief Maximum number of retries for read operations after a read operation has timed out.
  113. \b Visibility = Guru
  114. */
  115. GENAPI_NAMESPACE::IInteger& MaxRetryCountRead;
  116. //@}
  117. //! \name Root - Transport layer-specific parameter
  118. //@{
  119. /*!
  120. \brief Maximum number of retries for write operations after a write operation has timed out.
  121. \b Visibility = Guru
  122. */
  123. GENAPI_NAMESPACE::IInteger& MaxRetryCountWrite;
  124. //@}
  125. //! \name Root - Transport layer-specific parameter
  126. //@{
  127. /*!
  128. \brief Heartbeat timeout value on the host side in milliseconds.
  129. \b Visibility = Beginner
  130. */
  131. GENAPI_NAMESPACE::IInteger& HeartbeatTimeout;
  132. //@}
  133. //! \name Root - Transport layer-specific parameter
  134. //@{
  135. /*!
  136. \brief Enables sending all commands and receiving all acknowledges twice.
  137. Enables sending all commands and receiving all acknowledges twice. This option should only be enabled in case of network problems.
  138. \b Visibility = Guru
  139. */
  140. GENAPI_NAMESPACE::IBoolean& CommandDuplicationEnable;
  141. //@}
  142. //! \name Root - Transport layer-specific parameter
  143. //@{
  144. /*!
  145. \brief Number of timeouts during read and write operations when waiting for a response from the device.
  146. \b Visibility = Guru
  147. */
  148. GENAPI_NAMESPACE::IInteger& StatisticReadWriteTimeoutCount;
  149. //@}
  150. //! \name Root - Transport layer-specific parameter
  151. //@{
  152. /*!
  153. \brief Migration Mode Enable
  154. Enables mapping of certain SFNC 1.x node names to SFNC 2.x node names
  155. \b Visibility = Guru
  156. */
  157. GENAPI_NAMESPACE::IBoolean& MigrationModeEnable;
  158. //@}
  159. private:
  160. //! \cond HIDE_CLASS_METHODS
  161. //! not implemented copy constructor
  162. CGigETLParams_Params( CGigETLParams_Params& );
  163. //! not implemented assignment operator
  164. CGigETLParams_Params& operator=( CGigETLParams_Params& );
  165. //! \endcond
  166. };
  167. //**************************************************************************************************
  168. // Parameter class implementation
  169. //**************************************************************************************************
  170. //! \cond HIDE_CLASS_METHODS
  171. inline CGigETLParams_Params::CGigETLParams_Params( void )
  172. : ReadTimeout( *new GENAPI_NAMESPACE::CIntegerRef() )
  173. , WriteTimeout( *new GENAPI_NAMESPACE::CIntegerRef() )
  174. , MaxRetryCountRead( *new GENAPI_NAMESPACE::CIntegerRef() )
  175. , MaxRetryCountWrite( *new GENAPI_NAMESPACE::CIntegerRef() )
  176. , HeartbeatTimeout( *new GENAPI_NAMESPACE::CIntegerRef() )
  177. , CommandDuplicationEnable( *new GENAPI_NAMESPACE::CBooleanRef() )
  178. , StatisticReadWriteTimeoutCount( *new GENAPI_NAMESPACE::CIntegerRef() )
  179. , MigrationModeEnable( *new GENAPI_NAMESPACE::CBooleanRef() )
  180. {
  181. }
  182. inline CGigETLParams_Params::~CGigETLParams_Params( void )
  183. {
  184. delete static_cast <GENAPI_NAMESPACE::CIntegerRef*> (&ReadTimeout);
  185. delete static_cast <GENAPI_NAMESPACE::CIntegerRef*> (&WriteTimeout);
  186. delete static_cast <GENAPI_NAMESPACE::CIntegerRef*> (&MaxRetryCountRead);
  187. delete static_cast <GENAPI_NAMESPACE::CIntegerRef*> (&MaxRetryCountWrite);
  188. delete static_cast <GENAPI_NAMESPACE::CIntegerRef*> (&HeartbeatTimeout);
  189. delete static_cast <GENAPI_NAMESPACE::CBooleanRef*> (&CommandDuplicationEnable);
  190. delete static_cast <GENAPI_NAMESPACE::CIntegerRef*> (&StatisticReadWriteTimeoutCount);
  191. delete static_cast <GENAPI_NAMESPACE::CBooleanRef*> (&MigrationModeEnable);
  192. }
  193. inline void CGigETLParams_Params::_Initialize( GENAPI_NAMESPACE::INodeMap* _Ptr )
  194. {
  195. static_cast<GENAPI_NAMESPACE::CIntegerRef*> (&ReadTimeout)->SetReference( _Ptr->GetNode( "ReadTimeout" ) );
  196. static_cast<GENAPI_NAMESPACE::CIntegerRef*> (&WriteTimeout)->SetReference( _Ptr->GetNode( "WriteTimeout" ) );
  197. static_cast<GENAPI_NAMESPACE::CIntegerRef*> (&MaxRetryCountRead)->SetReference( _Ptr->GetNode( "MaxRetryCountRead" ) );
  198. static_cast<GENAPI_NAMESPACE::CIntegerRef*> (&MaxRetryCountWrite)->SetReference( _Ptr->GetNode( "MaxRetryCountWrite" ) );
  199. static_cast<GENAPI_NAMESPACE::CIntegerRef*> (&HeartbeatTimeout)->SetReference( _Ptr->GetNode( "HeartbeatTimeout" ) );
  200. static_cast<GENAPI_NAMESPACE::CBooleanRef*> (&CommandDuplicationEnable)->SetReference( _Ptr->GetNode( "CommandDuplicationEnable" ) );
  201. static_cast<GENAPI_NAMESPACE::CIntegerRef*> (&StatisticReadWriteTimeoutCount)->SetReference( _Ptr->GetNode( "StatisticReadWriteTimeoutCount" ) );
  202. static_cast<GENAPI_NAMESPACE::CBooleanRef*> (&MigrationModeEnable)->SetReference( _Ptr->GetNode( "MigrationModeEnable" ) );
  203. }
  204. inline const char* CGigETLParams_Params::_GetVendorName( void )
  205. {
  206. return "Basler";
  207. }
  208. inline const char* CGigETLParams_Params::_GetModelName( void )
  209. {
  210. return "GigETLParams";
  211. }
  212. //! \endcond
  213. } // namespace Basler_GigETLParams
  214. #if GCC_DIAGNOSTIC_AWARE
  215. # if GCC_DIAGNOSTIC_PUSH_POP_AWARE
  216. # pragma GCC diagnostic pop
  217. # else
  218. # pragma GCC diagnostic warning "-Wdeprecated-declarations"
  219. # endif
  220. #endif
  221. #undef GENAPI_DEPRECATED_FEATURE
  222. #endif // Basler_GigETLParams_PARAMS_H