IBoolean.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. //-----------------------------------------------------------------------------
  2. // (c) 2006 by Basler Vision Technologies
  3. // Section: Vision Components
  4. // Project: GenApi
  5. // Author: Margret Albrecht
  6. // $Header$
  7. //
  8. // License: This file is published under the license of the EMVA GenICam Standard Group.
  9. // A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
  10. // If for some reason you are missing this file please contact the EMVA or visit the website
  11. // (http://www.genicam.org) for a full copy.
  12. //
  13. // THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
  14. // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15. // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16. // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
  17. // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18. // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19. // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  20. // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  21. // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22. // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23. // POSSIBILITY OF SUCH DAMAGE.
  24. //-----------------------------------------------------------------------------
  25. /*!
  26. \file
  27. \brief Definition of IBoolean interface
  28. \ingroup GenApi_PublicInterface
  29. */
  30. #ifndef GENAPI_IBOOLEAN_H
  31. #define GENAPI_IBOOLEAN_H
  32. #include <GenApi/GenApiDll.h>
  33. #include <GenApi/Types.h>
  34. #include <GenApi/IValue.h>
  35. #pragma warning ( push )
  36. #pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
  37. namespace GENAPI_NAMESPACE
  38. {
  39. //*************************************************************
  40. // IBoolean interface
  41. //*************************************************************
  42. /**
  43. \brief Interface for Boolean properties
  44. \ingroup GenApi_PublicInterface
  45. */
  46. interface GENAPI_DECL_ABSTRACT IBoolean : virtual public IValue
  47. {
  48. public:
  49. //! Set node value
  50. /*!
  51. \param Value The value to set
  52. \param Verify Enables AccessMode and Range verification (default = true)
  53. */
  54. virtual void SetValue(bool Value, bool Verify = true) = 0;
  55. //! Set node value
  56. virtual void operator=(bool Value){ SetValue( Value ); }
  57. //! Get node value
  58. /*!
  59. \param Verify Enables Range verification (default = false). The AccessMode is always checked
  60. \param IgnoreCache If true the value is read ignoring any caches (default = false)
  61. \return The value read
  62. */
  63. virtual bool GetValue(bool Verify = false, bool IgnoreCache = false) const = 0;
  64. //! Get node value
  65. virtual bool operator()() const { return GetValue(); }
  66. };
  67. //*************************************************************
  68. // CBooleanRef class
  69. //*************************************************************
  70. #ifndef DOXYGEN_IGNORE
  71. /**
  72. \internal
  73. \brief Reference to an IInteger pointer
  74. \ingroup GenApi_PublicImpl
  75. */
  76. template <class T>
  77. class CBooleanRefT : public CValueRefT<T>
  78. {
  79. typedef CValueRefT<T> ref;
  80. public:
  81. /*--------------------------------------------------------*/
  82. // IBoolean
  83. /*--------------------------------------------------------*/
  84. //! Set node value
  85. virtual void SetValue(bool Value, bool Verify = true)
  86. {
  87. if(ref::m_Ptr)
  88. return ref::m_Ptr->SetValue(Value, Verify);
  89. else
  90. throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
  91. // unused param *JS* (removed warning)
  92. GC_UNUSED(Verify);
  93. }
  94. //! Set node value
  95. virtual void operator=(bool Value)
  96. {
  97. if(ref::m_Ptr)
  98. return ref::m_Ptr->operator=(Value);
  99. else
  100. throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
  101. }
  102. //! Get node value
  103. virtual bool GetValue(bool Verify = false, bool IgnoreCache = false) const
  104. {
  105. if(ref::m_Ptr)
  106. return ref::m_Ptr->GetValue(Verify, IgnoreCache);
  107. else
  108. throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
  109. }
  110. //! Get node value
  111. virtual bool operator()() const
  112. {
  113. if(ref::m_Ptr)
  114. return ref::m_Ptr->operator()();
  115. else
  116. throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
  117. }
  118. };
  119. //! Reference to an IBoolean pointer
  120. //! \ingroup GenApi_PublicImpl
  121. typedef CBooleanRefT<IBoolean> CBooleanRef;
  122. #endif
  123. }
  124. #pragma warning ( pop )
  125. #endif // ifndef GENAPI_IBOOLEAN_H