aboutsummaryrefslogtreecommitdiff
path: root/vimbafeature.py
blob: c1d7e60e8cdf23b8a1b5e75dbc7367da20af0b14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# -*- coding: utf-8 -*-
import vimbastructure as structs
from vimbaexception import VimbaException
from vimbadll import VimbaDLL
from ctypes import *

# class may extend a generic Vimba entity class one day...
class VimbaFeature(object):
	"""
	A feature of a Vimba object.
	"""
	
	@property
	def name(self):
		return self._name
	
	@property
	def handle(self):
		return self._handle
	
	# lookup relevant function for feature type and pass to that function
	@property
	def value(self):
		return self._getSetTypeFuncs[self._info.featureDataType][0]()
	@value.setter
	def value(self, val):
		self._getSetTypeFuncs[self._info.featureDataType][1](val)
	
	@property
	def range(self):
		return self._rangeQueryTypeFuncs[self._info.featureDataType]()
	
	def __init__(self, name, handle):
		
		# set name and handle		
		self._name = name
		self._handle = handle

		# set own info
		self._info = self._getInfo()

		# type functions dict for looking up correct get/set function to use
		self._getSetTypeFuncs = {0 : (self._notYetImplemented, self._notYetImplemented),		# todo
								 1 : (self._getIntFeature, self._setIntFeature),
								 2 : (self._getFloatFeature, self._setFloatFeature),
								 3 : (self._getEnumFeature, self._setEnumFeature),
								 4 : (self._getStringFeature, self._setStringFeature),
								 5 : (self._getBoolFeature, self._setBoolFeature),
								 6 : (self._notYetImplemented, self._notYetImplemented),		# todo
								 7 : (self._notYetImplemented, self._notYetImplemented),		# todo
								 8 : (self._notYetImplemented, self._notYetImplemented)}		# todo
		
		# type functions dict for looking up correct range function to use
		self._rangeQueryTypeFuncs =  {0 : self._unknownRange,
									  1 : self._rangeQueryIntFeature,
									  2 : self._rangeQueryFloatFeature,
									  3 : self._unknownRange,
									  4 : self._unknownRange,
									  5 : self._unknownRange,
									  6 : self._unknownRange,
									  7 : self._unknownRange,
									  8 : self._unknownRange}
	
	def getInfo(self):
		"""
		Get info of the feature.
		
		:returns: VimbaFeatureInfo object -- feature information..
		"""
		return self._info
		
	def _getInfo(self):
		"""
		Get info of the feature.
		
		:returns: VimbaFeatureInfo object -- feature information..
		"""
		# args for Vimba call
		featureInfo = structs.VimbaFeatureInfo()
		
		# Vimba DLL will return an error code
		errorCode = VimbaDLL.featureInfoQuery(self._handle,
											  self._name,
											  byref(featureInfo),
											  sizeof(featureInfo))
		if errorCode != 0:
			raise VimbaException(errorCode)
		
		return featureInfo
				
	def _notYetImplemented(self, val = None):
		"""
		Raises exception if feature value type is not yet defined.
		"""
		raise VimbaException(-1001)

	def _getIntFeature(self):
		"""
		Get the value of an integer feature.
		
		:returns: int -- value of the specified feature.
		"""
		
		# create args
		valueToGet = c_int64()
		
		errorCode = VimbaDLL.featureIntGet(self._handle,
										   self._name,
										   byref(valueToGet))
		if errorCode != 0:
			raise VimbaException(errorCode)
	
		return valueToGet.value
	
	def _setIntFeature(self, valueToSet):
		"""
		Set the value of an integer feature.
		
		:param valueToSet: the int value to set for the feature.
		"""
			
		errorCode = VimbaDLL.featureIntSet(self._handle,
										   self._name,
										   valueToSet)
		if errorCode != 0:
			raise VimbaException(errorCode)
			
	def _getFloatFeature(self):
		"""
		Get the value of a float feature.
		
		:returns: float -- value of the specified feature.
		"""
		
		# create args
		valueToGet = c_double()
		
		errorCode = VimbaDLL.featureFloatGet(self._handle,
											 self._name,
											 byref(valueToGet))
		if errorCode != 0:
			raise VimbaException(errorCode)
	
		return valueToGet.value
	
	def _setFloatFeature(self, valueToSet):
		"""
		Set the value of a float feature.
		
		:param valueToSet: the float value to set for the feature.
		"""
		
		errorCode = VimbaDLL.featureFloatSet(self._handle,
											 self._name,
											 valueToSet)
		if errorCode != 0:
			raise VimbaException(errorCode)

	def _getEnumFeature(self):
		"""
		Get the value of an enum feature.
		
		:returns: enum -- value of the specified feature.
		"""
		
		# create args
		valueToGet = c_char_p()
		
		errorCode = VimbaDLL.featureEnumGet(self._handle,
											self._name,
											byref(valueToGet))
		if errorCode != 0:
			raise VimbaException(errorCode)
	
		return valueToGet.value
	
	def _setEnumFeature(self, valueToSet):
		"""
		Set the value of an enum feature.
		
		:param valueToSet: the enum value to set for the feature.
		"""
		
		errorCode = VimbaDLL.featureEnumSet(self._handle,
											self._name,
											valueToSet)
		if errorCode != 0:
			raise VimbaException(errorCode)
		
	def _getStringFeature(self):
		"""
		Get the value of a string feature.
		
		:returns: string -- value of the specified feature.
		"""
		
		# create args
		bufferSize = 256
		valueToGet = create_string_buffer('\000' * bufferSize)
		sizeFilled = c_uint32()
		
		errorCode = VimbaDLL.featureStringGet(self._handle,
											  self._name,
											  valueToGet,
											  bufferSize,
											  byref(sizeFilled))
		if errorCode != 0:
			raise VimbaException(errorCode)
	
		return valueToGet.value
	
	def _setStringFeature(self, valueToSet):
		"""
		Set the value of a string feature.
		
		:param valueToSet: the string value to set for the feature.
		"""
		
		errorCode = VimbaDLL.featureStringSet(self._handle,
											  self._name,
											  valueToSet)
		if errorCode != 0:
			raise VimbaException(errorCode)

	def _getBoolFeature(self):
		"""
		Get the value of a bool feature.
		
		:returns: bool -- value of the specified feature.
		"""
		
		# create args
		valueToGet = c_bool()
		
		errorCode = VimbaDLL.featureBoolGet(self._handle,
											self._name,
											byref(valueToGet))
		if errorCode != 0:
			raise VimbaException(errorCode)
	
		return valueToGet.value
	
	def _setBoolFeature(self, valueToSet):
		"""
		Set the value of a bool feature.
		
		:param valueToSet: the bool value to set for the feature.
		"""
		
		errorCode = VimbaDLL.featureBoolSet(self._handle,
											self._name,
											valueToSet)
		if errorCode != 0:
			raise VimbaException(errorCode)
	
	def _unknownRange(self):
		"""
		Returns empty for ranges that have not been implemented.
		"""
		return ''

	def _rangeQueryIntFeature(self):
		"""
		Get the range of an int feature.
		
		:returns: tuple -- min and max range.
		"""
		
		# create args
		minToGet = c_int64()
		maxToGet = c_int64()
		
		errorCode = VimbaDLL.featureIntRangeQuery(self._handle,
												  self._name,
												  byref(minToGet),
												  byref(maxToGet))
		if errorCode != 0:
			raise VimbaException(errorCode)
		
		return (int(str(minToGet.value)), int(str(maxToGet.value)))
	
	def _rangeQueryFloatFeature(self):
		"""
		Get the range of a float feature.
		
		:returns: tuple -- min and max range.
		"""
		
		# create args
		minToGet = c_double()
		maxToGet = c_double()
		
		errorCode = VimbaDLL.featureFloatRangeQuery(self._handle,
													self._name,
													byref(minToGet),
													byref(maxToGet))
		if errorCode != 0:
			raise VimbaException(errorCode)
		
		return (minToGet.value, maxToGet.value)
	
	#def _rangeQueryEnumFeature(self):
	#	"""
	#	Get the range of an enum feature.
	#	
	#	:returns: tuple -- min and max range.
	#	"""
	#	
	#	# create args
	#	minToGet = c_uint32()
	#	maxToGet = c_uint32()
	#	
	#	errorCode = VimbaDLL.featureEnumRangeQuery(self._handle,
	#											   self._name,
	#											   byref(minToGet),
	#											   byref(maxToGet))
	#	if errorCode != 0:
	#		raise VimbaException(errorCode)
	#	
	#	return (minToGet.value, maxToGet.value)