Gocator API
GoMaterial.h
Go to the documentation of this file.
1 /**
2  * @file GoMaterial.h
3  * @brief Declares the GoMaterial class.
4  * @deprecated
5  * @internal
6  * Copyright (C) 2016-2019 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_MATERIAL_H
11 #define GO_MATERIAL_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoAdvanced.h>
15 
16 /**
17  * @deprecated
18  * @class GoMaterial
19  * @extends kObject
20  * @note Supported with G1, G2
21  * @ingroup GoSdk
22  * @brief Represents configurable material acquisition settings.
23  */
24 typedef GoAdvanced GoMaterial;
25 
26 /**
27  * @deprecated Sets the material acquisition type.
28  *
29  * @public @memberof GoMaterial
30  * @note Supported with G1, G2
31  * @version Introduced in firmware 4.1.3.106
32  * @param material GoMaterial object.
33  * @param type The material type to set.
34  * @return Operation status.
35  */
37 
38 /**
39  * @deprecated Returns the user defined material acquisition type.
40  *
41  * @public @memberof GoMaterial
42  * @note Supported with G1, G2
43  * @version Introduced in firmware 4.1.3.106
44  * @param material GoMaterial object.
45  * @return The material type.
46  */
48 
49 /**
50  * @deprecated Returns a boolean relating to whether the user defined material acquisition type value will be used by the system.
51  *
52  * @public @memberof GoMaterial
53  * @note Supported with G1, G2
54  * @version Introduced in firmware 4.1.3.106
55  * @param material GoMaterial object.
56  * @return kTRUE if the user defined material type will be used and kFALSE otherwise.
57  */
58 GoFx(kBool) GoMaterial_IsTypeUsed(GoMaterial material);
59 
60 /**
61  * @deprecated Returns the material acquisition type to be used by the system.
62  *
63  * @public @memberof GoMaterial
64  * @note Supported with G1, G2
65  * @version Introduced in firmware 4.1.3.106
66  * @param material GoMaterial object.
67  * @return The system value material type.
68  */
70 
71 /**
72  * @deprecated Sets the spot threshold.
73  *
74  * @public @memberof GoMaterial
75  * @note Supported with G1, G2
76  * @version Introduced in firmware 4.1.3.106
77  * @param material GoMaterial object.
78  * @param value Spot threshold.
79  * @return Operation status.
80  */
81 GoFx(kStatus) GoMaterial_SetSpotThreshold(GoMaterial material, k32u value);
82 
83 /**
84  * @deprecated Returns the user defined spot threshold.
85  *
86  * @public @memberof GoMaterial
87  * @note Supported with G1, G2
88  * @version Introduced in firmware 4.1.3.106
89  * @param material GoMaterial object.
90  * @return The spot threshold.
91  */
93 
94 /**
95  * @deprecated Returns the minimum spot threshold limit.
96  *
97  * @public @memberof GoMaterial
98  * @note Supported with G1, G2
99  * @version Introduced in firmware 4.1.3.106
100  * @param material GoMaterial object.
101  * @return The minimum spot threshold.
102  */
104 
105 /**
106  * @deprecated Returns the maximum spot threshold limit.
107  *
108  * @public @memberof GoMaterial
109  * @note Supported with G1, G2
110  * @version Introduced in firmware 4.1.3.106
111  * @param material GoMaterial object.
112  * @return The maximum spot threshold.
113  */
115 
116 /**
117  * @deprecated Returns a boolean value representing whether the user specified spot threshold value is used.
118  *
119  * @public @memberof GoMaterial
120  * @note Supported with G1, G2
121  * @version Introduced in firmware 4.1.3.106
122  * @param material GoMaterial object.
123  * @return kTRUE if it is used and kFALSE otherwise.
124  */
126 
127 /**
128  * @deprecated Returns the system spot threshold value.
129  *
130  * @public @memberof GoMaterial
131  * @note Supported with G1, G2
132  * @version Introduced in firmware 4.1.3.106
133  * @param material GoMaterial object.
134  * @return The system spot threshold.
135  */
137 
138 /**
139  * @deprecated Sets the maximum spot width.
140  *
141  * @public @memberof GoMaterial
142  * @note Supported with G1, G2
143  * @version Introduced in firmware 4.1.3.106
144  * @param material GoMaterial object.
145  * @param value Maximum spot width.
146  * @return Operation status.
147  */
148 GoFx(kStatus) GoMaterial_SetSpotWidthMax(GoMaterial material, k32u value);
149 
150 /**
151  * @deprecated Returns the user defined maximum spot width.
152  *
153  * @public @memberof GoMaterial
154  * @note Supported with G1, G2
155  * @version Introduced in firmware 4.1.3.106
156  * @param material GoMaterial object.
157  * @return The maximum spot width.
158  */
159 GoFx(k32u) GoMaterial_SpotWidthMax(GoMaterial material);
160 
161 /**
162  * @deprecated Returns the maximum spot width minimum limit.
163  *
164  * @public @memberof GoMaterial
165  * @note Supported with G1, G2
166  * @version Introduced in firmware 4.1.3.106
167  * @param material GoMaterial object.
168  * @return The maximum spot width minimum limit.
169  */
171 
172 /**
173  * @deprecated Returns the maximum spot width maximum limit.
174  *
175  * @public @memberof GoMaterial
176  * @note Supported with G1, G2
177  * @version Introduced in firmware 4.1.3.106
178  * @param material GoMaterial object.
179  * @return The maximum spot width maximum limit.
180  */
182 
183 /**
184  * @deprecated Returns a boolean relating to whether the user defined spot width max value will be used by the system.
185  *
186  * @public @memberof GoMaterial
187  * @note Supported with G1, G2
188  * @version Introduced in firmware 4.1.3.106
189  * @param material GoMaterial object.
190  * @return kTRUE if the user value will be used and kFALSE otherwise.
191  */
193 
194 /**
195  * @deprecated Returns the maximum spot width system value.
196  *
197  * @public @memberof GoMaterial
198  * @note Supported with G1, G2
199  * @version Introduced in firmware 4.1.3.106
200  * @param material GoMaterial object.
201  * @return The maximum spot width system value.
202  */
204 
205 /**
206  * @deprecated Returns the number of spot selection type options.
207  *
208  * @public @memberof GoMaterial
209  * @note Supported with G1, G2
210  * @version Introduced in firmware 4.3.3.124
211  * @param material GoMaterial object.
212  * @return The spot selection type option count.
213  */
215 
216 /**
217  * @deprecated Returns the spot selection type option at the given index.
218  *
219  * @public @memberof GoMaterial
220  * @note Supported with G1, G2
221  * @version Introduced in firmware 4.3.3.124
222  * @param material GoMaterial object.
223  * @param index The option list index to access.
224  * @return The spot selection type option at the given index.
225  */
227 
228 /**
229  * @deprecated Sets the spot selection type.
230  *
231  * @public @memberof GoMaterial
232  * @note Supported with G1, G2
233  * @version Introduced in firmware 4.1.3.106
234  * @param material GoMaterial object.
235  * @param type Spot selection type.
236  * @return Operation status.
237  */
239 
240 /**
241  * @deprecated Returns the user defined spot selection type.
242  *
243  * @public @memberof GoMaterial
244  * @note Supported with G1, G2
245  * @version Introduced in firmware 4.1.3.106
246  * @param material GoMaterial object.
247  * @return The maximum spot width.
248  */
250 
251 /**
252  * @deprecated Returns a boolean relating to whether the user defined spot selection type will be used by the system.
253  *
254  * @public @memberof GoMaterial
255  * @note Supported with G1, G2
256  * @version Introduced in firmware 4.1.3.106
257  * @param material GoMaterial object.
258  * @return kTRUE if the user value will be used and kFALSE otherwise.
259  */
261 
262 /**
263  * @deprecated Returns the system spot selection type.
264  *
265  * @public @memberof GoMaterial
266  * @note Supported with G1, G2
267  * @version Introduced in firmware 4.1.3.106
268  * @param material GoMaterial object.
269  * @return System spot selection type.
270  */
272 
273 /**
274  * @deprecated Sets the analog camera gain.
275  *
276  * @public @memberof GoMaterial
277  * @note Supported with G1, G2
278  * @version Introduced in firmware 4.1.3.106
279  * @param material GoMaterial object.
280  * @param value Analog camera gain.
281  * @return Operation status.
282  */
284 
285 /**
286  * @deprecated Returns the user defined analog camera gain value.
287  *
288  * @public @memberof GoMaterial
289  * @note Supported with G1, G2
290  * @version Introduced in firmware 4.1.3.106
291  * @param material GoMaterial object.
292  * @return Analog camera gain value.
293  */
295 
296 /**
297  * @deprecated Returns the analog camera gain minimum value limit.
298  *
299  * @public @memberof GoMaterial
300  * @note Supported with G1, G2
301  * @version Introduced in firmware 4.1.3.106
302  * @param material GoMaterial object.
303  * @return Analog camera gain minimum value limit.
304  */
306 
307 /**
308  * @deprecated Returns the analog camera gain maximum value limit.
309  *
310  * @public @memberof GoMaterial
311  * @note Supported with G1, G2
312  * @version Introduced in firmware 4.1.3.106
313  * @param material GoMaterial object.
314  * @return Analog camera gain maximum value limit.
315  */
317 
318 /**
319  * @deprecated Returns a boolean value representing whether the user defined analog camera gain is used.
320  *
321  * @public @memberof GoMaterial
322  * @note Supported with G1, G2
323  * @version Introduced in firmware 4.1.3.106
324  * @param material GoMaterial object.
325  * @return kTRUE if the user defined analog camera gain is used and kFALSE otherwise.
326  */
328 
329 /**
330  * @deprecated Returns the analog camera gain system value.
331  *
332  * @public @memberof GoMaterial
333  * @note Supported with G1, G2
334  * @version Introduced in firmware 4.1.3.106
335  * @param material GoMaterial object.
336  * @return The analog camera gain system value.
337  */
339 
340 /**
341  * @deprecated Sets the digital camera gain
342  *
343  * @public @memberof GoMaterial
344  * @note Supported with G1, G2
345  * @version Introduced in firmware 4.1.3.106
346  * @param material GoMaterial object.
347  * @param value Digital camera gain.
348  * @return Operation status.
349  */
351 
352 /**
353  * @deprecated Returns the user defined digital camera gain value.
354  *
355  * @public @memberof GoMaterial
356  * @note Supported with G1, G2
357  * @version Introduced in firmware 4.1.3.106
358  * @param material GoMaterial object.
359  * @return The digital camera gain system value.
360  */
362 
363 /**
364  * @deprecated Returns the digital camera gain minimum value limit.
365  *
366  * @public @memberof GoMaterial
367  * @note Supported with G1, G2
368  * @version Introduced in firmware 4.1.3.106
369  * @param material GoMaterial object.
370  * @return Digital camera gain minimum value limit.
371  */
373 
374 /**
375  * @deprecated Returns the digital camera gain maximum value limit.
376  *
377  * @public @memberof GoMaterial
378  * @note Supported with G1, G2
379  * @version Introduced in firmware 4.1.3.106
380  * @param material GoMaterial object.
381  * @return Digital camera gain maximum value limit.
382  */
384 
385 /**
386  * @deprecated Returns a boolean value representing whether the user's digital camera gain value is used by the system.
387  *
388  * @public @memberof GoMaterial
389  * @note Supported with G1, G2
390  * @version Introduced in firmware 4.1.3.106
391  * @param material GoMaterial object.
392  * @return kTRUE if used and kFALSE otherwise.
393  */
395 
396 /**
397  * @deprecated Returns the system's digital camera gain value.
398  *
399  * @public @memberof GoMaterial
400  * @note Supported with G1, G2
401  * @version Introduced in firmware 4.1.3.106
402  * @param material GoMaterial object.
403  * @return Digital camera gain system value.
404  */
406 
407 /**
408  * @deprecated Sets the dynamic sensitivity.
409  *
410  * @public @memberof GoMaterial
411  * @note Supported with G1, G2
412  * @version Introduced in firmware 4.1.3.106
413  * @param material GoMaterial object.
414  * @param value Dynamic sensitivity.
415  * @return Operation status.
416  */
418 
419 /**
420  * @deprecated Returns the user defined dynamic sensitivity value.
421  *
422  * @public @memberof GoMaterial
423  * @note Supported with G1, G2
424  * @version Introduced in firmware 4.1.3.106
425  * @param material GoMaterial object.
426  * @return User defined dynamic sensitivity value.
427  */
429 
430 /**
431  * @deprecated Returns the dynamic sensitivity minimum value limit.
432  *
433  * @public @memberof GoMaterial
434  * @note Supported with G1, G2
435  * @version Introduced in firmware 4.1.3.106
436  * @param material GoMaterial object.
437  * @return Dynamic sensitivity minimum value limit.
438  */
440 
441 /**
442  * @deprecated Returns the dynamic sensitivity maximum value limit.
443  *
444  * @public @memberof GoMaterial
445  * @note Supported with G1, G2
446  * @version Introduced in firmware 4.1.3.106
447  * @param material GoMaterial object.
448  * @return Dynamic sensitivity maximum value limit.
449  */
451 
452 /**
453  * @deprecated Returns a boolean representing whether the user defined dynamic sensitivity value is used.
454  *
455  * @public @memberof GoMaterial
456  * @note Supported with G1, G2
457  * @version Introduced in firmware 4.1.3.106
458  * @param material GoMaterial object.
459  * @return kTRUE if used and kFALSE otherwise.
460  */
462 
463 /**
464  * @deprecated Returns the dynamic sensitivity system value.
465  *
466  * @public @memberof GoMaterial
467  * @note Supported with G1, G2
468  * @version Introduced in firmware 4.1.3.106
469  * @param material GoMaterial object.
470  * @return Dynamic sensitivity system value.
471  */
473 
474 /**
475  * @deprecated Sets the dynamic threshold.
476  *
477  * @public @memberof GoMaterial
478  * @note Supported with G1, G2
479  * @version Introduced in firmware 4.1.3.106
480  * @param material GoMaterial object.
481  * @param value Dynamic threshold.
482  * @return Operation status.
483  */
485 
486 /**
487  * @deprecated Returns the dynamic threshold minimum value limit.
488  *
489  * @public @memberof GoMaterial
490  * @note Supported with G1, G2
491  * @version Introduced in firmware 4.1.3.106
492  * @param material GoMaterial object.
493  * @return Dynamic threshold minimum value limit.
494  */
496 
497 /**
498  * @deprecated Returns the dynamic threshold maximum value limit.
499  *
500  * @public @memberof GoMaterial
501  * @note Supported with G1, G2
502  * @version Introduced in firmware 4.1.3.106
503  * @param material GoMaterial object.
504  * @return Dynamic threshold maximum value limit.
505  */
507 
508 /**
509  * @deprecated Returns the user defined dynamic threshold value.
510  *
511  * @public @memberof GoMaterial
512  * @note Supported with G1, G2
513  * @version Introduced in firmware 4.1.3.106
514  * @param material GoMaterial object.
515  * @return The user defined dynamic threshold value.
516  */
518 
519 /**
520  * @deprecated Returns a boolean representing whether or not the user defined dynamic threshold is used by the system.
521  *
522  * @public @memberof GoMaterial
523  * @note Supported with G1, G2
524  * @version Introduced in firmware 4.1.3.106
525  * @param material GoMaterial object.
526  * @return Dynamic threshold minimum value limit.
527  */
529 
530 /**
531  * @deprecated Returns the dynamic threshold system value.
532  *
533  * @public @memberof GoMaterial
534  * @note Supported with G1, G2
535  * @version Introduced in firmware 4.1.3.106
536  * @param material GoMaterial object.
537  * @return Dynamic threshold system value.
538  */
540 
541 /**
542  * @deprecated Sets the gamma type.
543  *
544  * @public @memberof GoMaterial
545  * @note Supported with G1, G2
546  * @version Introduced in firmware 4.1.3.106
547  * @param material GoMaterial object.
548  * @param value Gamma type.
549  * @return Operation status.
550  */
552 
553 /**
554  * @deprecated Returns the user defined gamma type.
555  *
556  * @public @memberof GoMaterial
557  * @note Supported with G1, G2
558  * @version Introduced in firmware 4.1.3.106
559  * @param material GoMaterial object.
560  * @return User defined gamma type.
561  */
563 
564 /**
565  * @deprecated Returns a boolean representing whether the user defined gamma type is used by the system.
566  *
567  * @public @memberof GoMaterial
568  * @note Supported with G1, G2
569  * @version Introduced in firmware 4.1.3.106
570  * @param material GoMaterial object.
571  * @return kTRUE if used and kFALSE otherwise.
572  */
574 
575 /**
576  * @deprecated Returns the system's gamma type value.
577  *
578  * @public @memberof GoMaterial
579  * @note Supported with G1, G2
580  * @version Introduced in firmware 4.1.3.106
581  * @param material GoMaterial object.
582  * @return The system gamma type value.
583  */
585 
586 /**
587  * @deprecated Enables or disables senstivity compensation. NOTE: This is only applicable to
588  * 2300 B series sensors.
589  *
590  * @public @memberof GoMaterial
591  * @note Supported with G1, G2
592  * @version Introduced in firmware 4.3.3.124
593  * @param material GoMaterial object.
594  * @param value kTRUE to enable and kFALSE to disable.
595  * @return Operation status.
596  */
598 
599 /**
600  * @deprecated Returns the user defined sensitivity compensation value.
601  *
602  * @public @memberof GoMaterial
603  * @note Supported with G1, G2
604  * @version Introduced in firmware 4.3.3.124
605  * @param material GoMaterial object.
606  * @return User defined sensitivity compensation.
607  */
609 
610 /**
611  * @deprecated Returns a boolean representing whether the user defined sensitivity compensation is used by the system.
612  *
613  * @public @memberof GoMaterial
614  * @note Supported with G1, G2
615  * @version Introduced in firmware 4.3.3.124
616  * @param material GoMaterial object.
617  * @return kTRUE if used and kFALSE otherwise.
618  */
620 
621 /**
622  * @deprecated Returns the system's sensitivity compensation value.
623  *
624  * @public @memberof GoMaterial
625  * @note Supported with G1, G2
626  * @version Introduced in firmware 4.3.3.124
627  * @param material GoMaterial object.
628  * @return kTRUE if enabled and kFALSE otherwise.
629  */
631 
632 #endif
Represents configurable advanced acquisition settings.
k32u GoMaterial_SpotWidthMaxLimitMin(GoMaterial material)
kStatus GoMaterial_SetSpotSelectionType(GoMaterial material, GoSpotSelectionType type)
kBool GoMaterial_IsCameraGainDigitalUsed(GoMaterial material)
GoMaterialType GoMaterial_TypeSystemValue(GoMaterial material)
k64f GoMaterial_CameraGainDigitalSystemValue(GoMaterial material)
kBool GoMaterial_IsDynamicThresholdUsed(GoMaterial material)
GoSpotSelectionType GoMaterial_SpotSelectionTypeSystemValue(GoMaterial material)
kStatus GoMaterial_SetSpotWidthMax(GoMaterial material, k32u value)
k32u GoMaterial_SpotThresholdLimitMax(GoMaterial material)
Represents configurable material acquisition settings.
k64f GoMaterial_CameraGainAnalogLimitMin(GoMaterial material)
k64f GoMaterial_CameraGainDigital(GoMaterial material)
kStatus GoMaterial_SetSpotThreshold(GoMaterial material, k32u value)
k64f GoMaterial_CameraGainAnalogSystemValue(GoMaterial material)
kStatus GoMaterial_SetDynamicSensitivity(GoMaterial material, k64f value)
Represents a material acquisition type.
k32u GoMaterial_SpotThresholdSystemValue(GoMaterial material)
k32u GoMaterial_DynamicThresholdSystemValue(GoMaterial material)
kBool GoMaterial_IsTypeUsed(GoMaterial material)
kBool GoMaterial_IsCameraGainAnalogUsed(GoMaterial material)
k32u GoMaterial_SpotWidthMaxSystemValue(GoMaterial material)
kBool GoMaterial_SensitivityCompensationEnabled(GoMaterial material)
Essential SDK declarations.
k64f GoMaterial_DynamicSensitivity(GoMaterial material)
Represents an advanced gamma type.
kBool GoMaterial_IsSpotWidthMaxUsed(GoMaterial material)
k32u GoMaterial_SpotWidthMaxLimitMax(GoMaterial material)
k64f GoMaterial_DynamicSensitivityLimitMax(GoMaterial material)
k32u GoMaterial_SpotWidthMax(GoMaterial material)
kStatus GoMaterial_SetDynamicThreshold(GoMaterial material, k32u value)
GoGammaType GoMaterial_GammaType(GoMaterial material)
kSize GoMaterial_SpotSelectionTypeOptionCount(GoMaterial material)
GoSpotSelectionType GoMaterial_SpotSelectionType(GoMaterial material)
kStatus GoMaterial_SetCameraGainAnalog(GoMaterial material, k64f value)
k64f GoMaterial_CameraGainDigitalLimitMin(GoMaterial material)
kBool GoMaterial_SensitivityCompensationEnabledSystemValue(GoMaterial material)
kStatus GoMaterial_SetType(GoMaterial material, GoMaterialType type)
k32u GoMaterial_DynamicThresholdLimitMax(GoMaterial material)
k32u GoMaterial_SpotThreshold(GoMaterial material)
k32u GoMaterial_DynamicThreshold(GoMaterial material)
GoGammaType GoMaterial_GammaTypeSystemValue(GoMaterial material)
kBool GoMaterial_IsSpotThresholdUsed(GoMaterial material)
kBool GoMaterial_IsSensitivityCompensationEnabledUsed(GoMaterial material)
k32u GoMaterial_SpotThresholdLimitMin(GoMaterial material)
k64f GoMaterial_CameraGainAnalog(GoMaterial material)
kStatus GoMaterial_SetCameraGainDigital(GoMaterial material, k64f value)
k64f GoMaterial_CameraGainDigitalLimitMax(GoMaterial material)
k64f GoMaterial_CameraGainAnalogLimitMax(GoMaterial material)
Represents a spot selection type.
kBool GoMaterial_IsGammaTypeUsed(GoMaterial material)
kStatus GoMaterial_SetGammaType(GoMaterial material, GoGammaType value)
kBool GoMaterial_IsSpotSelectionTypeUsed(GoMaterial material)
GoMaterialType GoMaterial_Type(GoMaterial material)
k64f GoMaterial_DynamicSensitivitySystemValue(GoMaterial material)
k64f GoMaterial_DynamicSensitivityLimitMin(GoMaterial material)
kBool GoMaterial_IsDynamicSensitivityUsed(GoMaterial material)
k32u GoMaterial_DynamicThresholdLimitMin(GoMaterial material)
GoSpotSelectionType GoMaterial_SpotSelectionTypeOptionAt(GoMaterial material, kSize index)
Declares the GoAdvanced class.
kStatus GoMaterial_EnableSensitivityCompensation(GoMaterial material, kBool value)