IEnumeration.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 //-----------------------------------------------------------------------------
31 #ifndef GENAPI_IENUMERATION_H
32 #define GENAPI_IENUMERATION_H
33 
34 #include <Base/GCStringVector.h>
35 #include <GenApi/GenApiDll.h>
36 #include <GenApi/IEnumEntry.h>
37 #include <GenApi/Types.h>
38 #include <GenApi/IValue.h>
39 
40 #ifdef _MSC_VER
41 # pragma warning ( push )
42 # pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
43 #endif
44 
45 
46 namespace GENAPI_NAMESPACE
47 {
48  //*************************************************************
49  // Enumeration interface
50  //*************************************************************
51 
56  GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IEnumeration : virtual public IValue
57  {
58 
60  virtual void GetSymbolics(StringList_t & Symbolics) = 0;
61 
63  virtual void GetEntries(NodeList_t & Entries) = 0;
64 
66  virtual IEnumeration& operator=(const GENICAM_NAMESPACE::gcstring& ValueStr) = 0;
67 
69 
73  virtual void SetIntValue(int64_t Value, bool Verify = true) = 0;
74 
77 
79 
84  virtual int64_t GetIntValue(bool Verify = false, bool IgnoreCache = false) = 0;
85 
87  virtual IEnumEntry *GetEntryByName(const GENICAM_NAMESPACE::gcstring& Symbolic) = 0;
88 
90  virtual IEnumEntry *GetEntry(const int64_t IntValue) = 0;
91 
93  virtual IEnumEntry *GetCurrentEntry(bool Verify = false, bool IgnoreCache = false) = 0;
94 
95  };
96 
97 }
98 
99 #ifdef _MSC_VER
100 # pragma warning ( pop )
101 #endif
102 
103 #endif // ifndef GENAPI_IENUMERATION_H
#define GENICAM_INTERFACE
Definition: GenICamFwd.h:33
Common types used in the public GenApi interface.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT bool Verify
Definition: IBoolean.h:61
Portable string vector implementation.
virtual void operator=(bool Value)
Set node value.
Definition: IBoolean.h:64
__int64 int64_t
Definition: config-win32.h:21
virtual IEnumEntry * GetEntry(const int64_t IntValue)=0
Get an entry node by its IntValue.
virtual IEnumEntry * GetEntryByName(const GENICAM_NAMESPACE::gcstring &Symbolic)=0
Get an entry node by name.
node_vector NodeList_t
a list of node references
Definition: INode.h:55
virtual void GetEntries(NodeList_t &Entries)=0
Get list of entry nodes.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IEnumeration
Interface for enumeration properties.
Definition: IEnumeration.h:60
virtual int64_t GetIntValue(bool Verify=false, bool IgnoreCache=false)=0
Get integer node value.
virtual IEnumEntry * GetCurrentEntry(bool Verify=false, bool IgnoreCache=false)=0
Get the current entry.
virtual void SetIntValue(int64_t Value, bool Verify=true)=0
Set integer node value.
virtual GENICAM_NAMESPACE::gcstring operator*()=0
Get string node value.
A string class which is a clone of std::string.
Definition: GCString.h:52
declspec&#39;s to be used for GenApi Windows dll
GENICAM_NAMESPACE::gcstring_vector StringList_t
A list of strings.
Definition: Types.h:150
Definition of the interface IValue.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IEnumEntry
Interface of single enum value.
Definition: IEnumEntry.h:60
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