ICategory.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2006 by Basler Vision Technologies
3 // Section: Vision Components
4 // Project: GenApi
5 // Author: Fritz Dierks
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 //-----------------------------------------------------------------------------
32 #ifndef GENAPI_ICATEGORY_H
33 #define GENAPI_ICATEGORY_H
34 
35 #include <Base/GCString.h>
36 #include <GenApi/GenApiDll.h>
37 #include <GenApi/Types.h>
38 #include <GenApi/IValue.h>
39 #include <GenApi/Container.h>
40 
41 #include <assert.h>
42 
43 #ifdef _MSC_VER
44 # pragma warning ( push )
45 # pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
46 #endif
47 
48 namespace GENAPI_NAMESPACE
49 {
50 
52 
53 
54  //*************************************************************
55  // ICategory interface
56  //*************************************************************
57 
62  GENICAM_INTERFACE GENAPI_DECL_ABSTRACT ICategory : virtual public IValue
63  {
64 
66  virtual void GetFeatures(FeatureList_t &Features) const = 0;
67 
68  };
69 
70 
71  //*************************************************************
72  // CCategoryRef class
73  //*************************************************************
74 
75 #ifndef DOXYGEN_IGNORE
76 
82  template <class T>
83  class CCategoryRefT : public CValueRefT<T>
84  {
85  typedef CValueRefT<T> ref;
86 
87  public:
88  /*--------------------------------------------------------*/
89  // ICategory
90  /*--------------------------------------------------------*/
91 
93  virtual void GetFeatures(FeatureList_t &Features) const
94  {
95  if(ref::m_Ptr)
96  return ref::m_Ptr->GetFeatures(Features);
97  else
98  throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
99  }
100 
101  };
102 
106 
107 #endif
108 
109 }
110 
111 #ifdef _MSC_VER
112 # pragma warning ( pop )
113 #endif
114 
115 #endif // ifndef GENAPI_ICATEGORY_H
#define GENICAM_INTERFACE
Definition: GenICamFwd.h:33
Common types used in the public GenApi interface.
virtual void GetFeatures(FeatureList_t &Features) const
Get all features of the category (including sub-categories)
Definition: ICategory.h:93
#define ACCESS_EXCEPTION
Fires a access exception, e.g. throw ACCESS_EXCEPTION("Not everybody")
Definition: GCException.h:253
T * m_Ptr
Pointer to the implementation the reference references to.
Definition: Reference.h:101
CCategoryRefT< ICategory > CCategoryRef
Reference to an ICategory pointer.
Definition: ICategory.h:105
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT ICategory
Gives access to a category node.
Definition: ICategory.h:66
Portable string implementation.
declspec&#39;s to be used for GenApi Windows dll
GENICAM_INTERFACE INode
Interface common to all nodes.
Definition: ICategory.h:51
Portable container classes for INode & IValue pointers.
Definition of the interface IValue.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IValue
Interface for value properties.
Definition: IValue.h:61
Lexical analyzer for CIntSwissKnife.
Definition: Autovector.h:48


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Mar 17 2021 02:48:40