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
38namespace GENAPI_NAMESPACE
39{
40
43 typedef enum _ESign
44 {
48 } ESign;
49
62
65 typedef enum _EVisibility
66 {
68 Expert = 1,
69 Guru = 2,
72 } EVisibility;
73
83
86 typedef enum _ERepresentation
87 {
95 _UndefinedRepresentation
96 } ERepresentation;
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
134
135
138 typedef enum _EYesNo
139 {
140 Yes = 1,
141 No = 0,
142 _UndefinedYesNo = 2
143 } EYesNo;
144
147 typedef GENICAM_NAMESPACE::gcstring_vector StringList_t;
148
149
160
162
164 typedef enum _EXMLValidation
165 {
166 xvLoad = 0x00000001L,
167 xvCycles = 0x00000002L,
168 xvSFNC = 0x00000004L,
169 xvDefault = 0x00000000L,
170 xvAll = 0xffffffffL,
171 _UndefinedEXMLValidation = 0x8000000L
172 } EXMLValidation;
173
183
201
203
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 {
232 idNone
233 } EInputDirection;
234
237 {
238 v1_0 = 1,
239 v1_1 = 2,
240 _Undefined = -1
241 } EGenApiSchemaVersion;
242
246 {
247 csmOff = 0,
249 csmOnce
250 } ECallbackSuppressMode;
251
252}
253
254#endif // ifndef GENAPI_TYPES_H
This file contains the public definition of the autovector classes.
Portable string vector implementation.
Platform-dependent type definitions.
declspec's to be used for GenApi Windows dll
Forward declarations for GenICam types.
_EGenApiSchemaVersion
GenApi schema version.
Definition Types.h:237
@ v1_1
Indicates schema version 1.1.
Definition Types.h:239
@ _Undefined
Indicates undefined version.
Definition Types.h:240
@ v1_0
Indicates schema version 1.0.
Definition Types.h:238
_ESlope
Definition Types.h:153
GENICAM_NAMESPACE::gcstring_vector StringList_t
Definition Types.h:147
_EIncMode
Definition Types.h:220
_ECallbackSuppressMode
Definition Types.h:246
_EDisplayNotation
Definition Types.h:177
_ELinkType
typedef for link type
Definition Types.h:207
_EInputDirection
Definition Types.h:229
_EXMLValidation
typedef describing the different validity checks which can be performed on an XML file
Definition Types.h:165
_EInterfaceType
Definition Types.h:187
@ Decreasing
strictly monotonous decreasing
Definition Types.h:155
@ _UndefinedESlope
Object is not yet initialized.
Definition Types.h:158
@ Automatic
slope is determined automatically by probing the function
Definition Types.h:157
@ Increasing
strictly monotonous increasing
Definition Types.h:154
@ Varying
slope changes, e.g. at run-time
Definition Types.h:156
@ csmOnce
Indicates suppression is used once.
Definition Types.h:249
@ csmOff
Indicates suppression is turned off.
Definition Types.h:247
@ csmActive
Indicates suppression is active.
Definition Types.h:248
@ fnScientific
the notation is scientific, e.g. 1.234e2
Definition Types.h:180
@ fnFixed
the notation is fixed, e.g. 123.4
Definition Types.h:179
@ fnAutomatic
the notation if either scientific or fixed depending on what is shorter
Definition Types.h:178
@ _UndefinedEDisplayNotation
Object is not yet initialized.
Definition Types.h:181
@ ctValueChangingChildren
All child node used to compute the value.
Definition Types.h:214
@ ctParentNodes
All nodes for which this node is at least an invalidating child.
Definition Types.h:208
@ ctWritingChildren
All nodes which can write a value further down the node stack.
Definition Types.h:210
@ ctTerminalNodes
All indirectly connected terminal nodes.
Definition Types.h:213
@ ctDependingNodes
All directly or indirectly connected nodes which are invalidated by this nodes (i....
Definition Types.h:212
@ ctReadingChildren
All nodes which can be read from.
Definition Types.h:209
@ ctInvalidatingChildren
All directly connected nodes which invalidate this node.
Definition Types.h:211
@ idNone
SwissKnife is not used within a converter.
Definition Types.h:232
@ idFrom
Indicates a swiss knife that it is used as worker for a converter computing FROM.
Definition Types.h:230
@ idTo
Indicates a swiss knife that it is used as worker for a converter computing TO.
Definition Types.h:231
@ xvLoad
Creates a dummy node map.
Definition Types.h:166
@ _UndefinedEXMLValidation
Object is not yet initialized.
Definition Types.h:171
@ xvCycles
checks for write and dependency cycles (implies xvLoad)
Definition Types.h:167
@ xvDefault
checks performed if nothing else is said
Definition Types.h:169
@ xvAll
all possible checks
Definition Types.h:170
@ xvSFNC
checks for conformance with the standard feature naming convention (SFNC)
Definition Types.h:168
@ intfIRegister
IRegister interface.
Definition Types.h:195
@ intfIPort
IPort interface.
Definition Types.h:199
@ intfIBase
IBase interface.
Definition Types.h:189
@ intfIFloat
IFloat interface.
Definition Types.h:193
@ intfIValue
IValue interface.
Definition Types.h:188
@ intfIEnumEntry
IEnumEntry interface.
Definition Types.h:198
@ intfIInteger
IInteger interface.
Definition Types.h:190
@ intfIString
IString interface.
Definition Types.h:194
@ intfIBoolean
IBoolean interface.
Definition Types.h:191
@ intfICategory
ICategory interface.
Definition Types.h:196
@ intfICommand
ICommand interface.
Definition Types.h:192
@ intfIEnumeration
IEnumeration interface.
Definition Types.h:197
_EYesNo
Definition Types.h:139
_EVisibility
Definition Types.h:66
_ECachingMode
Definition Types.h:77
_EEndianess
Definition Types.h:106
_ESign
Definition Types.h:44
_EAccessMode
Definition Types.h:53
_ERepresentation
Definition Types.h:87
_ENameSpace
Definition Types.h:116
_EStandardNameSpace
Definition Types.h:126
@ _UndefinedYesNo
Object is not yet initialized.
Definition Types.h:142
@ Yes
yes
Definition Types.h:140
@ No
no
Definition Types.h:141
@ Invisible
Not Visible.
Definition Types.h:70
@ _UndefinedVisibility
Object is not yet initialized.
Definition Types.h:71
@ Guru
Visible for Gurus.
Definition Types.h:69
@ Beginner
Always visible.
Definition Types.h:67
@ Expert
Visible for experts or Gurus.
Definition Types.h:68
@ NoCache
Do not use cache.
Definition Types.h:78
@ WriteAround
Write to register, write to cache on read.
Definition Types.h:80
@ _UndefinedCachingMode
Not yet initialized.
Definition Types.h:81
@ WriteThrough
Write to cache and register.
Definition Types.h:79
@ _UndefinedEndian
Object is not yet initialized.
Definition Types.h:109
@ LittleEndian
Register is little endian.
Definition Types.h:108
@ BigEndian
Register is big endian.
Definition Types.h:107
@ _UndefinedSign
Object is not yet initialized.
Definition Types.h:47
@ Unsigned
Integer is unsigned.
Definition Types.h:46
@ Signed
Integer is signed.
Definition Types.h:45
@ _UndefinedAccessMode
Object is not yet initialized.
Definition Types.h:59
@ NI
Not implemented.
Definition Types.h:54
@ RO
Read Only.
Definition Types.h:57
@ _CycleDetectAccessMode
used internally for AccessMode cycle detection
Definition Types.h:60
@ WO
Write Only.
Definition Types.h:56
@ NA
Not available.
Definition Types.h:55
@ RW
Read and Write.
Definition Types.h:58
@ PureNumber
Decimal number in an edit control.
Definition Types.h:91
@ Linear
Slider with linear behavior.
Definition Types.h:88
@ Boolean
Check box.
Definition Types.h:90
@ Logarithmic
Slider with logarithmic behaviour.
Definition Types.h:89
@ IPV4Address
IP-Address.
Definition Types.h:93
@ HexNumber
Hex number in an edit control.
Definition Types.h:92
@ MACAddress
MAC-Address.
Definition Types.h:94
@ Custom
name resides in custom namespace
Definition Types.h:117
@ Standard
name resides in one of the standard namespaces
Definition Types.h:118
@ _UndefinedNameSpace
Object is not yet initialized.
Definition Types.h:119
@ _UndefinedStandardNameSpace
Object is not yet initialized.
Definition Types.h:132
@ CL
name resides in camera link namespace
Definition Types.h:130
@ USB
name resides in USB namespace
Definition Types.h:131
@ IIDC
name resides in 1394 IIDC namespace
Definition Types.h:129
@ GEV
name resides in GigE Vision namespace
Definition Types.h:128
@ None
name resides in custom namespace
Definition Types.h:127