Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



PvGenTypes.h
Go to the documentation of this file.
1 // *****************************************************************************
2 //
3 // Copyright (c) 2010, Pleora Technologies Inc., All rights reserved.
4 //
5 // *****************************************************************************
6 
7 #ifndef __PVGENTYPES_H__
8 #define __PVGENTYPES_H__
9 
14 
15 
41 
42 typedef enum
43 {
45  PvGenVisibilityBeginner = 0,
47  PvGenVisibilityExpert,
49  PvGenVisibilityGuru,
51  PvGenVisibilityInvisible,
53  PvGenVisibilityUndefined = 999
54 
55 } PvGenVisibility;
56 
57 
67 
69 
71 
73 
75 
77 
79 
81 typedef enum
82 {
85  PvGenTypeInteger = 0,
88  PvGenTypeEnum,
91  PvGenTypeBoolean,
94  PvGenTypeString,
97  PvGenTypeCommand,
100  PvGenTypeFloat,
103  PvGenTypeRegister,
106  PvGenTypeUndefined = 999
107 
108 } PvGenType;
109 
110 
120 typedef enum
121 {
123  PvGenRepresentationLinear = 0,
127  PvGenRepresentationLogarithmic,
130  PvGenRepresentationBoolean,
132  PvGenRepresentationPureNumber,
134  PvGenRepresentationHexNumber,
136  PvGenRepresentationIPV4Address,
138  PvGenRepresentationMACAddress,
140  PvGenRepresentationUndefined = 999
141 
142 } PvGenRepresentation;
143 
144 
145 
146 typedef enum
147 {
149  PvGenNameSpaceStandard = 0,
151  PvGenNameSpaceCustom,
153  PvGenNameSpaceUndefined = 999
154 
155 } PvGenNameSpace;
156 
157 
158 typedef enum
159 {
161  PvGenAccessModeReadOnly = 0,
163  PvGenAccessModeReadWrite = 1,
165  PvGenAccessModeWriteOnly = 2,
167  PvGenAccessModeNotImplemented = 3,
169  PvGenAccessModeNotAvailable = 4,
171  PvGenAccessModeUndefined = 999
172 
173 } PvGenAccessMode;
174 
175 
176 typedef enum
177 {
179  PvGenCacheWriteThrough = 0,
181  PvGenCacheWriteAround,
183  PvGenCacheNone,
185  PvGenCacheUndefined = 999
186 
187 } PvGenCache;
188 
189 
196 typedef enum
197 {
199  PvGenRefreshInvalid = -1,
202  PvGenRefreshPolling = 0,
204  PvGenRefreshAuto,
207  PvGenRefreshManual
208 
209 } PvGenRefresh;
210 
211 
212 typedef enum
213 {
215  PvGenEndiannessInvalid = -1,
217  PvGenEndiannessLittle = 0,
219  PvGenEndiannessBig
220 
221 } PvGenEndianness;
222 
223 
224 typedef enum
225 {
227  PvGenSignUndefined = -1,
229  PvGenSignUnsigned = 0,
231  PvGenSignSigned
232 
233 } PvGenSign;
234 
235 
236 #endif
237 
PvGenVisibility
PvGenVisibility
Feature (PvGenParameter object) visibility.
Definition: PvGenTypes.h:43
PvGenVisibilityInvisible
@ PvGenVisibilityInvisible
Appears in the API, but not the GUI.
Definition: PvGenTypes.h:51
PvGenVisibilityUndefined
@ PvGenVisibilityUndefined
Not defined; valid visibility not provided.
Definition: PvGenTypes.h:53
PvGenVisibilityExpert
@ PvGenVisibilityExpert
Intended for advanced users.
Definition: PvGenTypes.h:47
PvGenVisibilityGuru
@ PvGenVisibilityGuru
Intended for very advanced users.
Definition: PvGenTypes.h:49
PvGenVisibilityBeginner
@ PvGenVisibilityBeginner
Always visible, to all users.
Definition: PvGenTypes.h:45
PvGenRefresh
PvGenRefresh
Refresh method for a GenApi browser.
Definition: PvGenTypes.h:197
PvGenRefreshPolling
@ PvGenRefreshPolling
The polling time provided for parameters in the XML are used to control parameter refreshing.
Definition: PvGenTypes.h:202
PvGenRefreshInvalid
@ PvGenRefreshInvalid
Refresh mode is invalid.
Definition: PvGenTypes.h:199
PvGenRefreshAuto
@ PvGenRefreshAuto
A round-robbin refresh is performed on all visible features.
Definition: PvGenTypes.h:204
PvGenRefreshManual
@ PvGenRefreshManual
Refresh is disabled. The browser may offer a manual Refresh button that can be used to control parame...
Definition: PvGenTypes.h:207
PvGenRepresentation
PvGenRepresentation
Definition: PvGenTypes.h:121
PvGenRepresentationPureNumber
@ PvGenRepresentationPureNumber
Pure number. Use an edit box with a decimal display.
Definition: PvGenTypes.h:132
PvGenRepresentationLinear
@ PvGenRepresentationLinear
Linear. Use a slider.
Definition: PvGenTypes.h:123
PvGenRepresentationIPV4Address
@ PvGenRepresentationIPV4Address
IPv4 address. Use an edit box with an IP address dot-decimal display.
Definition: PvGenTypes.h:136
PvGenRepresentationLogarithmic
@ PvGenRepresentationLogarithmic
Logarithmic. Use a slider. The GenICam standard doesn't specify if the feature's value represents x o...
Definition: PvGenTypes.h:127
PvGenRepresentationBoolean
@ PvGenRepresentationBoolean
Boolean. The number might be presented as a check box or enable. Use a similar UI as for features fro...
Definition: PvGenTypes.h:130
PvGenRepresentationHexNumber
@ PvGenRepresentationHexNumber
Hex number. Use an edit box with a hexadecimal display.
Definition: PvGenTypes.h:134
PvGenRepresentationMACAddress
@ PvGenRepresentationMACAddress
MAC address. Use an edit box with a MAC address (e.g. 01-23-45-67-89-AB) display.
Definition: PvGenTypes.h:138
PvGenRepresentationUndefined
@ PvGenRepresentationUndefined
Not defined; valid representation not provided.
Definition: PvGenTypes.h:140
PvGenEndianness
PvGenEndianness
Definition: PvGenTypes.h:213
PvGenEndiannessBig
@ PvGenEndiannessBig
Big endianness.
Definition: PvGenTypes.h:219
PvGenEndiannessLittle
@ PvGenEndiannessLittle
Litte endianness.
Definition: PvGenTypes.h:217
PvGenEndiannessInvalid
@ PvGenEndiannessInvalid
Invalid endianness.
Definition: PvGenTypes.h:215
PvGenCache
PvGenCache
Definition: PvGenTypes.h:177
PvGenCacheUndefined
@ PvGenCacheUndefined
PvGenCache is undefined.
Definition: PvGenTypes.h:185
PvGenCacheWriteThrough
@ PvGenCacheWriteThrough
PvGenCache is write though.
Definition: PvGenTypes.h:179
PvGenCacheWriteAround
@ PvGenCacheWriteAround
PvGenCache is write around.
Definition: PvGenTypes.h:181
PvGenCacheNone
@ PvGenCacheNone
PvGenCache is none.
Definition: PvGenTypes.h:183
PvGenSign
PvGenSign
Definition: PvGenTypes.h:225
PvGenSignUndefined
@ PvGenSignUndefined
Undefined if it's signed.
Definition: PvGenTypes.h:227
PvGenSignUnsigned
@ PvGenSignUnsigned
Is not signed.
Definition: PvGenTypes.h:229
PvGenSignSigned
@ PvGenSignSigned
Is signed.
Definition: PvGenTypes.h:231
PvGenAccessMode
PvGenAccessMode
Definition: PvGenTypes.h:159
PvGenAccessModeReadWrite
@ PvGenAccessModeReadWrite
Read and write.
Definition: PvGenTypes.h:163
PvGenAccessModeUndefined
@ PvGenAccessModeUndefined
PvGenAccessMode is not defined.
Definition: PvGenTypes.h:171
PvGenAccessModeReadOnly
@ PvGenAccessModeReadOnly
Read only.
Definition: PvGenTypes.h:161
PvGenAccessModeNotAvailable
@ PvGenAccessModeNotAvailable
PvGenAccessMode is not available.
Definition: PvGenTypes.h:169
PvGenAccessModeWriteOnly
@ PvGenAccessModeWriteOnly
Write only.
Definition: PvGenTypes.h:165
PvGenAccessModeNotImplemented
@ PvGenAccessModeNotImplemented
PvGenAccessMode has not been implemented.
Definition: PvGenTypes.h:167
PvGenType
PvGenType
Feature data type (Boolean, integer, etc.)
Definition: PvGenTypes.h:82
PvGenTypeEnum
@ PvGenTypeEnum
Type: Enumeration Class: PvGenEnum.
Definition: PvGenTypes.h:88
PvGenTypeInteger
@ PvGenTypeInteger
Type: Integer Class: PvGenInteger.
Definition: PvGenTypes.h:85
PvGenTypeCommand
@ PvGenTypeCommand
Type: Command Class: PvGenCommand.
Definition: PvGenTypes.h:97
PvGenTypeBoolean
@ PvGenTypeBoolean
Type: Boolean Class: PvGenBoolean.
Definition: PvGenTypes.h:91
PvGenTypeFloat
@ PvGenTypeFloat
Type: Float Class: PvGenFloat.
Definition: PvGenTypes.h:100
PvGenTypeString
@ PvGenTypeString
Type: String Class: PvGenString.
Definition: PvGenTypes.h:94
PvGenTypeUndefined
@ PvGenTypeUndefined
Type: Not defined; valid type not provided. Class: Not applicable.
Definition: PvGenTypes.h:106
PvGenTypeRegister
@ PvGenTypeRegister
Type: Register Class: PvGenRegister.
Definition: PvGenTypes.h:103
PvGenNameSpace
PvGenNameSpace
Definition: PvGenTypes.h:147
PvGenNameSpaceCustom
@ PvGenNameSpaceCustom
Custom PvGenNamespace.
Definition: PvGenTypes.h:151
PvGenNameSpaceUndefined
@ PvGenNameSpaceUndefined
Undefined PvGenNameSpace.
Definition: PvGenTypes.h:153
PvGenNameSpaceStandard
@ PvGenNameSpaceStandard
Standard PvGenNameSpace.
Definition: PvGenTypes.h:149

Copyright (c) 2002-2026 Pleora Technologies Inc.
www.pleora.com