GenApi  3.5.1
Types.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2006 by Basler Vision Technologies
3 // Author: Fritz Dierks
4 //
5 // License: This file is published under the license of the EMVA GenICam Standard Group.
6 // A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
7 // If for some reason you are missing this file please contact the EMVA or visit the website
8 // (http://www.genicam.org) for a full copy.
9 //
10 // THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
11 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
12 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
13 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
14 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
15 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
16 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
17 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
18 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
19 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
20 // POSSIBILITY OF SUCH DAMAGE.
21 //
22 //-----------------------------------------------------------------------------
29 #ifndef GENAPI_TYPES_H
30 #define GENAPI_TYPES_H
31 
32 #include <Base/GCTypes.h>
33 #include <Base/GCStringVector.h>
34 #include <GenApi/GenApiDll.h>
35 #include <GenApi/Autovector.h>
36 #include <GenICamFwd.h>
37 
38 namespace GENAPI_NAMESPACE
39 {
40 
43  typedef enum _ESign
44  {
48  } ESign;
49 
52  typedef enum _EAccessMode
53  {
54  NI,
55  NA,
56  WO,
57  RO,
58  RW,
61  } EAccessMode;
62 
65  typedef enum _EVisibility
66  {
67  Beginner = 0,
68  Expert = 1,
69  Guru = 2,
70  Invisible = 3,
72  } EVisibility;
73 
76  typedef enum _ECachingMode
77  {
82  } ECachingMode;
83 
86  typedef enum _ERepresentation
87  {
95  _UndefinedRepresentation
97 
98 // this define is required to deal with a spelling error corrected in v1.2
99 #ifndef NO_UNDEFINEDED_REPRESENTATION
100 # define _UndefindedRepresentation _UndefinedRepresentation
101 #endif
102 
105  typedef enum _EEndianess
106  {
110  } EEndianess;
111 
112 
115  typedef enum _ENameSpace
116  {
120  } ENameSpace;
121 
122 
125  typedef enum _EStandardNameSpace
126  {
128  GEV,
130  CL,
131  USB,
134 
135 
138  typedef enum _EYesNo
139  {
140  Yes = 1,
141  No = 0,
143  } EYesNo;
144 
147  typedef GENICAM_NAMESPACE::gcstring_vector StringList_t;
148 
149 
152  typedef enum _ESlope
153  {
159  } ESlope;
160 
162 
163  typedef enum _EXMLValidation
165  {
166  xvLoad = 0x00000001L,
167  xvCycles = 0x00000002L,
168  xvSFNC = 0x00000004L,
169  xvDefault = 0x00000000L,
170  xvAll = 0xffffffffL,
172  } EXMLValidation;
173 
176  typedef enum _EDisplayNotation
177  {
183 
186  typedef enum _EInterfaceType
187  {
200  } EInterfaceType;
201 
203 
206  typedef enum _ELinkType
207  {
215  } ELinkType;
216 
219  typedef enum _EIncMode
220  {
221  noIncrement, // !> The feature has no increment
222  fixedIncrement, // !> The feature has a fix increment
223  listIncrement // !> The feature has a list of valid value
224  } EIncMode;
225 
228  typedef enum _EInputDirection
229  {
233  } EInputDirection;
234 
237  {
238  v1_0 = 1,
239  v1_1 = 2,
242 
246  {
247  csmOff = 0,
251 
252 }
253 
254 #endif // ifndef GENAPI_TYPES_H
the notation is scientific, e.g. 1.234e2
Definition: Types.h:180
_ESign
Definition: Types.h:43
enum GENAPI_NAMESPACE::_EIncMode EIncMode
slope is determined automatically by probing the function
Definition: Types.h:157
Object is not yet initialized.
Definition: Types.h:119
Register is little endian.
Definition: Types.h:108
SwissKnife is not used within a converter.
Definition: Types.h:232
Object is not yet initialized.
Definition: Types.h:71
IP-Address.
Definition: Types.h:93
IRegister interface.
Definition: Types.h:195
Indicates suppression is active.
Definition: Types.h:248
name resides in custom namespace
Definition: Types.h:127
strictly monotonous decreasing
Definition: Types.h:155
_EGenApiSchemaVersion
GenApi schema version.
Definition: Types.h:236
_EEndianess
Definition: Types.h:105
checks performed if nothing else is said
Definition: Types.h:169
Object is not yet initialized.
Definition: Types.h:181
All indirectly connected terminal nodes.
Definition: Types.h:213
_EIncMode
Definition: Types.h:219
enum GENAPI_NAMESPACE::_ESign ESign
slope changes, e.g. at run-time
Definition: Types.h:156
Portable string vector implementation.
GENICAM_NAMESPACE::gcstring_vector StringList_t
Definition: Types.h:147
enum GENAPI_NAMESPACE::_EGenApiSchemaVersion EGenApiSchemaVersion
GenApi schema version.
_EStandardNameSpace
Definition: Types.h:125
enum GENAPI_NAMESPACE::_ENameSpace ENameSpace
Object is not yet initialized.
Definition: Types.h:142
Indicates schema version 1.0.
Definition: Types.h:238
_ECallbackSuppressMode
Definition: Types.h:245
name resides in 1394 IIDC namespace
Definition: Types.h:129
_EXMLValidation
typedef describing the different validity checks which can be performed on an XML file ...
Definition: Types.h:164
enum GENAPI_NAMESPACE::_ERepresentation ERepresentation
enum GENAPI_NAMESPACE::_EXMLValidation EXMLValidation
typedef describing the different validity checks which can be performed on an XML file ...
enum GENAPI_NAMESPACE::_ESlope ESlope
_EInterfaceType
Definition: Types.h:186
Write Only.
Definition: Types.h:56
_ERepresentation
Definition: Types.h:86
enum GENAPI_NAMESPACE::_EYesNo EYesNo
Visible for Gurus.
Definition: Types.h:69
_EYesNo
Definition: Types.h:138
Creates a dummy node map.
Definition: Types.h:166
used internally for AccessMode cycle detection
Definition: Types.h:60
enum GENAPI_NAMESPACE::_EEndianess EEndianess
This file contains the public definition of the autovector classes.
All child node used to compute the value.
Definition: Types.h:214
enum GENAPI_NAMESPACE::_ELinkType ELinkType
typedef for link type
_ENameSpace
Definition: Types.h:115
IEnumeration interface.
Definition: Types.h:197
IInteger interface.
Definition: Types.h:190
no
Definition: Types.h:141
enum GENAPI_NAMESPACE::_ECachingMode ECachingMode
Do not use cache.
Definition: Types.h:78
enum GENAPI_NAMESPACE::_EVisibility EVisibility
Indicates a swiss knife that it is used as worker for a converter computing FROM. ...
Definition: Types.h:230
Indicates suppression is used once.
Definition: Types.h:249
Object is not yet initialized.
Definition: Types.h:109
Indicates suppression is turned off.
Definition: Types.h:247
_EInputDirection
Definition: Types.h:228
name resides in GigE Vision namespace
Definition: Types.h:128
Not Visible.
Definition: Types.h:70
IPort interface.
Definition: Types.h:199
MAC-Address.
Definition: Types.h:94
_EAccessMode
Definition: Types.h:52
IString interface.
Definition: Types.h:194
enum GENAPI_NAMESPACE::_EAccessMode EAccessMode
IBoolean interface.
Definition: Types.h:191
the notation is fixed, e.g. 123.4
Definition: Types.h:179
Write to cache and register.
Definition: Types.h:79
Write to register, write to cache on read.
Definition: Types.h:80
enum GENAPI_NAMESPACE::_EInputDirection EInputDirection
enum GENAPI_NAMESPACE::_EStandardNameSpace EStandardNameSpace
Integer is unsigned.
Definition: Types.h:46
ICommand interface.
Definition: Types.h:192
Read and Write.
Definition: Types.h:58
Visible for experts or Gurus.
Definition: Types.h:68
_ESlope
Definition: Types.h:152
Read Only.
Definition: Types.h:57
the notation if either scientific or fixed depending on what is shorter
Definition: Types.h:178
All nodes for which this node is at least an invalidating child.
Definition: Types.h:208
Object is not yet initialized.
Definition: Types.h:132
Not available.
Definition: Types.h:55
Object is not yet initialized.
Definition: Types.h:59
name resides in USB namespace
Definition: Types.h:131
Not yet initialized.
Definition: Types.h:81
Forward declarations for GenICam types.
yes
Definition: Types.h:140
Always visible.
Definition: Types.h:67
enum GENAPI_NAMESPACE::_EInterfaceType EInterfaceType
Integer is signed.
Definition: Types.h:45
all possible checks
Definition: Types.h:170
Register is big endian.
Definition: Types.h:107
IEnumEntry interface.
Definition: Types.h:198
checks for conformance with the standard feature naming convention (SFNC)
Definition: Types.h:168
name resides in one of the standard namespaces
Definition: Types.h:118
Slider with logarithmic behaviour.
Definition: Types.h:89
IBase interface.
Definition: Types.h:189
name resides in camera link namespace
Definition: Types.h:130
Indicates undefined version.
Definition: Types.h:240
checks for write and dependency cycles (implies xvLoad)
Definition: Types.h:167
All directly connected nodes which invalidate this node.
Definition: Types.h:211
All directly or indirectly connected nodes which are invalidated by this nodes (i.e. which are dependent on this node)
Definition: Types.h:212
_ELinkType
typedef for link type
Definition: Types.h:206
ICategory interface.
Definition: Types.h:196
Hex number in an edit control.
Definition: Types.h:92
_EVisibility
Definition: Types.h:65
All nodes which can be read from.
Definition: Types.h:209
IValue interface.
Definition: Types.h:188
declspec&#39;s to be used for GenApi Windows dll
All nodes which can write a value further down the node stack.
Definition: Types.h:210
IFloat interface.
Definition: Types.h:193
strictly monotonous increasing
Definition: Types.h:154
Object is not yet initialized.
Definition: Types.h:158
_ECachingMode
Definition: Types.h:76
_EDisplayNotation
Definition: Types.h:176
Decimal number in an edit control.
Definition: Types.h:91
enum GENAPI_NAMESPACE::_EDisplayNotation EDisplayNotation
Slider with linear behavior.
Definition: Types.h:88
Indicates schema version 1.1.
Definition: Types.h:239
Not implemented.
Definition: Types.h:54
Object is not yet initialized.
Definition: Types.h:171
name resides in custom namespace
Definition: Types.h:117
Definition: ChunkAdapter.h:37
Object is not yet initialized.
Definition: Types.h:47
enum GENAPI_NAMESPACE::_ECallbackSuppressMode ECallbackSuppressMode
Check box.
Definition: Types.h:90
Platform-dependent type definitions.
Indicates a swiss knife that it is used as worker for a converter computing TO.
Definition: Types.h:231