Integer.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2006-2008 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 //-----------------------------------------------------------------------------
30 #ifndef GENAPI_INTEGER_H
31 #define GENAPI_INTEGER_H
32 
33 #include "../IInteger.h"
34 #include "Node.h"
35 #include "BaseT.h"
36 #include "ValueT.h"
37 #include "IntegerT.h"
38 #include "NodeT.h"
39 #include "PrivateTypes.h"
40 #include "PolyReference.h"
41 #include <map>
42 
43 namespace GENAPI_NAMESPACE
44 {
45 
51  : public IInteger
52  , public CNodeImpl
53  {
54  public:
55  //-------------------------------------------------------------
57 
58  CIntegerImpl();
61 
62  protected:
63  //-------------------------------------------------------------
65 
66  virtual EAccessMode InternalGetAccessMode() const;
68 
71  {
72  return intfIInteger;
73  }
74 
76 
77  protected:
78  //-------------------------------------------------------------
80 
81  virtual void InternalSetValue(int64_t Value, bool Verify = true);
83 
85  virtual int64_t InternalGetValue(bool Verify = false, bool IgnoreCache = false );
86 
88  virtual int64_t InternalGetMin();
89 
91  virtual int64_t InternalGetMax();
92 
94  virtual int64_t InternalGetInc();
95 
98 
101 
105  public:
106  //-------------------------------------------------------------
108 
109  virtual void FinalConstruct();
111 
113  virtual ECachingMode InternalGetCachingMode() const;
115 
116  virtual void SetInvalid(ESetInvalidMode simMode);
117 
118  public:
119 
120  virtual void SetProperty( CProperty &Property );
121  virtual bool GetProperty( CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList ) const;
122 
123 
124 
125  protected:
126  //-------------------------------------------------------------
128 
129  std::list<CIntegerPolyRef> m_ValuesCopy;
131 
133  std::list<CIntegerPolyRef>::iterator m_pMainValue;
134 
136  std::map<int64_t, CIntegerPolyRef> m_ValuesIndexed;
137 
140 
143 
146 
149 
152 
155 
158 
161 
163  };
164 
169  class CInteger : public BaseT< ValueT< IntegerT< NodeT < CIntegerImpl> > > >
170  {
171  };
172 
173 }
174 
175 #endif // GENAPI_INTEGER_H
Definition of the ValueT class template.
Core of the Integer node implementation.
Definition: Integer.h:50
virtual int64_t InternalGetValue(bool Verify=false, bool IgnoreCache=false)
Get feature value.
virtual int64_t InternalGetMax()
Get maximum value allowed.
std::list< CIntegerPolyRef >::iterator m_pMainValue
References to the main value inside m_ValuesCopy.
Definition: Integer.h:133
CIntegerPolyRef m_Min
Reference to the minimum value.
Definition: Integer.h:142
virtual const int64_autovector_t InternalGetListOfValidValues()
Get list of valid values.
virtual void InternalSetValue(int64_t Value, bool Verify=true)
Set feature value.
int64_autovector_impl m_ValidValueSet
The list of valid values for the integer.
Definition: Integer.h:160
CIntegerPolyRef m_Index
Reference to the index value.
Definition: Integer.h:151
__int64 int64_t
Definition: config-win32.h:21
virtual int64_t InternalGetInc()
Get increment.
virtual bool GetProperty(CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const
interface GENAPI_DECL_ABSTRACT IInteger
Interface for integer properties.
Definition: IInteger.h:61
CIntegerPolyRef m_Max
Reference to the maximum value.
Definition: Integer.h:145
Implementation of the IBase interface.
Definition: BaseT.h:48
Definition of the NodeT class template.
virtual void FinalConstruct()
finishes the constriction of the node
virtual EAccessMode InternalGetAccessMode() const
Get the access mode of the node.
enum GENAPI_NAMESPACE::_ERepresentation ERepresentation
recommended representation of a node value
virtual ECachingMode InternalGetCachingMode() const
Get Caching Mode.
enum GENAPI_NAMESPACE::_ECachingMode ECachingMode
caching mode of a register
Integer node implementation.
Definition: Integer.h:169
Vector of integers with reference counting.
Definition: Autovector.h:54
virtual int64_t InternalGetMin()
Get minimum value allowed.
interface GENAPI_DECL_ABSTRACT bool Verify
Definition: IBoolean.h:61
Definition of the IntegerT class template.
Definition of polymorphical smart pointer.
virtual void SetInvalid(ESetInvalidMode simMode)
CIntegerPolyRef m_ValueDefault
Reference to the default value which is used if the index has no matching entry.
Definition: Integer.h:139
Definition of the BaseT class template.
Standard implementation for the INode and the ISelector interface.
Definition: Node.h:85
A string class which is a clone of std::string.
Definition: GCString.h:52
std::list< CIntegerPolyRef > m_ValuesCopy
List storing the main value and the copy values.
Definition: Integer.h:130
enum GENAPI_NAMESPACE::_EAccessMode EAccessMode
access mode of a node
virtual ERepresentation InternalGetRepresentation()
Get recommended representation.
A reference to an int64 which can bei either an int64 variable, or a pointer to an IInteger...
Definition: PolyReference.h:68
virtual void SetProperty(CProperty &Property)
std::map< int64_t, CIntegerPolyRef > m_ValuesIndexed
Map storing the indexed values by index.
Definition: Integer.h:136
GENICAM_NAMESPACE::gcstring m_Unit
the physical unit name
Definition: Integer.h:157
CIntegerPolyRef m_Inc
Reference to the increment value.
Definition: Integer.h:148
ESetInvalidMode
Three different modes of operation for INodePrivate::SetInvalid()
Definition: INodePrivate.h:91
IInteger interface.
Definition: Types.h:193
virtual EInterfaceType InternalGetPrincipalInterfaceType() const
Implementation of IBase::GetPrincipalInterfaceType()
Definition: Integer.h:70
Common types used in the GenApi implementation.
ERepresentation m_Representation
recommended representation of the value
Definition: Integer.h:154
Part of the generic device API.
Definition: Autovector.h:48
enum GENAPI_NAMESPACE::_EInterfaceType EInterfaceType
typedef for interface type
virtual GENICAM_NAMESPACE::gcstring InternalGetUnit()
Get the unit.


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:54