All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SelectorSet.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2010 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 //-----------------------------------------------------------------------------
29 #ifndef GENAPI_SELECTORSET_H
30 #define GENAPI_SELECTORSET_H
31 
32 #include <GenApi/GenApiDll.h>
33 #include <GenApi/ISelectorDigit.h>
34 #include <GenApi/IBase.h>
35 #include <GenApi/Pointer.h>
36 
37 namespace GENAPI_NAMESPACE
38 {
39 
42  {
43  public:
45  CSelectorSet (
46  IBase *pBase
47  );
48 
50  virtual ~CSelectorSet();
51  private:
52  CSelectorSet(const CSelectorSet&); // copy constructor not implemented
53  CSelectorSet& operator=(const CSelectorSet&); // assignment operator is not implemented
54  public:
56  bool IsEmpty();
57 
58 
59  // Implementation of ISelectorDigit
60  public:
61  virtual bool SetFirst();
62  virtual bool SetNext(bool Tick = true);
63  virtual void Restore();
65  virtual void GetState(CSelectorState &state);
66  virtual void GetSelectorList( GENAPI_NAMESPACE::FeatureList_t &SelectorList, bool Incremental = false );
67 
68  private:
69  struct SelectorIteratorList_t;
71  SelectorIteratorList_t *m_pSelectorIterators;
74 
76  void ExploreSelector(
77  CNodePtr &ptrNode,
78  NodeList_t &SelectorNodes
79  );
80 
82  void Create(
83  IBase* pBase
84  );
85  };
86 
87 }
88 #endif
89 
GENAPI_NAMESPACE::ToString
virtual GENICAM_NAMESPACE::gcstring ToString()=0
Returns a string representation of the digit.
GENAPI_NAMESPACE
Lexical analyzer for CIntSwissKnife.
Definition: Destructible.h:30
Pointer.h
Definition of template CPointer.
GENAPI_NAMESPACE::CSelectorSet
The set of selectors selecting a given node.
Definition: SelectorSet.h:41
GENAPI_NAMESPACE::Restore
virtual void Restore()=0
Restores the selectors' values found at creation.
GENAPI_NAMESPACE::CSelectorSet::m_pSelectorIterators
SelectorIteratorList_t * m_pSelectorIterators
List of selector digits.
Definition: SelectorSet.h:69
IBase.h
Definition of interface IBase.
GENICAM_NAMESPACE::gcstring
A string class which is a clone of std::string.
Definition: GCString.h:52
GENAPI_DECL
#define GENAPI_DECL
Definition: GenApiDll.h:55
GENAPI_NAMESPACE::CSelectorState
Definition: SelectorState.h:38
GENAPI_NAMESPACE::ISelectorDigit
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT ISelectorDigit
Interface of a "digit" of the "counter" formed by the selector set.
Definition: ISelectorDigit.h:43
ISelectorDigit.h
GENAPI_NAMESPACE::GetSelectorList
virtual void GetSelectorList(GENAPI_NAMESPACE::FeatureList_t &SelectorList, bool Incremental=false)=0
Retrieves an ordered list of selectors.
GENAPI_NAMESPACE::CPointer< INode >
GENAPI_NAMESPACE::SetNext
virtual bool SetNext(bool Tick=true)=0
Sets digit to next value.
GENAPI_NAMESPACE::GetState
virtual void GetState(CSelectorState &state)=0
Get the state of the selector.
GENAPI_NAMESPACE::CSelectorSet::m_blockEnd
GENICAM_NAMESPACE::gcstring m_blockEnd
Definition: SelectorSet.h:73
GENAPI_NAMESPACE::operator=
virtual IBoolean & operator=(bool Value)
Set node value.
Definition: IBoolean.h:64
GenApiDll.h
declspec's to be used for GenApi Windows dll
GENAPI_NAMESPACE::CSelectorSet::m_blockStart
GENICAM_NAMESPACE::gcstring m_blockStart
Definition: SelectorSet.h:72
GENAPI_NAMESPACE::IBase
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IBase
Base interface common to all nodes.
Definition: IBase.h:55
GENAPI_NAMESPACE::NodeList_t
node_vector NodeList_t
a list of node references
Definition: INode.h:55


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:12