Gocator API
GoSetup.h
Go to the documentation of this file.
1 /**
2  * @file GoSetup.h
3  * @brief Declares the GoSetup class.
4  *
5  * @internal
6  * Copyright (C) 2016-2025 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_SDK_SETUP_H
11 #define GO_SDK_SETUP_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoLayout.h>
15 #include <GoSdk/GoAdvanced.h>
16 #include <GoSdk/GoMaterial.h>
17 #include <GoSdk/GoProfileGeneration.h>
18 #include <GoSdk/GoSurfaceGeneration.h>
19 #include <GoSdk/GoPartDetection.h>
20 #include <GoSdk/GoPartMatching.h>
21 #include <GoSdk/GoSections.h>
22 #include <GoSdk/GoTracheid.h>
23 
24 /**
25  * @class GoSetup
26  * @extends kObject
27  * @ingroup GoSdk
28  * @brief Represents a device configuration.
29  */
30 typedef kObject GoSetup;
31 
32 /**
33 * Sets the background suppression enabled value.
34 *
35 * @warning This API is experimental and may result in undefined behaviour if used incorrectly. See "Experimental Features" for more information.
36 *
37 * @public @memberof GoSetup
38 * @version Introduced in firmware 5.2.18.3
39 * @param setup GoSetup object.
40 * @param enabled Background supression enabled.
41 * @return Operation status.
42 */
43 GoFx(kStatus) GoSetup_EnableBackgroundSuppression(GoSetup setup, kBool enabled);
44 #ifndef EXPERIMENTAL_FEATURES_ENABLED
45 kDeprecate(GoSetup_EnableBackgroundSuppression)
46 #endif // !EXPERIMENTAL_FEATURES_ENABLED
47 
48 /**
49 * Gets the background suppression enabled value.
50 *
51 * @warning This API is experimental and may result in undefined behaviour if used incorrectly. See "Experimental Features" for more information.
52 *
53 * @public @memberof GoSetup
54 * @version Introduced in firmware 5.2.18.3
55 * @param setup GoSetup object.
56 * @return kTRUE if background supression is enabled, kFALSE otherwise.
57 */
58 GoFx(kBool) GoSetup_BackgroundSuppressionEnabled(GoSetup setup);
59 #ifndef EXPERIMENTAL_FEATURES_ENABLED
60 kDeprecate(GoSetup_BackgroundSuppressionEnabled)
61 #endif
62 
63 /**
64 * Sets the background suppression ratio value.
65 *
66 * @warning This API is experimental and may result in undefined behaviour if used incorrectly. See "Experimental Features" for more information.
67 *
68 * @public @memberof GoSetup
69 * @version Introduced in firmware 5.2.18.3
70 * @param setup GoSetup object.
71 * @param ratio Background supression ratio value.
72 * @return Operation status.
73 */
74 GoFx(kStatus) GoSetup_SetBackgroundSuppressionRatio(GoSetup setup, k64u ratio);
75 #ifndef EXPERIMENTAL_FEATURES_ENABLED
76 kDeprecate(GoSetup_SetBackgroundSuppressionRatio)
77 #endif
78 
79 /**
80 * Gets the background suppression ratio value.
81 *
82 * @warning This API is experimental and may result in undefined behaviour if used incorrectly. See "Experimental Features" for more information.
83 *
84 * @public @memberof GoSetup
85 * @version Introduced in firmware 5.2.18.3
86 * @param setup GoSetup object.
87 * @return Background suppression ratio.
88 */
89 GoFx(k64u) GoSetup_BackgroundSuppressionRatio(GoSetup setup);
90 #ifndef EXPERIMENTAL_FEATURES_ENABLED
91 kDeprecate(GoSetup_BackgroundSuppressionRatio)
92 #endif
93 
94 /**
95 * Enables the trigger burst.
96 *
97 * @warning This API is experimental and may result in undefined behaviour if used incorrectly. See "Experimental Features" for more information.
98 *
99 * @public @memberof GoSetup
100 * @version Introduced in firmware 4.8.2.76
101 * @param setup GoSetup object.
102 * @param enable enable state.
103 * @return Operation status.
104 */
105 GoFx(kStatus) GoSetup_SetTriggerBurstEnabled(GoSetup setup, kBool enable);
106 #ifndef EXPERIMENTAL_FEATURES_ENABLED
107 kDeprecate(GoSetup_SetTriggerBurstEnabled)
108 #endif
109 
110 /**
111 * This API is experimental and may change in a future release
112 * Gets the trigger burst enabled state.
113 *
114 * @public @memberof GoSetup
115 * @version Introduced in firmware 4.8.2.76
116 * @param setup GoSetup object.
117 * @return Operation status.
118 */
119 GoFx(kBool) GoSetup_TriggerBurstEnabled(GoSetup setup);
120 #ifndef EXPERIMENTAL_FEATURES_ENABLED
121 kDeprecate(GoSetup_TriggerBurstEnabled)
122 #endif
123 
124 /**
125 * This API is experimental and may change in a future release
126 * Gets the trigger burst enabled state.
127 *
128 * @public @memberof GoSetup
129 * @version Introduced in firmware 4.8.2.76
130 * @param setup GoSetup object.
131 * @return Operation status.
132 */
133 GoFx(kBool) GoSetup_TriggerBurstEnabledUsed(GoSetup setup);
134 #ifndef EXPERIMENTAL_FEATURES_ENABLED
135 kDeprecate(GoSetup_TriggerBurstEnabledUsed)
136 #endif
137 
138 /**
139 * This API is experimental and may change in a future release
140 * Gets the trigger burst count.
141 *
142 * @public @memberof GoSetup
143 * @version Introduced in firmware 4.8.2.76
144 * @param setup GoSetup object.
145 * @return Burst count.
146 */
147 GoFx(k32u) GoSetup_TriggerBurstCount(GoSetup setup);
148 #ifndef EXPERIMENTAL_FEATURES_ENABLED
149 kDeprecate(GoSetup_TriggerBurstCount)
150 #endif
151 
152 /**
153 * This API is experimental and may change in a future release
154 * Sets the trigger burst count.
155 *
156 * @public @memberof GoSetup
157 * @version Introduced in firmware 4.8.2.76
158 * @param setup GoSetup object.
159 * @param count Burst count.
160 * @return Operation status.
161 */
162 GoFx(kStatus) GoSetup_SetTriggerBurstCount(GoSetup setup, k32u count);
163 #ifndef EXPERIMENTAL_FEATURES_ENABLED
164 kDeprecate(GoSetup_SetTriggerBurstCount)
165 #endif
166 
167 /**
168 * This API is experimental and may change in a future release
169 * Gets the trigger burst used value.
170 *
171 * @public @memberof GoSetup
172 * @version Introduced in firmware 4.8.2.76
173 * @param setup GoSetup object.
174 * @return Operation status.
175 */
176 GoFx(kBool) GoSetup_TriggerBurstCountUsed(GoSetup setup);
177 #ifndef EXPERIMENTAL_FEATURES_ENABLED
178 kDeprecate(GoSetup_TriggerBurstCountUsed)
179 #endif
180 
181 /**
182 * This API is experimental and may change in a future release
183 * Gets the laser sleep mode used value
184 *
185 * @public @memberof GoSetup
186 * @version Introduced in firmware 4.8.2.76
187 * @param setup GoSetup object.
188 * @return Operation status.
189 */
190 GoFx(kBool) GoSetup_LaserSleepUsed(GoSetup setup);
191 #ifndef EXPERIMENTAL_FEATURES_ENABLED
192 kDeprecate(GoSetup_LaserSleepUsed)
193 #endif
194 
195 /**
196 * This API is experimental and may change in a future release
197 * Enables laser sleep mode
198 *
199 * @public @memberof GoSetup
200 * @version Introduced in firmware 4.8.2.76
201 * @param setup GoSetup object.
202 * @param enable enable state
203 * @return Operation status.
204 */
205 GoFx(kStatus) GoSetup_SetLaserSleepModeEnabled(GoSetup setup, kBool enable);
206 #ifndef EXPERIMENTAL_FEATURES_ENABLED
207 kDeprecate(GoSetup_SetLaserSleepModeEnabled)
208 #endif
209 
210 /**
211 * This API is experimental and may change in a future release
212 * Gets the laser sleep mode enabled state.
213 *
214 * @public @memberof GoSetup
215 * @version Introduced in firmware 4.8.2.76
216 * @param setup GoSetup object.
217 * @return Operation status.
218 */
219 GoFx(kBool) GoSetup_LaserSleepModeEnabled(GoSetup setup);
220 #ifndef EXPERIMENTAL_FEATURES_ENABLED
221 kDeprecate(GoSetup_LaserSleepModeEnabled)
222 #endif
223 
224 /**
225 * This API is experimental and may change in a future release
226 * Sets the time before the laser deactivates
227 *
228 * @public @memberof GoSetup
229 * @version Introduced in firmware 4.8.2.76
230 * @param setup GoSetup object.
231 * @param time idle time. (microseconds)
232 * @return Operation status.
233 */
234 GoFx(kStatus) GoSetup_SetLaserIdleTime(GoSetup setup, k64u time);
235 #ifndef EXPERIMENTAL_FEATURES_ENABLED
236 kDeprecate(GoSetup_SetLaserIdleTime)
237 #endif
238 
239 /**
240 * This API is experimental and may change in a future release
241 * Gets the idle time before laser deactivation
242 *
243 * @public @memberof GoSetup
244 * @version Introduced in firmware 4.8.2.76
245 * @param setup GoSetup object.
246 * @return Operation status.
247 */
248 GoFx(k64u) GoSetup_LaserIdleTime(GoSetup setup);
249 #ifndef EXPERIMENTAL_FEATURES_ENABLED
250 kDeprecate(GoSetup_LaserIdleTime)
251 #endif
252 
253 /**
254 * This API is experimental and may change in a future release
255 * Sets the encoder wakeup travel distance
256 *
257 * @public @memberof GoSetup
258 * @version Introduced in firmware 4.8.2.76
259 * @param setup GoSetup object.
260 * @param distance distance (mm)
261 * @return Operation status.
262 */
263 GoFx(kStatus) GoSetup_SetLaserWakeupEncoderTravel(GoSetup setup, k64u distance);
264 #ifndef EXPERIMENTAL_FEATURES_ENABLED
265 kDeprecate(GoSetup_SetLaserWakeupEncoderTravel)
266 #endif
267 
268 /**
269 * This API is experimental and may change in a future release
270 * Gets the encoder wakeup travel distance
271 *
272 * @public @memberof GoSetup
273 * @version Introduced in firmware 4.8.2.76
274 * @param setup GoSetup object.
275 * @return Operation status.
276 */
277 GoFx(k64u) GoSetup_LaserWakeupEncoderTravel(GoSetup setup);
278 #ifndef EXPERIMENTAL_FEATURES_ENABLED
279 kDeprecate(GoSetup_LaserWakeupEncoderTravel)
280 #endif
281 
282 /**
283 * This API is experimental and may change in a future release
284 * Returns whether or not auto encoder reversal distance can be enabled.
285 *
286 * @public @memberof GoSetup
287 * @version Introduced in firmware 4.8.2.76
288 * @param setup GoSetup object.
289 * @return Used flag.
290 */
291 GoFx(kBool) GoSetup_ReversalDistanceAutoEnabledUsed(GoSetup setup);
292 #ifndef EXPERIMENTAL_FEATURES_ENABLED
293 kDeprecate(GoSetup_ReversalDistanceAutoEnabledUsed)
294 #endif
295 
296 /**
297 * This API is experimental and may change in a future release
298 * Returns whether or not auto encoder reversal distance is enabled.
299 *
300 * @public @memberof GoSetup
301 * @version Introduced in firmware 4.8.2.76
302 * @param setup GoSetup object.
303 * @return Enabled status.
304 */
305 GoFx(kBool) GoSetup_ReversalDistanceAutoEnabled(GoSetup setup);
306 #ifndef EXPERIMENTAL_FEATURES_ENABLED
307 kDeprecate(GoSetup_ReversalDistanceAutoEnabled)
308 #endif
309 
310 /**
311 * This API is experimental and may change in a future release
312 * Enables or disables auto encoder reversal distance.
313 *
314 * @public @memberof GoSetup
315 * @version Introduced in firmware 4.8.2.76
316 * @param setup GoSetup object.
317 * @param enabled Enabled flag.
318 * @return Operation status.
319 */
320 GoFx(kStatus) GoSetup_SetReversalDistanceAutoEnabled(GoSetup setup, kBool enabled);
321 #ifndef EXPERIMENTAL_FEATURES_ENABLED
322 kDeprecate(GoSetup_SetReversalDistanceAutoEnabled)
323 #endif
324 
325 /**
326 * This API is experimental and may change in a future release
327 * Gets the encoder reversal distance threshold used value
328 *
329 * @public @memberof GoSetup
330 * @version Introduced in firmware 4.8.2.76
331 * @param setup GoSetup object.
332 * @return Operation status.
333 */
334 GoFx(kBool) GoSetup_ReversalDistanceUsed(GoSetup setup);
335 #ifndef EXPERIMENTAL_FEATURES_ENABLED
336 kDeprecate(GoSetup_ReversalDistanceUsed)
337 #endif
338 
339 /**
340 * This API is experimental and may change in a future release
341 * Sets the encoder reversal distance threshold
342 *
343 * @public @memberof GoSetup
344 * @version Introduced in firmware 4.8.2.76
345 * @param setup GoSetup object.
346 * @param threshold threshold for encoder reversal distance before switching directions (specified as multiple of the spacing interval)
347 * @return Operation status.
348 */
349 GoFx(kStatus) GoSetup_SetReversalDistance(GoSetup setup, k64f threshold);
350 #ifndef EXPERIMENTAL_FEATURES_ENABLED
351 kDeprecate(GoSetup_SetReversalDistance)
352 #endif
353 
354 /**
355 * This API is experimental and may change in a future release
356 * Gets the encoder reversal distance threshold.
357 *
358 * @public @memberof GoSetup
359 * @version Introduced in firmware 4.8.2.76
360 * @param setup GoSetup object.
361 * @return Operation status.
362 */
363 GoFx(k64f) GoSetup_ReversalDistance(GoSetup setup);
364 #ifndef EXPERIMENTAL_FEATURES_ENABLED
365 kDeprecate(GoSetup_ReversalDistance)
366 #endif
367 
368 /**
369 * This API is experimental and may change in a future release
370 * Gets the encoder reversal distance threshold system value.
371 *
372 * @public @memberof GoSetup
373 * @version Introduced in firmware 4.8.2.76
374 * @param setup GoSetup object.
375 * @return Operation status.
376 */
377 GoFx(k64f) GoSetup_ReversalDistanceSystemValue(GoSetup setup);
378 #ifndef EXPERIMENTAL_FEATURES_ENABLED
379 kDeprecate(GoSetup_ReversalDistanceSystemValue)
380 #endif
381 
382 /**
383 * Enables the temperature saftey of the sensor system.
384 *
385 * @public @memberof GoSetup
386  * @version Introduced in firmware 4.8.2.76
387 * @param setup GoSetup object.
388 * @param enable kBool.
389 * @return Operation status.
390 */
391 GoFx(kStatus) GoSetup_EnableTemperatureSafety(GoSetup setup, kBool enable);
392 
393 /**
394  * Sets the scan mode.
395  *
396  * @public @memberof GoSetup
397  * @version Introduced in firmware 4.8.2.76
398  * @param setup GoSetup object.
399  * @param mode Operation mode.
400  * @return Operation status.
401  */
402 GoFx(kStatus) GoSetup_SetScanMode(GoSetup setup, GoMode mode);
403 
404 /**
405  * Gets the scan mode
406  *
407  * @public @memberof GoSetup
408  * @version Introduced in firmware 4.8.2.76
409  * @param setup GoSetup object.
410  * @return Operation mode.
411  */
412 GoFx(GoMode) GoSetup_ScanMode(GoSetup setup);
413 
414 /**
415  * Gets the scan mode option at the specified index.
416  *
417  * @public @memberof GoSetup
418  * @version Introduced in firmware 4.0.10.27
419  * @param setup GoSetup object.
420  * @param index The index with which to retrieve a mode option.
421  * @return Operation mode.
422  * @see GoSetup_ScanModeOptionCount
423  */
424 GoFx(GoMode) GoSetup_ScanModeOptionAt(GoSetup setup, kSize index);
425 
426 /**
427  * Gets the scan mode option count.
428  *
429  * @public @memberof GoSetup
430  * @version Introduced in firmware 4.0.10.27
431  * @param setup GoSetup object.
432  * @return Scan mode option count.
433  */
434 GoFx(kSize) GoSetup_ScanModeOptionCount(GoSetup setup);
435 
436 /**
437  * Gets the user specified Uniform Spacing enabled state.
438  *
439  * @public @memberof GoSetup
440  * @note Supported with G2
441  * @version Introduced in firmware 4.0.10.27
442  * @param setup GoSetup object.
443  * @return kTRUE if enabled and kFALSE otherwise.
444  * @see GoSetup_UniformSpacingAvailable
445  */
446 GoFx(kBool) GoSetup_UniformSpacingEnabled(GoSetup setup);
447 
448 /**
449  * Sets the user specified Uniform Spacing enabled state.
450  *
451  * @public @memberof GoSetup
452  * @note Supported with G2
453  * @version Introduced in firmware 4.0.10.27
454  * @param setup GoSetup object.
455  * @param enable kTRUE to enable it and kFALSE to disable it.
456  * @return Operation status.
457  * @see GoSetup_UniformSpacingAvailable
458  */
459 GoFx(kStatus) GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable);
460 
461 /**
462  * Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used at the moment.
463  *
464  * @public @memberof GoSetup
465  * @note Supported with G2
466  * @version Introduced in firmware 4.0.10.27
467  * @param setup GoSetup object.
468  * @return kTRUE if the user specified Uniform Spacing setting is used and kFALSE otherwise.
469  */
470 GoFx(kBool) GoSetup_UniformSpacingAvailable(GoSetup setup);
471 
472 /**
473  * Gets the Uniform Spacing enabled system value.
474  *
475  * @public @memberof GoSetup
476  * @note Supported with G2
477  * @version Introduced in firmware 4.0.10.27
478  * @param setup GoSetup object.
479  * @return kTRUE if enabled and kFALSE otherwise.
480  * @see GoSetup_UniformSpacingAvailable
481  */
482 GoFx(kBool) GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup);
483 
484 /**
485  * Sets the state of the external input triggered encoder Z-pulse feature.
486  *
487  * @public @memberof GoSetup
488  * @version Introduced in firmware 4.1.3.106
489  * @param setup GoSetup object.
490  * @param enable kTRUE to enable it and kFALSE to disable it.
491  * @return Operation status.
492  */
493 GoFx(kStatus) GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable);
494 
495 /**
496  * Gets the state of the external input triggered encoder Z-pulse feature.
497  *
498  * @public @memberof GoSetup
499  * @version Introduced in firmware 4.1.3.106
500  * @param setup GoSetup object.
501  * @return kTRUE if enabled and kFALSE otherwise.
502  */
503 GoFx(kBool) GoSetup_ExternalInputZPulseEnabled(GoSetup setup);
504 
505 /**
506  * Sets the external input index for triggering encoder Z-pulse.
507  *
508  * @public @memberof GoSetup
509  * @version Introduced in firmware 5.2.18.3
510  * @param setup GoSetup object.
511  * @param index Index of external input to use.
512  * @return Operation status.
513  */
514 GoFx(kStatus) GoSetup_SetExternalInputZPulseIndex(GoSetup setup, k32u index);
515 
516 /**
517  * Gets the external input index for triggering encoder Z-pulse.
518  *
519  * @public @memberof GoSetup
520  * @version Introduced in firmware 5.2.18.3
521  * @param setup GoSetup object.
522  * @return Index of external input used.
523  */
524 GoFx(k32u) GoSetup_ExternalInputZPulseIndex(GoSetup setup);
525 
526 /**
527  * Reports whether or not the external input index for encoder z-pulse triggering is used.
528  *
529  * @public @memberof GoSetup
530  * @version Introduced in firmware 5.2.18.3
531  * @param setup GoSetup object.
532  * @return Index is used or not.
533  */
534 GoFx(kBool) GoSetup_ExternalInputZPulseIndexAvailable(GoSetup setup);
535 
536 /**
537  * Sets whether the time and encoder values are preferred to come from the Master rather than from the sensor and its I/O port.
538  *
539  * @public @memberof GoSetup
540  * @version Introduced in firmware 4.8.2.76
541  * @param setup GoSetup object.
542  * @param enable kBool kTrue to enable kFalse to disable.
543  * @return kStatus if enabling has been successful
544  */
545 GoFx(kStatus) GoSetup_EnablePreferMasterTimeEncoderEnabled(GoSetup setup, kBool enable);
546 
547 /**
548  * Gets whether the time and encoder values are preferred to come from the Master rather than from the sensor and its I/O port.
549  *
550  * @public @memberof GoSetup
551  * @version Introduced in firmware 4.8.2.76
552  * @param setup GoSetup object.
553  * @return kTRUE if enabled and kFALSE otherwise.
554  */
555 GoFx(kBool) GoSetup_PreferMasterTimeEncoderEnabled(GoSetup setup);
556 
557 /**
558  * Sets the main sensor's transmit limit.
559  * @public @memberof GoSetup
560  * @version Introduced in firmware 6.4.39.2
561  * @param setup GoSetup object.
562  * @param limit New transmit limit to use.
563  * @return Operation status.
564  */
565 GoFx(kStatus) GoSetup_SetTransmitLimit(GoSetup setup, k32u limit);
566 
567 /**
568  * Gets the main sensor's transmit limit.
569  * @public @memberof GoSetup
570  * @version Introduced in firmware 6.4.39.2
571  * @param setup GoSetup object.
572  * @return Transmit limit.
573  */
574 GoFx(k32u) GoSetup_TransmitLimit(GoSetup setup);
575 
576 /**
577  * Gets the occlusion reduction enabled state.
578  *
579  * @public @memberof GoSetup
580  * @version Introduced in firmware 4.0.10.27
581  * @param setup GoSetup object.
582  * @return kTRUE if enabled and kFALSE otherwise.
583  */
584 GoFx(kBool) GoSetup_OcclusionReductionEnabled(GoSetup setup);
585 
586 /**
587  * Sets the occlusion reduction enabled state.
588  *
589  * @public @memberof GoSetup
590  * @version Introduced in firmware 4.0.10.27
591  * @param setup GoSetup object.
592  * @param enable kTRUE to enable it and kFALSE to disable it.
593  * @return Operation status.
594  */
595 GoFx(kStatus) GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable);
596 
597 /**
598  * Returns a boolean representing whether the user occlusion reduction configuration is used.
599  *
600  * @public @memberof GoSetup
601  * @version Introduced in firmware 4.3.3.124
602  * @param setup GoSetup object.
603  * @return kTRUE if used, or kFALSE if not used.
604  */
605 GoFx(kBool) GoSetup_OcclusionReductionEnabledUsed(GoSetup setup);
606 
607 /**
608  * Gets the occlusion reduction system value.
609  *
610  * @public @memberof GoSetup
611  * @version Introduced in firmware 4.3.3.124
612  * @param setup GoSetup object.
613  * @return kTRUE if enabled, or kFALSE if not.
614  */
615 GoFx(kBool) GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup);
616 
617 /**
618  * Gets the occlusion reduction algorithm.
619  *
620  * @public @memberof GoSetup
621  * @version Introduced in firmware 4.5.3.57
622  * @param setup GoSetup object.
623  * @return The occlusion reduction algorithm.
624  */
625 GoFx(GoOcclusionReductionAlg) GoSetup_OcclusionReductionAlg(GoSetup setup);
626 
627 /**
628  * Sets the occlusion reduction algorithm.
629  *
630  * @public @memberof GoSetup
631  * @version Introduced in firmware 4.5.3.57
632  * @param setup GoSetup object.
633  * @param alg The algorithm to use for occlusion reduction.
634  * @return Operation status.
635  */
636 GoFx(kStatus) GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg);
637 
638 /**
639  * Returns a boolean representing whether the user occlusion reduction algorithm is used.
640  *
641  * @public @memberof GoSetup
642  * @version Introduced in firmware 4.5.3.57
643  * @param setup GoSetup object.
644  * @return kTRUE if used, or kFALSE if not used.
645  */
646 GoFx(kBool) GoSetup_OcclusionReductionAlgUsed(GoSetup setup);
647 
648 //class - trigger
649 
650 /**
651  * Sets the system trigger units.
652  * Ignored if GoSetup_TriggerSource is time or encoder
653  *
654  * @public @memberof GoSetup
655  * @version Introduced in firmware 4.0.10.27
656  * @param setup GoSetup object.
657  * @param unit The system trigger unit.
658  * @return Operation status.
659  */
660 GoFx(kStatus) GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit);
661 
662 /**
663  * Gets the system trigger units.
664  * Ignored if GoSetup_TriggerSource is time or encoder
665  *
666  * @public @memberof GoSetup
667  * @version Introduced in firmware 4.0.10.27
668  * @param setup GoSetup object.
669  * @return The system domain.
670  */
671 GoFx(GoTriggerUnits) GoSetup_TriggerUnit(GoSetup setup);
672 
673 /**
674  * Sets the trigger source for profile triggering.
675  *
676  * @public @memberof GoSetup
677  * @version Introduced in firmware 4.0.10.27
678  * @param setup GoSetup object.
679  * @param source Profile trigger source.
680  * @return Operation status.
681  */
682 GoFx(kStatus) GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source);
683 
684 /**
685  * Gets the trigger source for profile triggering.
686  *
687  * @public @memberof GoSetup
688  * @version Introduced in firmware 4.0.10.27
689  * @param setup GoSetup object.
690  * @return Profile trigger source.
691  */
692 GoFx(GoTrigger) GoSetup_TriggerSource(GoSetup setup);
693 
694 /**
695  * Gets the count of available trigger source options.
696  *
697  * @public @memberof GoSetup
698  * @version Introduced in firmware 5.1.3.14
699  * @param setup GoSetup object.
700  * @return Count of trigger source options.
701  */
702 GoFx(kSize) GoSetup_TriggerSourceOptionCount(GoSetup setup);
703 
704 /**
705  * Gets the trigger source option at the given index.
706  *
707  * @public @memberof GoSetup
708  * @version Introduced in firmware 5.1.3.14
709  * @param setup GoSetup object.
710  * @param index The index with which to retrieve the trigger source option.
711  * @return The trigger source option.
712  * @see GoSetup_TriggerSourceOptionCount
713  */
714 GoFx(GoAlignmentTarget) GoSetup_TriggerSourceOptionAt(GoSetup setup, kSize index);
715 
716 /**
717  * Gets the flag indicating whether the external input trigger is being used.
718  *
719  * @public @memberof GoSetup
720  * @version Introduced in firmware 5.1.3.14
721  * @param setup GoSetup object.
722  * @return TRUE if being used, FALSE otherwise.
723  */
724 GoFx(kBool) GoSetup_TriggerExternalInputIndexUsed(GoSetup setup);
725 
726 /**
727  * Sets the external input index to trigger profile/surface capturing.
728  *
729  * @public @memberof GoSetup
730  * @version Introduced in firmware 5.1.3.14
731  * @param setup GoSetup object.
732  * @param index External digital input index.
733  * @return Operation status.
734  */
735 GoFx(kStatus) GoSetup_SetTriggerExternalInputIndex(GoSetup setup, k32s index);
736 
737 /**
738  * Gets the external input index to trigger profile/surface capturing.
739  *
740  * @public @memberof GoSetup
741  * @version Introduced in firmware 5.1.3.14
742  * @param setup GoSetup object.
743  * @return External input index to trigger capturing.
744  */
745 GoFx(k32s) GoSetup_TriggerExternalInputIndex(GoSetup setup);
746 
747 /**
748  * Gets the count of available external input trigger index options.
749  *
750  * @public @memberof GoSetup
751  * @version Introduced in firmware 5.1.3.14
752  * @param setup GoSetup object.
753  * @return Count of external input index options.
754  */
755 GoFx(kSize) GoSetup_TriggerExternalInputIndexOptionCount(GoSetup setup);
756 
757 /**
758  * Gets the external input trigger option at the given index.
759  *
760  * @public @memberof GoSetup
761  * @version Introduced in firmware 5.1.3.14
762  * @param setup GoSetup object.
763  * @param index The index with which to retrieve the external input index option.
764  * @return The external input index option.
765  * @see GoSetup_TriggerExternalInputIndexOptionCount
766  */
767 GoFx(GoAlignmentTarget) GoSetup_TriggerExternalInputIndexOptionAt(GoSetup setup, kSize index);
768 
769 /**
770  * Sets the trigger delay. Depending on GoDomain, units are uS or mm.
771  *
772  * @public @memberof GoSetup
773  * @version Introduced in firmware 4.0.10.27
774  * @param setup GoSetup object.
775  * @param delay Trigger delay (uS or mm).
776  * @return Operation status.
777  */
778 GoFx(kStatus) GoSetup_SetTriggerDelay(GoSetup setup, k64f delay);
779 
780 /**
781  * Gets the trigger delay. Depending on GoDomain, units are uS or mm.
782  *
783  * @public @memberof GoSetup
784  * @version Introduced in firmware 4.0.10.27
785  * @param setup GoSetup object.
786  * @return Trigger delay (uS or mm).
787  */
788 GoFx(k64f) GoSetup_TriggerDelay(GoSetup setup);
789 
790 /**
791  * Reports the minimum trigger delay, based on current settings.
792  * Depending on GoDomain, units are uS or mm.
793  *
794  * @public @memberof GoSetup
795  * @version Introduced in firmware 4.0.10.27
796  * @param setup GoSetup object.
797  * @return Minimum trigger delay (uS or mm).
798  */
799 GoFx(k64f) GoSetup_TriggerDelayLimitMin(GoSetup setup);
800 
801 /**
802  * Reports the maximum trigger delay, based on current settings.
803  * Depending on GoDomain, units are uS or mm.
804  *
805  * @public @memberof GoSetup
806  * @version Introduced in firmware 4.0.10.27
807  * @param setup GoSetup object.
808  * @return Maximum trigger delay (uS or mm).
809  */
810 GoFx(k64f) GoSetup_TriggerDelayLimitMax(GoSetup setup);
811 
812 /**
813  * Sets the trigger gate feature.
814  *
815  * @public @memberof GoSetup
816  * @version Introduced in firmware 4.0.10.27
817  * @param setup GoSetup object.
818  * @param enable Enables trigger gate operation.
819  * @return Operation status.
820  */
821 GoFx(kStatus) GoSetup_EnableTriggerGate(GoSetup setup, kBool enable);
822 
823 /**
824  * Reports whether the trigger gate feature is currently enabled.
825  *
826  * @public @memberof GoSetup
827  * @version Introduced in firmware 4.0.10.27
828  * @param setup GoSetup object.
829  * @return kTRUE if enabled, or kFALSE if disabled.
830  */
831 GoFx(kBool) GoSetup_TriggerGateEnabled(GoSetup setup);
832 
833 /**
834  * Gets the system value representing whether or not the user specified trigger gate enabled setting is being used at the moment.
835  *
836  * @public @memberof GoSetup
837  * @version Introduced in firmware 4.0.10.27
838  * @param setup GoSetup object.
839  * @return kTRUE if the user specified setting is used and kFALSE otherwise.
840  */
841 GoFx(kBool) GoSetup_TriggerGateEnabledUsed(GoSetup setup);
842 
843 /**
844  * Reports the trigger gate enabled system value.
845  *
846  * @public @memberof GoSetup
847  * @version Introduced in firmware 4.0.10.27
848  * @param setup GoSetup object.
849  * @return kTRUE if enabled, or kFALSE if disabled.
850  */
851 GoFx(kBool) GoSetup_TriggerGateEnabledSystemValue(GoSetup setup);
852 
853 /**
854  * Enables or disables operation at full frame rate (ignoring frame rate setting).
855  *
856  * @public @memberof GoSetup
857  * @version Introduced in firmware 4.0.10.27
858  * @param setup GoSetup object.
859  * @param enable Enables full frame rate operation.
860  * @return Operation status.
861  */
862 GoFx(kStatus) GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable);
863 
864 /**
865  * Reports whether or not system is configured to operate at full frame rate.
866  *
867  * @public @memberof GoSetup
868  * @version Introduced in firmware 4.0.10.27
869  * @param setup GoSetup object.
870  * @return True if system operates at full frame rate; false otherwise.
871  */
872 GoFx(kBool) GoSetup_MaxFrameRateEnabled(GoSetup setup);
873 
874 /**
875  * Sets the current frame rate for time-based triggering. The maximum frame
876  * rate option must be disabled to use the value set in this function.
877  *
878  * @public @memberof GoSetup
879  * @version Introduced in firmware 4.0.10.27
880  * @param setup GoSetup object.
881  * @param frameRate Frame Rate value (Hz).
882  * @return Operation status.
883  * @see GoSetup_EnableMaxFrameRate, GoSetup_MaxFrameRateEnabled
884  */
885 GoFx(kStatus) GoSetup_SetFrameRate(GoSetup setup, k64f frameRate);
886 
887 /**
888  * Reports the currently configured frame rate.
889  *
890  * @public @memberof GoSetup
891  * @version Introduced in firmware 4.0.10.27
892  * @param setup GoSetup object.
893  * @return Currently configured frame rate (Hz).
894  */
895 GoFx(k64f) GoSetup_FrameRate(GoSetup setup);
896 
897 /**
898 * Reports the current frame rate of Tracheid data
899 *
900 * @public @memberof GoSetup
901 * @version Introduced in firmware 4.8.0.35
902 * @param setup GoSetup object.
903 * @return Tracheid frame rate (Hz).
904 */
905 GoFx(k64f) GoSetup_TracheidRate(GoSetup setup);
906 
907 /**
908 * Reports the current frame rate of normal (range, profile, or surface) data
909 *
910 * @public @memberof GoSetup
911 * @version Introduced in firmware 4.8.0.35
912 * @param setup GoSetup object.
913 * @return Frame Data Rate (Hz).
914 */
915 GoFx(k64f) GoSetup_FrameDataRate(GoSetup setup);
916 
917 /**
918  * Constraint for the minimum valid value of the Frame Rate setting.
919  *
920  * @public @memberof GoSetup
921  * @version Introduced in firmware 4.0.10.27
922  * @param setup GoSetup object.
923  * @return Minimum valid Frame Rate setting (Hz).
924  */
925 GoFx(k64f) GoSetup_FrameRateLimitMin(GoSetup setup);
926 
927 /**
928  * Constraint for the maximum valid value of the Frame Rate setting.
929  *
930  * @public @memberof GoSetup
931  * @version Introduced in firmware 4.0.10.27
932  * @param setup GoSetup object.
933  * @return Maximum valid Frame Rate setting (Hz).
934  */
935 GoFx(k64f) GoSetup_FrameRateLimitMax(GoSetup setup);
936 
937 /**
938  * Sets the encoder trigger mode.
939  *
940  * @public @memberof GoSetup
941  * @version Introduced in firmware 4.0.10.27
942  * @param setup GoSetup object.
943  * @param mode Encoder trigger mode.
944  * @return Operation status.
945  */
946 GoFx(kStatus) GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode);
947 
948 /**
949  * Gets the encoder trigger mode.
950  *
951  * @public @memberof GoSetup
952  * @version Introduced in firmware 4.0.10.27
953  * @param setup GoSetup object.
954  * @return Encoder trigger mode.
955  */
956 GoFx(GoEncoderTriggerMode) GoSetup_EncoderTriggerMode(GoSetup setup);
957 
958 /**
959  * Sets the current encoder period for encoder-based triggering.
960  *
961  * @public @memberof GoSetup
962  * @version Introduced in firmware 4.0.10.27
963  * @param setup GoSetup object.
964  * @param period Encoder period (mm).
965  * @return Operation status.
966  */
967 GoFx(kStatus) GoSetup_SetEncoderSpacing(GoSetup setup, k64f period);
968 
969 /**
970  * Gets the current encoder period for encoder-based triggering.
971  *
972  * @public @memberof GoSetup
973  * @version Introduced in firmware 4.0.10.27
974  * @param setup GoSetup object.
975  * @return Encoder period (mm).
976  */
977 GoFx(k64f) GoSetup_EncoderSpacing(GoSetup setup);
978 
979 /**
980  * Constraint for the minimum valid value of the Encoder Period setting.
981  *
982  * @public @memberof GoSetup
983  * @version Introduced in firmware 4.0.10.27
984  * @param setup GoSetup object.
985  * @return Minimum valid Encoder Period setting (mm).
986  */
987 GoFx(k64f) GoSetup_EncoderSpacingLimitMin(GoSetup setup);
988 
989 /**
990  * Constraint for the maximum valid value of the Encoder Period setting.
991  *
992  * @public @memberof GoSetup
993  * @version Introduced in firmware 4.0.10.27
994  * @param setup GoSetup object.
995  * @return Maximum valid Encoder Period setting (mm).
996  */
997 GoFx(k64f) GoSetup_EncoderSpacingLimitMax(GoSetup setup);
998 
999 /**
1000  * Enables profile intensity collection.
1001  *
1002  * @public @memberof GoSetup
1003  * @version Introduced in firmware 4.0.10.27
1004  * @param setup GoSetup object.
1005  * @param enable kTRUE to enable, or kFALSE to disable.
1006  * @return Operation status.
1007  */
1008 GoFx(kStatus) GoSetup_EnableIntensity(GoSetup setup, kBool enable);
1009 
1010 /**
1011  * Reports whether the profile intensity collection is enabled.
1012  *
1013  * @public @memberof GoSetup
1014  * @version Introduced in firmware 4.0.10.27
1015  * @param setup GoSetup object.
1016  * @return kTRUE if enabled, or kFALSE if disabled.
1017  */
1018 GoFx(kBool) GoSetup_IntensityEnabled(GoSetup setup);
1019 
1020 /**
1021 * Enables flicker reduction mode.
1022 *
1023 * @public @memberof GoSetup
1024 * @version Introduced in firmware 4.6.2.31
1025 * @param setup GoSetup object.
1026 * @param enable kTRUE to enable, or kFALSE to disable.
1027 * @return Operation status.
1028 */
1029 GoFx(kStatus) GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable);
1030 
1031 
1032 /**
1033 * Reports whether flicker free mode is enabled.
1034 *
1035 * @public @memberof GoSetup
1036 * @version Introduced in firmware 4.6.2.31
1037 * @param setup GoSetup object.
1038 * @return kTRUE if enabled, or kFALSE if disabled.
1039 */
1040 GoFx(kBool) GoSetup_FlickerFreeModeEnabled(GoSetup setup);
1041 
1042 /**
1043 * Reports whether flicker free mode is available for use on this sensor.
1044 *
1045 * @public @memberof GoSetup
1046 * @version Introduced in firmware 4.6.2.31
1047 * @param setup GoSetup object.
1048 * @return kTRUE if available, or kFALSE if not.
1049 */
1050 GoFx(kBool) GoSetup_FlickerFreeModeAvailable(GoSetup setup);
1051 
1052 //class - alignment
1053 
1054 /**
1055  * Gets the input trigger enabled state.
1056  *
1057  * @public @memberof GoSetup
1058  * @version Introduced in firmware 4.0.10.27
1059  * @param setup GoSetup object.
1060  * @return kTRUE if enabled and kFALSE otherwise.
1061  */
1062 GoFx(kBool) GoSetup_InputTriggerEnabled(GoSetup setup);
1063 
1064 /**
1065  * Returns a boolean representing whether the user input trigger configuration is used.
1066  *
1067  * @public @memberof GoSetup
1068  * @version Introduced in firmware 4.3.3.124
1069  * @param setup GoSetup object.
1070  * @return kTRUE if used, or kFALSE if not used.
1071  */
1072 GoFx(kBool) GoSetup_InputTriggerEnabledUsed(GoSetup setup);
1073 
1074 /**
1075  * Gets the input trigger system value.
1076  *
1077  * @public @memberof GoSetup
1078  * @version Introduced in firmware 4.3.3.124
1079  * @param setup GoSetup object.
1080  * @return kTRUE if enabled, or kFALSE if not.
1081  */
1082 GoFx(kBool) GoSetup_InputTriggerEnabledSystemValue(GoSetup setup);
1083 
1084 /**
1085  * Sets the input trigger enabled state.
1086  *
1087  * @public @memberof GoSetup
1088  * @version Introduced in firmware 4.0.10.27
1089  * @param setup GoSetup object.
1090  * @param enable kTRUE to enable it and kFALSE to disable it.
1091  */
1092 GoFx(kStatus) GoSetup_EnableInputTrigger(GoSetup setup, kBool enable);
1093 
1094 /**
1095  * Indicates whether alignment can be used.
1096  *
1097  * @public @memberof GoSetup
1098  * @version Introduced in firmware 4.5.3.57
1099  * @param setup GoSetup object.
1100  * @return True if alignment is available for use.
1101  */
1102 GoFx(kBool) GoSetup_AlignmentUsed(GoSetup setup);
1103 
1104 /**
1105  * Sets the type used for alignment.
1106  *
1107  * @public @memberof GoSetup
1108  * @version Introduced in firmware 4.0.10.27
1109  * @param setup GoSetup object.
1110  * @param type Alignment type (stationary or moving).
1111  * @return Operation status.
1112  */
1113 GoFx(kStatus) GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type);
1114 
1115 /**
1116  * Gets the type used for alignment calibration.
1117  *
1118  * @public @memberof GoSetup
1119  * @version Introduced in firmware 4.0.10.27
1120  * @param setup GoSetup object.
1121  * @return Alignment type (stationary or moving).
1122  */
1123 GoFx(GoAlignmentType) GoSetup_AlignmentType(GoSetup setup);
1124 
1125 /**
1126  * Gets the alignment type option at the given index.
1127  *
1128  * @public @memberof GoSetup
1129  * @version Introduced in firmware 4.0.10.27
1130  * @param setup GoSetup object.
1131  * @param index The index with which to retrieve an alignment type option.
1132  * @return Alignment type option.
1133  * @see GoSetup_AlignmentTypeOptionCount
1134  */
1135 GoFx(GoAlignmentType) GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index);
1136 
1137 /**
1138  * Gets the alignment type option count.
1139  *
1140  * @public @memberof GoSetup
1141  * @version Introduced in firmware 4.0.10.27
1142  * @param setup GoSetup object.
1143  * @return Alignment type option count.
1144  */
1145 GoFx(kSize) GoSetup_AlignmentTypeOptionCount(GoSetup setup);
1146 
1147 /**
1148  * Enables encoder calibration after alignment.
1149  *
1150  * @public @memberof GoSetup
1151  * @version Introduced in firmware 4.0.10.27
1152  * @param setup GoSetup object.
1153  * @param enabled kTRUE to enable encoder calibration after alignment, kFALSE to disable it.
1154  * @return Operation status.
1155  */
1156 GoFx(kStatus) GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled);
1157 
1158 /**
1159  * Gets the value of the post alignment encoder calibration setting.
1160  *
1161  * @public @memberof GoSetup
1162  * @version Introduced in firmware 4.0.10.27
1163  * @param setup GoSetup object.
1164  * @return kTRUE if post alignment encoder calibration is enabled. kFALSE otherwise.
1165  */
1166 GoFx(kBool) GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup);
1167 
1168 /**
1169  * Sets the target type used for stationary alignment calibration.
1170  *
1171  * @public @memberof GoSetup
1172  * @version Introduced in firmware 4.0.10.27
1173  * @param setup GoSetup object.
1174  * @param target Alignment target type.
1175  * @return Operation status.
1176  */
1177 GoFx(kStatus) GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target);
1178 
1179 /**
1180  * Gets the target type used for stationary alignment calibration.
1181  *
1182  * @public @memberof GoSetup
1183  * @version Introduced in firmware 4.0.10.27
1184  * @param setup GoSetup object.
1185  * @return Alignment target type.
1186  */
1187 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTarget(GoSetup setup);
1188 
1189 /**
1190  * Gets the stationary alignment target option count.
1191  *
1192  * @public @memberof GoSetup
1193  * @version Introduced in firmware 4.0.10.27
1194  * @param setup GoSetup object.
1195  * @return The alignment target count.
1196  */
1197 GoFx(kSize) GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup);
1198 
1199 /**
1200  * Gets the stationary alignment target option at the given index.
1201  *
1202  * @public @memberof GoSetup
1203  * @version Introduced in firmware 4.0.10.27
1204  * @param setup GoSetup object.
1205  * @param index The index with which to retrieve an alignment target.
1206  * @return The alignment target option.
1207  * @see GoSetup_AlignmentStationaryTargetOptionCount
1208  */
1209 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index);
1210 
1211 /**
1212  * Sets the target type used for moving alignment calibration.
1213  *
1214  * @public @memberof GoSetup
1215  * @note Supported with G1, G2
1216  * @version Introduced in firmware 4.0.10.27
1217  * @param setup GoSetup object.
1218  * @param target Alignment target type.
1219  * @return Operation status.
1220  */
1221 GoFx(kStatus) GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target);
1222 
1223 /**
1224  * Gets the target type used for moving alignment calibration.
1225  *
1226  * @public @memberof GoSetup
1227  * @note Supported with G1, G2
1228  * @version Introduced in firmware 4.0.10.27
1229  * @param setup GoSetup object.
1230  * @return Alignment target type.
1231  */
1232 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTarget(GoSetup setup);
1233 
1234 /**
1235  * Gets the moving alignment target option count.
1236  *
1237  * @public @memberof GoSetup
1238  * @note Supported with G1, G2
1239  * @version Introduced in firmware 4.0.10.27
1240  * @param setup GoSetup object.
1241  * @return The alignment target count.
1242  */
1243 GoFx(kSize) GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup);
1244 
1245 /**
1246 * Gets the moving alignment target option at the given index.
1247 *
1248 * @public @memberof GoSetup
1249 * @note Supported with G1, G2
1250 * @version Introduced in firmware 4.0.10.27
1251 * @param setup GoSetup object.
1252 * @param index The index with which to retrieve an alignment target.
1253 * @return The alignment target option.
1254 * @see GoSetup_AlignmentMovingTargetOptionCount
1255 */
1256 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index);
1257 
1258 /**
1259  * Sets the diameter of the disk used for travel calibration.
1260  *
1261  * @public @memberof GoSetup
1262  * @note Supported with G1, G2
1263  * @version Introduced in firmware 4.0.10.27
1264  * @param setup GoSetup object.
1265  * @param diameter Disk diameter (mm).
1266  * @return Operation status.
1267  */
1268 GoFx(kStatus) GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter);
1269 
1270 /**
1271  * Gets the diameter of the disk used for travel calibration.
1272  *
1273  * @public @memberof GoSetup
1274  * @note Supported with G1, G2
1275  * @version Introduced in firmware 4.0.10.27
1276  * @param setup GoSetup object.
1277  * @return Disk diameter (mm).
1278  */
1279 GoFx(k64f) GoSetup_DiskDiameter(GoSetup setup);
1280 
1281 /**
1282  * Sets the height of the disk used for travel calibration.
1283  *
1284  * @public @memberof GoSetup
1285  * @note Supported with G1, G2
1286  * @version Introduced in firmware 4.0.10.27
1287  * @param setup GoSetup object.
1288  * @param height Disk height (mm).
1289  * @return Operation status.
1290  */
1291 GoFx(kStatus) GoSetup_SetDiskHeight(GoSetup setup, k64f height);
1292 
1293 /**
1294  * Gets the height of the disk used for travel calibration.
1295  *
1296  * @public @memberof GoSetup
1297  * @note Supported with G1, G2
1298  * @version Introduced in firmware 4.0.10.27
1299  * @param setup GoSetup object.
1300  * @return Disk height (mm).
1301  */
1302 GoFx(k64f) GoSetup_DiskHeight(GoSetup setup);
1303 
1304 /**
1305  * Sets the width of the bar used for travel calibration.
1306  *
1307  * @public @memberof GoSetup
1308  * @version Introduced in firmware 4.0.10.27
1309  * @param setup GoSetup object.
1310  * @param width Bar width (mm).
1311  * @return Operation status.
1312  */
1313 GoFx(kStatus) GoSetup_SetBarWidth(GoSetup setup, k64f width);
1314 
1315 /**
1316  * Gets the width of the bar used for travel calibration.
1317  *
1318  * @public @memberof GoSetup
1319  * @version Introduced in firmware 4.0.10.27
1320  * @param setup GoSetup object.
1321  * @return Bar width (mm).
1322  */
1323 GoFx(k64f) GoSetup_BarWidth(GoSetup setup);
1324 
1325 /**
1326  * Sets the height of the bar used for travel calibration.
1327  *
1328  * @public @memberof GoSetup
1329  * @version Introduced in firmware 4.0.10.27
1330  * @param setup GoSetup object.
1331  * @param height Bar height (mm).
1332  * @return Operation status.
1333  */
1334 GoFx(kStatus) GoSetup_SetBarHeight(GoSetup setup, k64f height);
1335 
1336 /**
1337  * Gets the height of the bar used for travel calibration.
1338  *
1339  * @public @memberof GoSetup
1340  * @version Introduced in firmware 4.0.10.27
1341  * @param setup GoSetup object.
1342  * @return Bar height (mm).
1343  */
1344 GoFx(k64f) GoSetup_BarHeight(GoSetup setup);
1345 
1346 /**
1347 * Indicates if the hole count can be modified by the user.
1348 *
1349 * @public @memberof GoSetup
1350 * @version Introduced in firmware 4.6.3.51
1351 * @param setup GoSetup object.
1352 * @return kTRUE if used. kFALSE if not.
1353 */
1354 GoFx(kBool) GoSetup_BarHoleCountUsed(GoSetup setup);
1355 
1356 /**
1357 * Gets the bar hole count system value.
1358 *
1359 * @public @memberof GoSetup
1360 * @version Introduced in firmware 4.6.3.51
1361 * @param setup GoSetup object.
1362 * @return Number of columns.
1363 */
1364 GoFx(kSize) GoSetup_BarHoleCountValue(GoSetup setup);
1365 
1366 /**
1367  * Sets the number of holes that are defined on the calibration bar.
1368  *
1369  * @public @memberof GoSetup
1370  * @version Introduced in firmware 4.0.10.27
1371  * @param setup GoSetup object.
1372  * @param count Hole count.
1373  * @return Operation status.
1374  */
1375 GoFx(kStatus) GoSetup_SetBarHoleCount(GoSetup setup, kSize count);
1376 
1377 /**
1378  * Gets the number of holes that are defined on the calibration bar.
1379  *
1380  * @public @memberof GoSetup
1381  * @version Introduced in firmware 4.0.10.27
1382  * @param setup GoSetup object.
1383  * @return Hole count.
1384  */
1385 GoFx(kSize) GoSetup_BarHoleCount(GoSetup setup);
1386 
1387 /**
1388 * Indicates if the hole distance can be modified by the user.
1389 *
1390 * @public @memberof GoSetup
1391 * @version Introduced in firmware 4.6.3.51
1392 * @param setup GoSetup object.
1393 * @return kTRUE if used. kFALSE if not.
1394 */
1395 GoFx(kBool) GoSetup_BarHoleDistanceUsed(GoSetup setup);
1396 
1397 /**
1398  * Sets the distance between holes that are defined on the calibration bar.
1399  *
1400  * @public @memberof GoSetup
1401  * @version Introduced in firmware 4.0.10.27
1402  * @param setup GoSetup object.
1403  * @param distance Hole distance (mm).
1404  * @return Operation status.
1405  */
1406 GoFx(kStatus) GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance);
1407 
1408 /**
1409  * Gets the distance between holes that are defined on the calibration bar.
1410  *
1411  * @public @memberof GoSetup
1412  * @version Introduced in firmware 4.0.10.27
1413  * @param setup GoSetup object.
1414  * @return Hole distance (mm).
1415  */
1416 GoFx(k64f) GoSetup_BarHoleDistance(GoSetup setup);
1417 
1418 /**
1419 * Indicates if the hole diameter can be modified by the user.
1420 *
1421 * @public @memberof GoSetup
1422 * @version Introduced in firmware 4.6.3.55
1423 * @param setup GoSetup object.
1424 * @return kTRUE if used. kFALSE if not.
1425 */
1426 GoFx(kBool) GoSetup_BarHoleDiameterUsed(GoSetup setup);
1427 
1428 /**
1429  * Sets the diameter of holes that are defined on the calibration bar.
1430  *
1431  * @public @memberof GoSetup
1432  * @version Introduced in firmware 4.0.10.27
1433  * @param setup GoSetup object.
1434  * @param diameter Hole diameter (mm).
1435  * @return Operation status.
1436  */
1437 GoFx(kStatus) GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter);
1438 
1439 /**
1440  * Gets the diameter of holes that are defined on the calibration bar.
1441  *
1442  * @public @memberof GoSetup
1443  * @version Introduced in firmware 4.0.10.27
1444  * @param setup GoSetup object.
1445  * @return Hole diameter (mm).
1446  */
1447 GoFx(k64f) GoSetup_BarHoleDiameter(GoSetup setup);
1448 
1449 /**
1450  * Sets the degrees of freedom used for bar alignment calibration.
1451  *
1452  * @public @memberof GoSetup
1453  * @version Introduced in firmware 4.7.3.70
1454  * @param setup GoSetup object.
1455  * @param dof Alignment degrees of freedom for the bar.
1456  * @return Operation status.
1457  */
1458 GoFx(kStatus) GoSetup_SetBarDegreesOfFreedom(GoSetup setup, GoAlignmentDegreesOfFreedom dof);
1459 
1460 /**
1461  * Gets the degrees of freedom used for bar alignment calibration.
1462  *
1463  * @public @memberof GoSetup
1464  * @version Introduced in firmware 4.7.3.70
1465  * @param setup GoSetup object.
1466  * @return Degrees of freedom setting for the bar alignment.
1467  */
1468 GoFx(GoAlignmentDegreesOfFreedom) GoSetup_BarDegreesOfFreedom( GoSetup setup );
1469 
1470 /**
1471 * Indicates if the degrees of freedom for bar alignment can be modified by the user.
1472 *
1473 * @public @memberof GoSetup
1474 * @version Introduced in firmware 4.7.3.70
1475 * @param setup GoSetup object.
1476 * @return kTRUE if used. kFALSE if not.
1477 */
1478 GoFx(kBool) GoSetup_BarDegreesOfFreedomUsed(GoSetup setup);
1479 
1480 /**
1481  * Gets the degrees of freedom bar alignment target option count.
1482  *
1483  * @public @memberof GoSetup
1484  * @version Introduced in firmware 4.7.3.70
1485  * @param setup GoSetup object.
1486  * @return The bar alignment degrees of freedom option count.
1487  */
1488 GoFx(kSize) GoSetup_BarDegreesOfFreedomOptionCount(GoSetup setup);
1489 
1490 /**
1491  * Gets the bar alignment degrees of freedom option at the given index.
1492  *
1493  * @public @memberof GoSetup
1494  * @version Introduced in firmware 4.7.3.70
1495  * @param setup GoSetup object.
1496  * @param index The index with which to retrieve the degree of freedom.
1497  * @return The degrees of freedom option set at the index.
1498  */
1499 GoFx(GoAlignmentDegreesOfFreedom) GoSetup_BarDegreesOfFreedomOptionAt(GoSetup setup, kSize index);
1500 
1501 /**
1502  * Sets the height of the plate used for travel calibration.
1503  *
1504  * @public @memberof GoSetup
1505  * @version Introduced in firmware 4.0.10.27
1506  * @param setup GoSetup object.
1507  * @param height Plate height (mm).
1508  * @return Operation status.
1509  */
1510 GoFx(kStatus) GoSetup_SetPlateHeight(GoSetup setup, k64f height);
1511 
1512 /**
1513  * Gets the height of the plate used for travel calibration.
1514  *
1515  * @public @memberof GoSetup
1516  * @version Introduced in firmware 4.0.10.27
1517  * @param setup GoSetup object.
1518  * @return Plate height (mm).
1519  */
1520 GoFx(k64f) GoSetup_PlateHeight(GoSetup setup);
1521 
1522 /**
1523  * Sets the number of holes that are defined on the calibration plate.
1524  *
1525  * @public @memberof GoSetup
1526  * @version Introduced in firmware 4.0.10.27
1527  * @param setup GoSetup object.
1528  * @param count Hole count.
1529  * @return Operation status.
1530  */
1531 GoFx(kStatus) GoSetup_SetPlateHoleCount(GoSetup setup, kSize count);
1532 
1533 /**
1534  * Gets the number of holes that are defined on the calibration plate.
1535  *
1536  * @public @memberof GoSetup
1537  * @version Introduced in firmware 4.0.10.27
1538  * @param setup GoSetup object.
1539  * @return Hole count.
1540  */
1541 GoFx(kSize) GoSetup_PlateHoleCount(GoSetup setup);
1542 
1543 /**
1544  * Sets the diameter of the reference hole defined on the calibration plate.
1545  *
1546  * @public @memberof GoSetup
1547  * @version Introduced in firmware 4.0.10.27
1548  * @param setup GoSetup object.
1549  * @param diameter Hole diameter (mm).
1550  * @return Operation status.
1551  */
1552 GoFx(kStatus) GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter);
1553 
1554 /**
1555  * Gets the diameter of the reference hole defined on the calibration plate.
1556  *
1557  * @public @memberof GoSetup
1558  * @version Introduced in firmware 4.0.10.27
1559  * @param setup GoSetup object.
1560  * @return Hole diameter (mm).
1561  */
1562 GoFx(k64f) GoSetup_PlateRefHoleDiameter(GoSetup setup);
1563 
1564 /**
1565  * Sets the diameter of the secondary hole defined on the calibration plate.
1566  *
1567  * @public @memberof GoSetup
1568  * @version Introduced in firmware 4.0.10.27
1569  * @param setup GoSetup object.
1570  * @param diameter Hole diameter (mm).
1571  * @return Operation status.
1572  */
1573 GoFx(kStatus) GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter);
1574 
1575 /**
1576  * Gets the diameter of the secondary hole defined on the calibration plate.
1577  *
1578  * @public @memberof GoSetup
1579  * @version Introduced in firmware 4.0.10.27
1580  * @param setup GoSetup object.
1581  * @return Hole diameter (mm).
1582  */
1583 GoFx(k64f) GoSetup_PlateSecHoleDiameter(GoSetup setup);
1584 
1585 /**
1586  * Adds a corner parameters object to the collection of polygon corners for alignment.
1587  *
1588  * @public @memberof GoSetup
1589  * @version Introduced in firmware 4.8.0.72
1590  * @param setup GoSetup object.
1591  * @param corner Reference to GoPolygonCornerParameters object.
1592  * @return Operation status.
1593  */
1594 GoFx(kStatus) GoSetup_AddPolygonCorner(GoSetup setup, GoPolygonCornerParameters* corner);
1595 
1596 /* Adds corner parameters to the collection of polygon corners for alignment.
1597  *
1598  * @public @memberof GoSetup
1599  * @version Introduced in firmware 4.8.0.86
1600  * @param pointx X coordinate of corner.
1601  * @param pointz Z coordinate of corner.
1602  * @param devices Array list of devices assigned to corner.
1603  * @return Operation status.
1604  */
1605 GoFx(kStatus) GoSetup_AddPolygonCornerParams(GoSetup setup, k64f pointx, k64f pointz, const kChar *devices);
1606 
1607 /**
1608  * Clears all corner parameter objects from the collection of polygon corners for alignment.
1609  *
1610  * @public @memberof GoSetup
1611  * @version Introduced in firmware 4.8.0.72
1612  * @param setup GoSetup object.
1613  * @return Operation status.
1614  */
1615 GoFx(kStatus) GoSetup_ClearPolygonCorners(GoSetup setup);
1616 
1617 /**
1618  * Retrieves the reference to the corner parameters object from the collection of polygon corners.
1619  *
1620  * @public @memberof GoSetup
1621  * @version Introduced in firmware 4.8.0.72
1622  * @param setup GoSetup object.
1623  * @param index Index in the collection of polygon corners.
1624  * @return Reference to corresponding corner parameters.
1625  */
1626 GoFx(GoPolygonCornerParameters*) GoSetup_PolygonCornerAt(GoSetup setup, kSize index);
1627 
1628 /**
1629  * Gets the number of corner parameters defined in the collection of polygon corners.
1630  *
1631  * @public @memberof GoSetup
1632  * @version Introduced in firmware 4.8.0.72
1633  * @param setup GoSetup object.
1634  * @return Number of corner parameters in polygon.
1635  */
1636 GoFx(kSize) GoSetup_PolygonCornerCount(GoSetup setup);
1637 
1638 
1639 /**
1640  * Indicates whether X smoothing can be used for the current scan mode and device family.
1641  *
1642  * @public @memberof GoSetup
1643  * @note Supported with G1, G2
1644  * @version Introduced in firmware 4.5.3.57
1645  * @param setup GoSetup object.
1646  * @return True if x-smoothing is available for use.
1647  */
1648 GoFx(kBool) GoSetup_XSmoothingUsed(GoSetup setup);
1649 
1650 /**
1651  * Sets the status of x-direction smoothing.
1652  *
1653  * @public @memberof GoSetup
1654  * @note Supported with G1, G2
1655  * @version Introduced in firmware 4.0.10.27
1656  * @param setup GoSetup object.
1657  * @param enabled Enable or disable x-smoothing
1658  * @return Operation status.
1659  */
1660 GoFx(kStatus) GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled);
1661 
1662 /**
1663  * Gets the status of x-direction smoothing.
1664  *
1665  * @public @memberof GoSetup
1666  * @note Supported with G1, G2
1667  * @version Introduced in firmware 4.0.10.27
1668  * @param setup GoSetup object.
1669  * @return True if x-smoothing is enabled.
1670  */
1671 GoFx(kBool) GoSetup_XSmoothingEnabled(GoSetup setup);
1672 
1673 /**
1674  * Sets the x-direction smoothing window.
1675  *
1676  * @public @memberof GoSetup
1677  * @note Supported with G1, G2
1678  * @version Introduced in firmware 4.0.10.27
1679  * @param setup GoSetup object.
1680  * @param window The x-smoothing window (mm).
1681  * @return Operation status.
1682  */
1683 GoFx(kStatus) GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window);
1684 
1685 /**
1686  * Gets the x-direction smoothing window.
1687  *
1688  * @public @memberof GoSetup
1689  * @note Supported with G1, G2
1690  * @version Introduced in firmware 4.0.10.27
1691  * @param setup GoSetup object.
1692  * @return The x-smoothing window (mm).
1693  */
1694 GoFx(k64f) GoSetup_XSmoothingWindow(GoSetup setup);
1695 
1696 /**
1697  * Gets the x-direction smoothing window minimum.
1698  *
1699  * @public @memberof GoSetup
1700  * @note Supported with G1, G2
1701  * @version Introduced in firmware 4.0.10.27
1702  * @param setup GoSetup object.
1703  * @return The x-smoothing window min (mm).
1704  */
1705 GoFx(k64f) GoSetup_XSmoothingWindowLimitMin(GoSetup setup);
1706 
1707 /**
1708  * Gets the x-direction smoothing window maximum.
1709  *
1710  * @public @memberof GoSetup
1711  * @note Supported with G1, G2
1712  * @version Introduced in firmware 4.0.10.27
1713  * @param setup GoSetup object.
1714  * @return The x-smoothing window max (mm).
1715  */
1716 GoFx(k64f) GoSetup_XSmoothingWindowLimitMax(GoSetup setup);
1717 
1718 /**
1719  * Indicates whether X median can be used for the current scan mode and device family.
1720  *
1721  * @public @memberof GoSetup
1722  * @note Supported with G1, G2
1723  * @version Introduced in firmware 4.5.3.57
1724  * @param setup GoSetup object.
1725  * @return True if x-median is available for use.
1726  */
1727 GoFx(kBool) GoSetup_XMedianUsed(GoSetup setup);
1728 
1729 /**
1730  * Sets the status of x-direction median.
1731  *
1732  * @public @memberof GoSetup
1733  * @note Supported with G1, G2
1734  * @version Introduced in firmware 4.1.3.106
1735  * @param setup GoSetup object.
1736  * @param enabled Enable or disable x-median
1737  * @return Operation status.
1738  */
1739 GoFx(kStatus) GoSetup_EnableXMedian(GoSetup setup, kBool enabled);
1740 
1741 /**
1742  * Gets the status of x-direction median.
1743  *
1744  * @public @memberof GoSetup
1745  * @note Supported with G1, G2
1746  * @version Introduced in firmware 4.1.3.106
1747  * @param setup GoSetup object.
1748  * @return True if x-median is enabled.
1749  */
1750 GoFx(kBool) GoSetup_XMedianEnabled(GoSetup setup);
1751 
1752 /**
1753  * Sets the x-direction median window.
1754  *
1755  * @public @memberof GoSetup
1756  * @note Supported with G1, G2
1757  * @version Introduced in firmware 4.1.3.106
1758  * @param setup GoSetup object.
1759  * @param window The x-median window (mm).
1760  * @return Operation status.
1761  */
1762 GoFx(kStatus) GoSetup_SetXMedianWindow(GoSetup setup, k64f window);
1763 
1764 /**
1765  * Gets the x-direction median window.
1766  *
1767  * @public @memberof GoSetup
1768  * @note Supported with G1, G2
1769  * @version Introduced in firmware 4.1.3.106
1770  * @param setup GoSetup object.
1771  * @return The x-median window (mm).
1772  */
1773 GoFx(k64f) GoSetup_XMedianWindow(GoSetup setup);
1774 
1775 /**
1776  * Gets the x-direction median window minimum.
1777  *
1778  * @public @memberof GoSetup
1779  * @note Supported with G1, G2
1780  * @version Introduced in firmware 4.1.3.106
1781  * @param setup GoSetup object.
1782  * @return The x-median window min (mm).
1783  */
1784 GoFx(k64f) GoSetup_XMedianWindowLimitMin(GoSetup setup);
1785 
1786 /**
1787  * Gets the x-direction median window maximum.
1788  *
1789  * @public @memberof GoSetup
1790  * @note Supported with G1, G2
1791  * @version Introduced in firmware 4.1.3.106
1792  * @param setup GoSetup object.
1793  * @return The x-median window max (mm).
1794  */
1795 GoFx(k64f) GoSetup_XMedianWindowLimitMax(GoSetup setup);
1796 
1797 /**
1798  * Indicates whether X decimation can be used for the current scan mode and device family.
1799  *
1800  * @public @memberof GoSetup
1801  * @note Supported with G1, G2
1802  * @version Introduced in firmware 4.5.3.57
1803  * @param setup GoSetup object.
1804  * @return True if x-decimation is available for use.
1805  */
1806 GoFx(kBool) GoSetup_XDecimationUsed(GoSetup setup);
1807 
1808 /**
1809  * Sets the status of x-direction decimation.
1810  *
1811  * @public @memberof GoSetup
1812  * @note Supported with G1, G2
1813  * @version Introduced in firmware 4.1.3.106
1814  * @param setup GoSetup object.
1815  * @param enabled Enable or disable x-decimation
1816  * @return Operation status.
1817  */
1818 GoFx(kStatus) GoSetup_EnableXDecimation(GoSetup setup, kBool enabled);
1819 
1820 /**
1821  * Gets the status of x-direction decimation.
1822  *
1823  * @public @memberof GoSetup
1824  * @note Supported with G1, G2
1825  * @version Introduced in firmware 4.1.3.106
1826  * @param setup GoSetup object.
1827  * @return True if x-decimation is enabled.
1828  */
1829 GoFx(kBool) GoSetup_XDecimationEnabled(GoSetup setup);
1830 
1831 /**
1832  * Sets the x-direction decimation window.
1833  *
1834  * @public @memberof GoSetup
1835  * @note Supported with G1, G2
1836  * @version Introduced in firmware 4.1.3.106
1837  * @param setup GoSetup object.
1838  * @param window The x-decimation window (mm).
1839  * @return Operation status.
1840  */
1841 GoFx(kStatus) GoSetup_SetXDecimationWindow(GoSetup setup, k64f window);
1842 
1843 /**
1844  * Gets the x-direction decimation window.
1845  *
1846  * @public @memberof GoSetup
1847  * @note Supported with G1, G2
1848  * @version Introduced in firmware 4.1.3.106
1849  * @param setup GoSetup object.
1850  * @return The x-decimation window (mm).
1851  */
1852 GoFx(k64f) GoSetup_XDecimationWindow(GoSetup setup);
1853 
1854 /**
1855  * Gets the x-direction decimation window minimum.
1856  *
1857  * @public @memberof GoSetup
1858  * @note Supported with G1, G2
1859  * @version Introduced in firmware 4.1.3.106
1860  * @param setup GoSetup object.
1861  * @return The x-decimation window min (mm).
1862  */
1863 GoFx(k64f) GoSetup_XDecimationWindowLimitMin(GoSetup setup);
1864 
1865 /**
1866  * Gets the x-direction decimation window maximum.
1867  *
1868  * @public @memberof GoSetup
1869  * @note Supported with G1, G2
1870  * @version Introduced in firmware 4.1.3.106
1871  * @param setup GoSetup object.
1872  * @return The x-decimation window max (mm).
1873  */
1874 GoFx(k64f) GoSetup_XDecimationWindowLimitMax(GoSetup setup);
1875 
1876 /**
1877  * Indicates whether X gap filling can be used for the current scan mode and device family.
1878  *
1879  * @public @memberof GoSetup
1880  * @note Supported with G1, G2
1881  * @version Introduced in firmware 4.5.3.57
1882  * @param setup GoSetup object.
1883  * @return True if x-gap filling is available for use.
1884  */
1885 GoFx(kBool) GoSetup_XGapFillingUsed(GoSetup setup);
1886 
1887 /**
1888  * Sets the status of x-direction gap-filling.
1889  *
1890  * @public @memberof GoSetup
1891  * @note Supported with G1, G2
1892  * @version Introduced in firmware 4.0.10.27
1893  * @param setup GoSetup object.
1894  * @param enable Enable or disable x-gap-filling
1895  * @return Operation status.
1896  */
1897 GoFx(kStatus) GoSetup_EnableXGapFilling(GoSetup setup, kBool enable);
1898 
1899 /**
1900  * Gets the status of x-direction gap-filling.
1901  *
1902  * @public @memberof GoSetup
1903  * @note Supported with G1, G2
1904  * @version Introduced in firmware 4.0.10.27
1905  * @param setup GoSetup object.
1906  * @return True if x-gap-filling is enabled.
1907  */
1908 GoFx(kBool) GoSetup_XGapFillingEnabled(GoSetup setup);
1909 
1910 /**
1911  * Sets the status of x-direction gap-filling.
1912  *
1913  * @public @memberof GoSetup
1914  * @note Supported with G1, G2
1915  * @version Introduced in firmware 4.0.10.27
1916  * @param setup GoSetup object.
1917  * @param window Enable or disable x-gap-filling
1918  * @return Operation status.
1919  */
1920 GoFx(kStatus) GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window);
1921 
1922 /**
1923  * Gets the x-direction gap-filling window.
1924  *
1925  * @public @memberof GoSetup
1926  * @note Supported with G1, G2
1927  * @version Introduced in firmware 4.0.10.27
1928  * @param setup GoSetup object.
1929  * @return The x-gap-filling window (mm).
1930  */
1931 GoFx(k64f) GoSetup_XGapFillingWindow(GoSetup setup);
1932 
1933 /**
1934  * Gets the x-direction gap-filling window minimum.
1935  *
1936  * @public @memberof GoSetup
1937  * @note Supported with G1, G2
1938  * @version Introduced in firmware 4.0.10.27
1939  * @param setup GoSetup object.
1940  * @return The x-gap-filling window min (mm).
1941  */
1942 GoFx(k64f) GoSetup_XGapFillingWindowLimitMin(GoSetup setup);
1943 
1944 /**
1945  * Gets the x-direction gap-filling window maximum.
1946  *
1947  * @public @memberof GoSetup
1948  * @note Supported with G1, G2
1949  * @version Introduced in firmware 4.0.10.27
1950  * @param setup GoSetup object.
1951  * @return The x-gap-filling window max (mm).
1952  */
1953 GoFx(k64f) GoSetup_XGapFillingWindowLimitMax(GoSetup setup);
1954 
1955 /**
1956  * Indicates whether X slope can be used for the current scan mode and device family.
1957  *
1958  * @public @memberof GoSetup
1959  * @note Supported with G1, G2
1960  * @version Introduced in firmware 4.5.3.57
1961  * @param setup GoSetup object.
1962  * @return True if x-slope is available for use.
1963  */
1964 GoFx(kBool) GoSetup_XSlopeUsed(GoSetup setup);
1965 
1966 /**
1967  * Sets the status of x-direction slope.
1968  *
1969  * @public @memberof GoSetup
1970  * @note Supported with G1, G2
1971  * @version Introduced in firmware 4.5.2.0
1972  * @param setup GoSetup object.
1973  * @param enable Enable or disable x-slope
1974  * @return Operation status.
1975  */
1976 GoFx(kStatus) GoSetup_EnableXSlope(GoSetup setup, kBool enable);
1977 
1978 /**
1979  * Gets the status of x-direction slope.
1980  *
1981  * @public @memberof GoSetup
1982  * @note Supported with G1, G2
1983  * @version Introduced in firmware 4.5.2.0
1984  * @param setup GoSetup object.
1985  * @return True if x-slope is enabled.
1986  */
1987 GoFx(kBool) GoSetup_XSlopeEnabled(GoSetup setup);
1988 
1989 /**
1990  * Sets the status of x-direction slope.
1991  *
1992  * @public @memberof GoSetup
1993  * @note Supported with G1, G2
1994  * @version Introduced in firmware 4.5.2.0
1995  * @param setup GoSetup object.
1996  * @param window Enable or disable x-slope
1997  * @return Operation status.
1998  */
1999 GoFx(kStatus) GoSetup_SetXSlopeWindow(GoSetup setup, k64f window);
2000 
2001 /**
2002  * Gets the x-direction slope window.
2003  *
2004  * @public @memberof GoSetup
2005  * @note Supported with G1, G2
2006  * @version Introduced in firmware 4.5.2.0
2007  * @param setup GoSetup object.
2008  * @return The x-slope window (mm).
2009  */
2010 GoFx(k64f) GoSetup_XSlopeWindow(GoSetup setup);
2011 
2012 /**
2013  * Gets the x-direction slope window minimum.
2014  *
2015  * @public @memberof GoSetup
2016  * @note Supported with G1, G2
2017  * @version Introduced in firmware 4.5.2.0
2018  * @param setup GoSetup object.
2019  * @return The x-slope window min (mm).
2020  */
2021 GoFx(k64f) GoSetup_XSlopeWindowLimitMin(GoSetup setup);
2022 
2023 /**
2024  * Gets the x-direction slope window maximum.
2025  *
2026  * @public @memberof GoSetup
2027  * @note Supported with G1, G2
2028  * @version Introduced in firmware 4.5.2.0
2029  * @param setup GoSetup object.
2030  * @return The x-slope window max (mm).
2031  */
2032 GoFx(k64f) GoSetup_XSlopeWindowLimitMax(GoSetup setup);
2033 
2034 /**
2035  * Indicates whether Y smoothing can be used for the current scan mode and device family.
2036  *
2037  * @public @memberof GoSetup
2038  * @note Supported with G1, G2
2039  * @version Introduced in firmware 4.5.3.57
2040  * @param setup GoSetup object.
2041  * @return True if y-smoothing is available for use.
2042  */
2043 GoFx(kBool) GoSetup_YSmoothingUsed(GoSetup setup);
2044 
2045 /**
2046  * Sets the status of y-direction smoothing.
2047  *
2048  * @public @memberof GoSetup
2049  * @note Supported with G1, G2
2050  * @version Introduced in firmware 4.0.10.27
2051  * @param setup GoSetup object.
2052  * @param enable Enable or disable y-smoothing
2053  * @return Operation status.
2054  */
2055 GoFx(kStatus) GoSetup_EnableYSmoothing(GoSetup setup, kBool enable);
2056 
2057 /**
2058  * Gets the status of y-direction smoothing.
2059  *
2060  * @public @memberof GoSetup
2061  * @note Supported with G1, G2
2062  * @version Introduced in firmware 4.0.10.27
2063  * @param setup GoSetup object.
2064  * @return True if y-smoothing is enabled.
2065  */
2066 GoFx(kBool) GoSetup_YSmoothingEnabled(GoSetup setup);
2067 
2068 /**
2069  * Sets the y-direction smoothing window.
2070  *
2071  * @public @memberof GoSetup
2072  * @note Supported with G1, G2
2073  * @version Introduced in firmware 4.0.10.27
2074  * @param setup GoSetup object.
2075  * @param window The y-smoothing window (mm).
2076  * @return Operation status.
2077  */
2078 GoFx(kStatus) GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window);
2079 
2080 /**
2081  * Gets the y-direction smoothing window.
2082  *
2083  * @public @memberof GoSetup
2084  * @note Supported with G1, G2
2085  * @version Introduced in firmware 4.0.10.27
2086  * @param setup GoSetup object.
2087  * @return The y-smoothing window (mm).
2088  */
2089 GoFx(k64f) GoSetup_YSmoothingWindow(GoSetup setup);
2090 
2091 /**
2092  * Gets the y-direction smoothing window minimum.
2093  *
2094  * @public @memberof GoSetup
2095  * @note Supported with G1, G2
2096  * @version Introduced in firmware 4.0.10.27
2097  * @param setup GoSetup object.
2098  * @return The y-smoothing window min (mm).
2099  */
2100 GoFx(k64f) GoSetup_YSmoothingWindowLimitMin(GoSetup setup);
2101 
2102 /**
2103  * Gets the y-direction smoothing window maximum.
2104  *
2105  * @public @memberof GoSetup
2106  * @note Supported with G1, G2
2107  * @version Introduced in firmware 4.0.10.27
2108  * @param setup GoSetup object.
2109  * @return The y-smoothing window max (mm).
2110  */
2111 GoFx(k64f) GoSetup_YSmoothingWindowLimitMax(GoSetup setup);
2112 
2113 /**
2114  * Indicates whether Y median can be used for the current scan mode and device family.
2115  *
2116  * @public @memberof GoSetup
2117  * @note Supported with G1, G2
2118  * @version Introduced in firmware 4.5.3.57
2119  * @param setup GoSetup object.
2120  * @return True if y-median is available for use.
2121  */
2122 GoFx(kBool) GoSetup_YMedianUsed(GoSetup setup);
2123 
2124 /**
2125  * Sets the status of y-direction median.
2126  *
2127  * @public @memberof GoSetup
2128  * @note Supported with G1, G2
2129  * @version Introduced in firmware 4.1.3.106
2130  * @param setup GoSetup object.
2131  * @param enable Enable or disable y-median
2132  * @return Operation status.
2133  */
2134 GoFx(kStatus) GoSetup_EnableYMedian(GoSetup setup, kBool enable);
2135 
2136 /**
2137  * Gets the status of y-direction median.
2138  *
2139  * @public @memberof GoSetup
2140  * @note Supported with G1, G2
2141  * @version Introduced in firmware 4.1.3.106
2142  * @param setup GoSetup object.
2143  * @return True if y-median is enabled.
2144  */
2145 GoFx(kBool) GoSetup_YMedianEnabled(GoSetup setup);
2146 
2147 /**
2148  * Sets the y-direction median window.
2149  *
2150  * @public @memberof GoSetup
2151  * @note Supported with G1, G2
2152  * @version Introduced in firmware 4.1.3.106
2153  * @param setup GoSetup object.
2154  * @param window The y-median window (mm).
2155  * @return Operation status.
2156  */
2157 GoFx(kStatus) GoSetup_SetYMedianWindow(GoSetup setup, k64f window);
2158 
2159 /**
2160  * Gets the y-direction median window.
2161  *
2162  * @public @memberof GoSetup
2163  * @note Supported with G1, G2
2164  * @version Introduced in firmware 4.1.3.106
2165  * @param setup GoSetup object.
2166  * @return The y-median window (mm).
2167  */
2168 GoFx(k64f) GoSetup_YMedianWindow(GoSetup setup);
2169 
2170 /**
2171  * Gets the y-direction median window minimum.
2172  *
2173  * @public @memberof GoSetup
2174  * @note Supported with G1, G2
2175  * @version Introduced in firmware 4.1.3.106
2176  * @param setup GoSetup object.
2177  * @return The y-median window min (mm).
2178  */
2179 GoFx(k64f) GoSetup_YMedianWindowLimitMin(GoSetup setup);
2180 
2181 /**
2182  * Gets the y-direction median window maximum.
2183  *
2184  * @public @memberof GoSetup
2185  * @note Supported with G1, G2
2186  * @version Introduced in firmware 4.1.3.106
2187  * @param setup GoSetup object.
2188  * @return The y-median window max (mm).
2189  */
2190 GoFx(k64f) GoSetup_YMedianWindowLimitMax(GoSetup setup);
2191 
2192 /**
2193  * Indicates whether y decimation can be used for the current scan mode and device family.
2194  *
2195  * @public @memberof GoSetup
2196  * @note Supported with G1, G2
2197  * @version Introduced in firmware 4.5.3.57
2198  * @param setup GoSetup object.
2199  * @return True if y-decimation is available for use.
2200  */
2201 GoFx(kBool) GoSetup_YDecimationUsed(GoSetup setup);
2202 
2203 /**
2204  * Sets the status of y-direction decimation.
2205  *
2206  * @public @memberof GoSetup
2207  * @note Supported with G1, G2
2208  * @version Introduced in firmware 4.1.3.106
2209  * @param setup GoSetup object.
2210  * @param enable Enable or disable y-decimation
2211  * @return Operation status.
2212  */
2213 GoFx(kStatus) GoSetup_EnableYDecimation(GoSetup setup, kBool enable);
2214 
2215 /**
2216  * Gets the status of y-direction decimation.
2217  *
2218  * @public @memberof GoSetup
2219  * @note Supported with G1, G2
2220  * @version Introduced in firmware 4.1.3.106
2221  * @param setup GoSetup object.
2222  * @return True if y-decimation is enabled.
2223  */
2224 GoFx(kBool) GoSetup_YDecimationEnabled(GoSetup setup);
2225 
2226 /**
2227  * Sets the y-direction decimation window.
2228  *
2229  * @public @memberof GoSetup
2230  * @note Supported with G1, G2
2231  * @version Introduced in firmware 4.1.3.106
2232  * @param setup GoSetup object.
2233  * @param window The y-decimation window (mm).
2234  * @return Operation status.
2235  */
2236 GoFx(kStatus) GoSetup_SetYDecimationWindow(GoSetup setup, k64f window);
2237 
2238 /**
2239  * Gets the y-direction decimation window.
2240  *
2241  * @public @memberof GoSetup
2242  * @note Supported with G1, G2
2243  * @version Introduced in firmware 4.1.3.106
2244  * @param setup GoSetup object.
2245  * @return The y-decimation window (mm).
2246  */
2247 GoFx(k64f) GoSetup_YDecimationWindow(GoSetup setup);
2248 
2249 /**
2250  * Gets the y-direction decimation window minimum.
2251  *
2252  * @public @memberof GoSetup
2253  * @note Supported with G1, G2
2254  * @version Introduced in firmware 4.1.3.106
2255  * @param setup GoSetup object.
2256  * @return The y-decimation window min (mm).
2257  */
2258 GoFx(k64f) GoSetup_YDecimationWindowLimitMin(GoSetup setup);
2259 
2260 /**
2261  * Gets the y-direction decimation window maximum.
2262  *
2263  * @public @memberof GoSetup
2264  * @note Supported with G1, G2
2265  * @version Introduced in firmware 4.1.3.106
2266  * @param setup GoSetup object.
2267  * @return The y-decimation window max (mm).
2268  */
2269 GoFx(k64f) GoSetup_YDecimationWindowLimitMax(GoSetup setup);
2270 
2271 /**
2272  * Indicates whether Y slope can be used for the current scan mode and device family.
2273  *
2274  * @public @memberof GoSetup
2275  * @note Supported with G1, G2
2276  * @version Introduced in firmware 4.5.3.57
2277  * @param setup GoSetup object.
2278  * @return True if y-slope is available for use.
2279  */
2280 GoFx(kBool) GoSetup_YSlopeUsed(GoSetup setup);
2281 
2282 /**
2283  * Sets the status of y-direction slope.
2284  *
2285  * @public @memberof GoSetup
2286  * @note Supported with G1, G2
2287  * @version Introduced in firmware 4.5.2.0
2288  * @param setup GoSetup object.
2289  * @param enable Enable or disable y-slope
2290  * @return Operation status.
2291  */
2292 GoFx(kStatus) GoSetup_EnableYSlope(GoSetup setup, kBool enable);
2293 
2294 /**
2295  * Gets the status of y-direction slope.
2296  *
2297  * @public @memberof GoSetup
2298  * @note Supported with G1, G2
2299  * @version Introduced in firmware 4.5.2.0
2300  * @param setup GoSetup object.
2301  * @return True if y-slope is enabled.
2302  */
2303 GoFx(kBool) GoSetup_YSlopeEnabled(GoSetup setup);
2304 
2305 /**
2306  * Sets the status of y-direction slope.
2307  *
2308  * @public @memberof GoSetup
2309  * @note Supported with G1, G2
2310  * @version Introduced in firmware 4.5.2.0
2311  * @param setup GoSetup object.
2312  * @param window Enable or disable y-slope
2313  * @return Operation status.
2314  */
2315 GoFx(kStatus) GoSetup_SetYSlopeWindow(GoSetup setup, k64f window);
2316 
2317 /**
2318  * Gets the y-direction slope window.
2319  *
2320  * @public @memberof GoSetup
2321  * @note Supported with G1, G2
2322  * @version Introduced in firmware 4.5.2.0
2323  * @param setup GoSetup object.
2324  * @return The y-slope window (mm).
2325  */
2326 GoFx(k64f) GoSetup_YSlopeWindow(GoSetup setup);
2327 
2328 /**
2329  * Gets the y-direction slope window minimum.
2330  *
2331  * @public @memberof GoSetup
2332  * @note Supported with G1, G2
2333  * @version Introduced in firmware 4.5.2.0
2334  * @param setup GoSetup object.
2335  * @return The y-slope window min (mm).
2336  */
2337 GoFx(k64f) GoSetup_YSlopeWindowLimitMin(GoSetup setup);
2338 
2339 /**
2340  * Gets the y-direction slope window maximum.
2341  *
2342  * @public @memberof GoSetup
2343  * @note Supported with G1, G2
2344  * @version Introduced in firmware 4.5.2.0
2345  * @param setup GoSetup object.
2346  * @return The y-slope window max (mm).
2347  */
2348 GoFx(k64f) GoSetup_YSlopeWindowLimitMax(GoSetup setup);
2349 
2350 /**
2351  * Indicates whether Y gap filling can be used for the current scan mode and device family.
2352  *
2353  * @public @memberof GoSetup
2354  * @note Supported with G2
2355  * @version Introduced in firmware 4.5.3.57
2356  * @param setup GoSetup object.
2357  * @return True if y-gap filling is available for use.
2358  */
2359 GoFx(kBool) GoSetup_YGapFillingUsed(GoSetup setup);
2360 
2361 /**
2362  * Sets the status of y-direction gap-filling.
2363  *
2364  * @public @memberof GoSetup
2365  * @note Supported with G2
2366  * @version Introduced in firmware 4.0.10.27
2367  * @param setup GoSetup object.
2368  * @param enable Enable or disable y-gap-filling
2369  * @return Operation status.
2370  */
2371 GoFx(kStatus) GoSetup_EnableYGapFilling(GoSetup setup, kBool enable);
2372 
2373 /**
2374  * Gets the status of y-direction gap-filling.
2375  *
2376  * @public @memberof GoSetup
2377  * @note Supported with G2
2378  * @version Introduced in firmware 4.0.10.27
2379  * @param setup GoSetup object.
2380  * @return True if y-gap-filling is enabled.
2381  */
2382 GoFx(kBool) GoSetup_YGapFillingEnabled(GoSetup setup);
2383 
2384 /**
2385  * Sets the y-direction gap-filling window.
2386  *
2387  * @public @memberof GoSetup
2388  * @note Supported with G2
2389  * @version Introduced in firmware 4.0.10.27
2390  * @param setup GoSetup object.
2391  * @param window The y-gap-filling window (mm).
2392  * @return
2393  */
2394 GoFx(kStatus) GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window);
2395 
2396 /**
2397  * Gets the y-direction gap-filling window.
2398  *
2399  * @public @memberof GoSetup
2400  * @note Supported with G2
2401  * @version Introduced in firmware 4.0.10.27
2402  * @param setup GoSetup object.
2403  * @return The y-gap-filling window (mm).
2404  */
2405 GoFx(k64f) GoSetup_YGapFillingWindow(GoSetup setup);
2406 
2407 /**
2408  * Gets the y-direction gap-filling window minimum.
2409  *
2410  * @public @memberof GoSetup
2411  * @note Supported with G2
2412  * @version Introduced in firmware 4.0.10.27
2413  * @param setup GoSetup object.
2414  * @return The y-gap-filling window min (mm).
2415  */
2416 GoFx(k64f) GoSetup_YGapFillingWindowLimitMin(GoSetup setup);
2417 
2418 /**
2419  * Gets the y-direction gap-filling window maximum.
2420  *
2421  * @public @memberof GoSetup
2422  * @note Supported with G2
2423  * @version Introduced in firmware 4.0.10.27
2424  * @param setup GoSetup object.
2425  * @return The y-gap-filling window max (mm).
2426  */
2427 GoFx(k64f) GoSetup_YGapFillingWindowLimitMax(GoSetup setup);
2428 
2429 /**
2430  * Gets the maximum valid value for the Exposure setting.
2431  *
2432  * @public @memberof GoSetup
2433  * @version Introduced in firmware 4.0.10.27
2434  * @param setup GoSetup object.
2435  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2436  * @return Maximum valid Exposure value (microseconds).
2437  */
2438 GoFx(k64f) GoSetup_ExposureLimitMax(GoSetup setup, GoRole role);
2439 
2440 /**
2441  * Gets the minimum valid value for the Exposure setting.
2442  *
2443  * @public @memberof GoSetup
2444  * @version Introduced in firmware 4.0.10.27
2445  * @param setup GoSetup object.
2446  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2447  * @return Minimum valid Exposure value (microseconds).
2448  */
2449 GoFx(k64f) GoSetup_ExposureLimitMin(GoSetup setup, GoRole role);
2450 
2451 /**
2452  * Sets the exposure value.
2453  *
2454  * @public @memberof GoSetup
2455  * @version Introduced in firmware 4.0.10.27
2456  * @param setup GoSetup object.
2457  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2458  * @param exposure Intended exposure value.
2459  * @return Operation status.
2460  */
2461 GoFx(kStatus) GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure);
2462 
2463 /**
2464  * Gets the exposure value.
2465  *
2466  * @public @memberof GoSetup
2467  * @version Introduced in firmware 4.0.10.27
2468  * @param setup GoSetup object.
2469  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2470  * @return Exposure value (microseconds).
2471  */
2472 GoFx(k64f) GoSetup_Exposure(GoSetup setup, GoRole role);
2473 
2474 /**
2475  * Gets the exposure mode.
2476  *
2477  * @public @memberof GoSetup
2478  * @version Introduced in firmware 4.0.10.27
2479  * @param setup GoSetup object.
2480  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2481  * @return Exposure mode.
2482  */
2483 GoFx(GoExposureMode) GoSetup_ExposureMode(GoSetup setup, GoRole role);
2484 
2485 /**
2486  * Returns whether enhanced surface flatness filtering is supported on the device specified by the "role" parameter.
2487  * If enhanced surface flatness filtering is not supported on the device, then do not use any of the enhanced surface flatness filter APIs for that device.
2488  *
2489  * This API only needs to be called once because a device's support for enhanced surface flatness filtering does not change.
2490  *
2491  * @public @memberof GoSetup
2492  * @version Introduced in firmware 6.3.1.83
2493  * @param setup GoSetup object.
2494  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2495  * @return kTRUE if enhanced surface flatness filtering is support, otherwise kFALSE is returned.
2496  */
2497 GoFx(kBool) GoSetup_IsEnhancedSurfaceFlatnessFilterSupported(GoSetup setup, GoRole role);
2498 
2499 /**
2500  * Enables/disables use of enhanced surface flatness filtering if the device supports enhanced surface flatness filtering.
2501  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2502  * If enhanced surface flatness filtering is not supported an error code will be returned.
2503  *
2504  * @public @memberof GoSetup
2505  * @version Introduced in firmware 6.4.39.2
2506  * @param setup GoSetup object.
2507  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2508  * @param enable Whether to enable or disable enhanced surface flatness.
2509  * @return Operation status.
2510  */
2511 GoFx(kStatus) GoSetup_EnableEnhancedSurfaceFlatnessFilter(GoSetup setup, GoRole role, kBool enable);
2512 
2513 /**
2514  * Selects one of the builtin enhanced surface flatness filters to use, if device supports enhanced surface flatness filtering.
2515  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2516  * If enhanced surface flatness filtering is not supported an error code will be returned.
2517  *
2518  * Caller specifies which type of enhanced surface flatness filter to use and the length of the enhanced surface flatness filter (number of filter coefficients).
2519  *
2520  * Do not use this API to enable custom enhanced surface flatness filtering. Use GoSetup_SelectCustomEnhancedSurfaceFlatnessFilter() instead.
2521  *
2522  * @public @memberof GoSetup
2523  * @version Introduced in firmware 6.3.1.83
2524  * @param setup GoSetup object.
2525  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2526  * @param type Prefilter type other than GO_PREFILTER_TYPE_CUSTOM.
2527  * @param length The number of filter coefficients to use in the specified enhanced surface flatness filter mode.
2528  * @return Operation status.
2529  */
2530 GoFx(kStatus) GoSetup_SelectBuiltInEnhancedSurfaceFlatnessFilter(GoSetup setup, GoRole role, GoPreFilterType type, GoPreFilterLengthOption length);
2531 
2532 /**
2533  * Selects using a custom enhanced surface flatness filter, if device supports enhanced surface flatness filtering, where filter coefficients are provided by the user.
2534  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2535  * If enhanced surface flatness filtering is not supported an error code will be returned.
2536  *
2537  * This API sets three things to ensure consistency between all three properties of the custom enhanced surface flatness filter:
2538  * - sets the mode to GO_PREFILTER_TYPE_CUSTOM,
2539  * - sets the length of the enhanced surface flatness filter,
2540  * - and sets the actual coefficients for the enhanced surface flatness filter.
2541  *
2542  * The number of coefficients in the input array "coefficientsArray" MUST be equal to "length" parameter. This is the
2543  * responsibility of the caller. The API cannot know if the input array is too small, resulting in accessing memory outside
2544  * of the actual array, possibly leading to unpredictable behaviour.
2545  *
2546  * Each coefficient value must be with the range of the minimum and maximum allowable values given by
2547  * GoSetup_CoefficientMinValue() and GoSetup_CoefficientMaxValue().
2548  * The sum of all the coefficient values must be equal to GoSetup_CoefficientsExpectedSum().
2549  *
2550  * NOTE: because of the inherent limitations of exactly representing a floating point number, the above comparisons to the limits
2551  * cannot be exact.
2552  *
2553  * @public @memberof GoSetup
2554  * @version Introduced in firmware 6.3.1.83
2555  * @param setup GoSetup object.
2556  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2557  * @param length The number of filter coefficients to use in the custom enhanced surface flatness filter.
2558  * @param coefficientsArray An input array of enhanced surface flatness filter coefficients to use. Number of entries MUST be equal to length.
2559  * @return Operation status.
2560  */
2561 GoFx(kStatus) GoSetup_SelectCustomEnhancedSurfaceFlatnessFilter(GoSetup setup, GoRole role, GoPreFilterLengthOption length, const GoPreFilterCoefficient* coefficientsArray);
2562 
2563 /**
2564  * Checks if enhanced surface flatness is enabled, if device supports enhanced surface flatness filtering.
2565  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2566  *
2567  * @public @memberof GoSetup
2568  * @version Introduced in firmware 6.4.39.2
2569  * @param setup GoSetup object.
2570  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2571  * @return Whether enhanced surface flatness is enabled or not.
2572  */
2573 GoFx(kBool) GoSetup_EnhancedSurfaceFlatnessFilterEnabled(GoSetup setup, GoRole role);
2574 
2575 /**
2576  * Gets the enhanced surface flatness filter type, if device supports enhanced surface flatness filtering.
2577  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2578  *
2579  * @public @memberof GoSetup
2580  * @version Introduced in firmware 6.3.1.83
2581  * @param setup GoSetup object.
2582  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2583  * @return The enhanced surface flatness filter type currently selected.
2584  */
2585 GoFx(GoPreFilterType) GoSetup_EnhancedSurfaceFlatnessFilterType(GoSetup setup, GoRole role);
2586 
2587 /**
2588  * Gets the enhanced surface flatness filter length selected, if device supports enhanced surface flatness filtering.
2589  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2590  *
2591  * @public @memberof GoSetup
2592  * @version Introduced in firmware 6.3.1.83
2593  * @param setup GoSetup object.
2594  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2595  * @return Returns the length of the enhanced surface flatness filter that was selected.
2596  */
2597 GoFx(GoPreFilterLengthOption) GoSetup_EnhancedSurfaceFlatnessFilterLength(GoSetup setup, GoRole role);
2598 
2599 /**
2600  * Gets all the enhanced surface flatness filter coefficients currently in use, if device supports enhanced surface flatness filtering.
2601  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2602  *
2603  * The coefficients returned is for the currently selected enhanced surface flatness filter mode. The number of coefficients is
2604  * the value of GoPreFilterLengthOption in the GoSetup_SelectBuiltInEnhancedSurfaceFlatnessFilter() or
2605  * GoSetup_SelectCustomEnhancedSurfaceFlatnessFilter() API calls.
2606  *
2607  * @public @memberof GoSetup
2608  * @version Introduced in firmware 6.3.1.83
2609  * @param setup GoSetup object.
2610  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2611  * @return Output array of coefficients which is filled with the enhanced surface flatness filter coefficients in use.
2612  * The number of entries is the same as the GoPreFilterLengthOption parameter used to configure the enhanced surface flatness filter.
2613  */
2614 GoFx(const GoPreFilterCoefficient*) GoSetup_EnhancedSurfaceFlatnessFilterCoefficients(GoSetup setup, GoRole role);
2615 
2616 /**
2617  * Gets the smallest allowable enhanced surface flatness filter coefficient. This value is meaningful only if device supports enhanced surface flatness filtering.
2618  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2619  *
2620  * This is the smallest enhanced surface flatness filter coefficient value that can be used for a enhanced surface flatness filter.
2621  *
2622  * @public @memberof GoSetup
2623  * @version Introduced in firmware 6.3.1.83
2624  * @param setup GoSetup object.
2625  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2626  * @return Smallest allowable enhanced surface flatness filter coefficient for use in a enhanced surface flatness filter.
2627  */
2628 GoFx(k64f) GoSetup_EnhancedSurfaceFlatnessFilterCoefficientMinValue(GoSetup setup, GoRole role);
2629 
2630 /**
2631  * Gets the largest allowable enhanced surface flatness filter coefficient. This value is meaningful only if device supports enhanced surface flatness filtering.
2632  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2633  *
2634  * This is the largest enhanced surface flatness filter coefficient value that can be used for a enhanced surface flatness filter.
2635  *
2636  * @public @memberof GoSetup
2637  * @version Introduced in firmware 6.3.1.83
2638  * @param setup GoSetup object.
2639  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2640  * @return Largest allowable enhanced surface flatness filter coefficient for use in a enhanced surface flatness filter.
2641  */
2642 GoFx(k64f) GoSetup_EnhancedSurfaceFlatnessFilterCoefficientMaxValue(GoSetup setup, GoRole role);
2643 
2644 /**
2645  * Gets the expected value of the sum of all the enhanced surface flatness filter coefficients. This value is meaningful only if device supports enhanced surface flatness filtering.
2646  * Check that the device supports it by calling GoSetup_IsEnhancedSurfaceFlatnessFilterSupported().
2647  *
2648  * The sum of all the coefficient values for a enhanced surface flatness filter must equal to this expected sum value.
2649  *
2650  * @public @memberof GoSetup
2651  * @version Introduced in firmware 6.3.1.83
2652  * @param setup GoSetup object.
2653  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2654  * @return The expected sum of all the coefficients used in a enhanced surface flatness filter.
2655  */
2656 GoFx(k64f) GoSetup_EnhancedSurfaceFlatnessFilterCoefficientsExpectedSum(GoSetup setup, GoRole role);
2657 
2658 /**
2659  * Sets the exposure mode.
2660  *
2661  * @public @memberof GoSetup
2662  * @version Introduced in firmware 4.0.10.27
2663  * @param setup GoSetup object.
2664  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2665  * @param mode The exposure mode to use.
2666  * @return Operation status.
2667  */
2668 GoFx(kStatus) GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode);
2669 
2670 /**
2671  * Gets the exposure mode option at the given index.
2672  *
2673  * @public @memberof GoSetup
2674  * @version Introduced in firmware 4.0.10.27
2675  * @param setup GoSetup object.
2676  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2677  * @param index The index with which to retrieve an exposure mode option.
2678  * @return Exposure mode option.
2679  * @see GoSetup_ExposureModeOptionCount
2680  */
2681 GoFx(GoExposureMode) GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index);
2682 
2683 /**
2684  * Gets the exposure mode option count.
2685  *
2686  * @public @memberof GoSetup
2687  * @version Introduced in firmware 4.0.10.27
2688  * @param setup GoSetup object.
2689  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2690  * @return Exposure mode option count.
2691  */
2692 GoFx(kSize) GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role);
2693 
2694 /**
2695  * Adds an exposure step
2696  *
2697  * @public @memberof GoSetup
2698  * @version Introduced in firmware 4.0.10.27
2699  * @param setup GoSetup object.
2700  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2701  * @param exposure Exposure value (microseconds).
2702  * @return Operation status.
2703  */
2704 GoFx(kStatus) GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure);
2705 
2706 /**
2707  * Removes all exposure steps.
2708  *
2709  * @public @memberof GoSetup
2710  * @version Introduced in firmware 4.0.10.27
2711  * @param setup GoSetup object.
2712  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2713  * @return Operation status.
2714  */
2715 GoFx(kStatus) GoSetup_ClearExposureSteps(GoSetup setup, GoRole role);
2716 
2717 /**
2718  * Get the exposure step value specified by index
2719  *
2720  * @public @memberof GoSetup
2721  * @version Introduced in firmware 4.0.10.27
2722  * @param setup GoSetup object.
2723  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2724  * @param index The index of the exposure step to get.
2725  * @return The exposure step value (microseconds).
2726  * @see GoSetup_ExposureStepCount
2727  */
2728 GoFx(k64f) GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index);
2729 
2730 /**
2731  * Get the number of exposure steps defined
2732  *
2733  * @public @memberof GoSetup
2734  * @version Introduced in firmware 4.0.10.27
2735  * @param setup GoSetup object.
2736  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2737  * @return The count of exposure steps.
2738  */
2739 GoFx(kSize) GoSetup_ExposureStepCount(GoSetup setup, GoRole role);
2740 
2741 /**
2742  * Gets the maximum value for the Dynamic Exposure setting.
2743  *
2744  * @public @memberof GoSetup
2745  * @version Introduced in firmware 4.0.10.27
2746  * @param setup GoSetup object.
2747  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2748  * @return Maximum Dynamic Exposure value (microseconds).
2749  */
2750 GoFx(k64f) GoSetup_DynamicExposureMax(GoSetup setup, GoRole role);
2751 
2752 /**
2753  * Sets the maximum value for the Dynamic Exposure setting.
2754  *
2755  * @public @memberof GoSetup
2756  * @version Introduced in firmware 4.0.10.27
2757  * @param setup GoSetup object.
2758  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2759  * @param exposure Maximum Dynamic Exposure value (microseconds).
2760  * @return Operation status.
2761  */
2762 GoFx(kStatus) GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure);
2763 
2764 /**
2765  * Gets the minimum value for the Dynamic Exposure setting.
2766  *
2767  * @public @memberof GoSetup
2768  * @version Introduced in firmware 4.0.10.27
2769  * @param setup GoSetup object.
2770  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2771  * @return Minimum Dynamic Exposure value (microseconds).
2772  */
2773 GoFx(k64f) GoSetup_DynamicExposureMin(GoSetup setup, GoRole role);
2774 
2775 /**
2776  * Sets the minimum value for the Dynamic Exposure setting.
2777  *
2778  * @public @memberof GoSetup
2779  * @version Introduced in firmware 4.0.10.27
2780  * @param setup GoSetup object.
2781  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2782  * @param exposure Minumum Dynamic Exposure value (microseconds).
2783  * @return Operation status.
2784  */
2785 GoFx(kStatus) GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure);
2786 
2787 /**
2788  * Gets the minimum valid value for the ActiveAreaHeight setting.
2789  *
2790  * @public @memberof GoSetup
2791  * @version Introduced in firmware 4.0.10.27
2792  * @param setup GoSetup object.
2793  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2794  * @return Minimum valid ActiveAreaHeight value (mm).
2795  */
2796 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role);
2797 
2798 /**
2799  * Gets the maximum valid value for the ActiveAreaHeight setting.
2800  *
2801  * @public @memberof GoSetup
2802  * @version Introduced in firmware 4.0.10.27
2803  * @param setup GoSetup object.
2804  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2805  * @return Maximum valid active area height value (mm).
2806  */
2807 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role);
2808 
2809 /**
2810  * Gets the active area height.
2811  *
2812  * @public @memberof GoSetup
2813  * @version Introduced in firmware 4.0.10.27
2814  * @param setup GoSetup object.
2815  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2816  * @return Active area height (mm).
2817  */
2818 GoFx(k64f) GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role);
2819 
2820 /**
2821  * Sets the active area height.
2822  *
2823  * @public @memberof GoSetup
2824  * @version Introduced in firmware 4.0.10.27
2825  * @param setup GoSetup object.
2826  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2827  * @param value Active area height (mm).
2828  * @return Operation status.
2829  */
2830 GoFx(kStatus) GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value);
2831 
2832 /**
2833  * Gets the minimum valid value for the ActiveAreaLength setting.
2834  *
2835  * @public @memberof GoSetup
2836  * @version Introduced in firmware 4.0.10.27
2837  * @param setup GoSetup object.
2838  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2839  * @return Minimum valid ActiveAreaLength value (mm).
2840  */
2841 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role);
2842 
2843 /**
2844  * Gets the maximum valid value for the ActiveAreaLength setting.
2845  *
2846  * @public @memberof GoSetup
2847  * @version Introduced in firmware 4.0.10.27
2848  * @param setup GoSetup object.
2849  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2850  * @return Maximum valid ActiveAreaLength value (mm).
2851  */
2852 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role);
2853 
2854 /**
2855  * Sets the active area Length.
2856  *
2857  * @public @memberof GoSetup
2858  * @version Introduced in firmware 4.0.10.27
2859  * @param setup GoSetup object.
2860  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2861  * @param value Active area Length (mm).
2862  * @return Operation status.
2863  */
2864 GoFx(kStatus) GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value);
2865 
2866 /**
2867  * Gets the active area Length.
2868  *
2869  * @public @memberof GoSetup
2870  * @version Introduced in firmware 4.0.10.27
2871  * @param setup GoSetup object.
2872  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2873  * @return Active area Length (mm).
2874  */
2875 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
2876 
2877 
2878 /**
2879  * Gets the minimum valid value for the ActiveAreaWidth setting.
2880  *
2881  * @public @memberof GoSetup
2882  * @version Introduced in firmware 4.0.10.27
2883  * @param setup GoSetup object.
2884  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2885  * @return Minimum valid ActiveAreaWidth value (mm).
2886  */
2887 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role);
2888 
2889 /**
2890  * Gets the maximum valid value for the ActiveAreaWidth setting.
2891  *
2892  * @public @memberof GoSetup
2893  * @version Introduced in firmware 4.0.10.27
2894  * @param setup GoSetup object.
2895  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2896  * @return Maximum valid ActiveAreaWidth value (mm).
2897  */
2898 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role);
2899 
2900 /**
2901  * Sets the active area width.
2902  *
2903  * @public @memberof GoSetup
2904  * @version Introduced in firmware 4.0.10.27
2905  * @param setup GoSetup object.
2906  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2907  * @param value Active area width (mm).
2908  * @return Operation status.
2909  */
2910 GoFx(kStatus) GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value);
2911 
2912 /**
2913  * Gets the active area width.
2914  *
2915  * @public @memberof GoSetup
2916  * @version Introduced in firmware 4.0.10.27
2917  * @param setup GoSetup object.
2918  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2919  * @return Active area width (mm).
2920  */
2921 GoFx(k64f) GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role);
2922 
2923 /**
2924  * Gets the minimum valid value for the ActiveAreaX setting.
2925  *
2926  * @public @memberof GoSetup
2927  * @version Introduced in firmware 4.0.10.27
2928  * @param setup GoSetup object.
2929  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2930  * @return Minimum valid ActiveAreaX value (mm).
2931  */
2932 GoFx(k64f) GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role);
2933 
2934 /**
2935  * Gets the maximum valid value for the ActiveAreaX setting.
2936  *
2937  * @public @memberof GoSetup
2938  * @version Introduced in firmware 4.0.10.27
2939  * @param setup GoSetup object.
2940  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2941  * @return Maximum valid ActiveAreaX value (mm).
2942  */
2943 GoFx(k64f) GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role);
2944 
2945 /**
2946  * Sets the active area x origin.
2947  *
2948  * @public @memberof GoSetup
2949  * @version Introduced in firmware 4.0.10.27
2950  * @param setup GoSetup object.
2951  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2952  * @param value Active area x origin (mm).
2953  * @return Operation status.
2954  */
2955 GoFx(kStatus) GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value);
2956 
2957 /**
2958  * Gets the active area x origin.
2959  *
2960  * @public @memberof GoSetup
2961  * @version Introduced in firmware 4.0.10.27
2962  * @param setup GoSetup object.
2963  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2964  * @return Active area x origin (mm).
2965  */
2966 GoFx(k64f) GoSetup_ActiveAreaX(GoSetup setup, GoRole role);
2967 
2968 /**
2969  * Gets the minimum valid value for the ActiveAreaY setting.
2970  *
2971  * @public @memberof GoSetup
2972  * @version Introduced in firmware 4.0.10.27
2973  * @param setup GoSetup object.
2974  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2975  * @return Minimum valid ActiveAreaY value (mm).
2976  */
2977 GoFx(k64f) GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role);
2978 
2979 /**
2980  * Gets the maximum valid value for the ActiveAreaY setting.
2981  *
2982  * @public @memberof GoSetup
2983  * @version Introduced in firmware 4.0.10.27
2984  * @param setup GoSetup object.
2985  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2986  * @return Maximum valid ActiveAreaY value (mm).
2987  */
2988 GoFx(k64f) GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role);
2989 
2990 /**
2991  * Sets the active area Y.
2992  *
2993  * @public @memberof GoSetup
2994  * @version Introduced in firmware 4.0.10.27
2995  * @param setup GoSetup object.
2996  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2997  * @param value Active area y origin (mm).
2998  * @return Operation status.
2999  */
3000 GoFx(kStatus) GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value);
3001 
3002 /**
3003  * Gets the active area Y.
3004  *
3005  * @public @memberof GoSetup
3006  * @version Introduced in firmware 4.0.10.27
3007  * @param setup GoSetup object.
3008  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3009  * @return Active area y origin (mm).
3010  */
3011 GoFx(k64f) GoSetup_ActiveAreaY(GoSetup setup, GoRole role);
3012 
3013 /**
3014  * Gets the minimum valid value for the ActiveAreaZ setting.
3015  *
3016  * @public @memberof GoSetup
3017  * @version Introduced in firmware 4.0.10.27
3018  * @param setup GoSetup object.
3019  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3020  * @return Minimum valid ActiveAreaZ value (mm).
3021  */
3022 GoFx(k64f) GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role);
3023 
3024 /**
3025  * Gets the maximum valid value for the ActiveAreaZ setting.
3026  *
3027  * @public @memberof GoSetup
3028  * @version Introduced in firmware 4.0.10.27
3029  * @param setup GoSetup object.
3030  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3031  * @return Maximum valid ActiveAreaZ value (mm).
3032  */
3033 GoFx(k64f) GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role);
3034 
3035 /**
3036  * Sets the active area z origin.
3037  *
3038  * @public @memberof GoSetup
3039  * @version Introduced in firmware 4.0.10.27
3040  * @param setup GoSetup object.
3041  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3042  * @param value Active area z origin (mm).
3043  * @return Operation status.
3044  */
3045 GoFx(kStatus) GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value);
3046 
3047 /**
3048  * Gets the active area z origin.
3049  *
3050  * @public @memberof GoSetup
3051  * @version Introduced in firmware 4.0.10.27
3052  * @param setup GoSetup object.
3053  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3054  * @return Active area z origin (mm).
3055  */
3056 GoFx(k64f) GoSetup_ActiveAreaZ(GoSetup setup, GoRole role);
3057 
3058 /**
3059  * Gets the transformed data region X value.
3060  *
3061  * @public @memberof GoSetup
3062  * @version Introduced in firmware 4.0.10.27
3063  * @param setup GoSetup object.
3064  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3065  * @return The transformed data region X value.
3066  */
3067 GoFx(k64f) GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role);
3068 
3069 /**
3070  * Gets the transformed data region Y value.
3071  *
3072  * @public @memberof GoSetup
3073  * @version Introduced in firmware 4.0.10.27
3074  * @param setup GoSetup object.
3075  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3076  * @return The transformed data region Y value.
3077  */
3078 GoFx(k64f) GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role);
3079 
3080 /**
3081  * Gets the transformed data region Z value.
3082  *
3083  * @public @memberof GoSetup
3084  * @version Introduced in firmware 4.0.10.27
3085  * @param setup GoSetup object.
3086  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3087  * @return The transformed data region Z value.
3088  */
3089 GoFx(k64f) GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role);
3090 
3091 /**
3092  * Gets the transformed data region width value.
3093  *
3094  * @public @memberof GoSetup
3095  * @version Introduced in firmware 4.0.10.27
3096  * @param setup GoSetup object.
3097  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3098  * @return The transformed data region width value.
3099  */
3100 GoFx(k64f) GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role);
3101 
3102 /**
3103  * Gets the transformed data region length value.
3104  *
3105  * @public @memberof GoSetup
3106  * @version Introduced in firmware 4.0.10.27
3107  * @param setup GoSetup object.
3108  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3109  * @return The transformed data region length value.
3110  */
3111 GoFx(k64f) GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role);
3112 
3113 /**
3114  * Gets the transformed data region height value.
3115  *
3116  * @public @memberof GoSetup
3117  * @version Introduced in firmware 4.0.10.27
3118  * @param setup GoSetup object.
3119  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3120  * @return The transformed data region height value.
3121  */
3122 GoFx(k64f) GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role);
3123 
3124 /**
3125  * Gets the count of valid x-resolution options.
3126  *
3127  * @public @memberof GoSetup
3128  * @version Introduced in firmware 4.0.10.27
3129  * @param setup GoSetup object.
3130  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3131  * @return Count of x-resolution options.
3132  */
3133 GoFx(kSize) GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role);
3134 
3135 /**
3136  * Gets the x-resolution option at the specified index.
3137  *
3138  * @public @memberof GoSetup
3139  * @version Introduced in firmware 4.0.10.27
3140  * @param setup GoSetup object.
3141  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3142  * @param index Index of the desired resolution option.
3143  * @return X resolution option.
3144  * @see GoSetup_XSubsamplingOptionCount
3145  */
3146 GoFx(k32u) GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
3147 
3148 /**
3149  * Sets the current x-resolution divider.
3150  *
3151  * @public @memberof GoSetup
3152  * @version Introduced in firmware 4.0.10.27
3153  * @param setup GoSetup object.
3154  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3155  * @param xSubsampling X subsampling divider (e.g. 1 - full res, 2 - half res).
3156  * @return Operation status.
3157  */
3158 GoFx(kStatus) GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling);
3159 
3160 /**
3161  * Gets the current x-resolution divider.
3162  *
3163  * @public @memberof GoSetup
3164  * @version Introduced in firmware 4.0.10.27
3165  * @param setup GoSetup object.
3166  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3167  * @return X resolution divider (e.g. 1 - full res, 2 - half res).
3168  */
3169 GoFx(k32u) GoSetup_XSubsampling(GoSetup setup, GoRole role);
3170 
3171 /**
3172  * Returns whether the value used for the x-resolution divider is the one set by the user or the system default value.
3173  *
3174  * @public @memberof GoSetup
3175  * @version Introduced in firmware 6.3.1.83
3176  * @param setup GoSetup object.
3177  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3178  * @return kTRUE if the user value is used and kFALSE if system default is used.
3179  */
3180 GoFx(kBool) GoSetup_XSubsamplingUsed(GoSetup setup, GoRole role);
3181 
3182 /**
3183  * Gets the x-resolution divider system value.
3184  *
3185  * @public @memberof GoSetup
3186  * @version Introduced in firmware 6.3.1.83
3187  * @param setup GoSetup object.
3188  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3189  * @return X resolution divider (e.g. 1 - full res, 2 - half res) system value.
3190  */
3191 GoFx(k32u) GoSetup_XSubsamplingSystemValue(GoSetup setup, GoRole role);
3192 
3193 /**
3194  * Returns whether the sensor has a x-resolution divider default value or not.
3195  *
3196  * Note: Not all sensors will support a default x-resolution divider. If available, this
3197  * function indicates whether the current sensor has a default value.
3198  *
3199  *
3200  * @public @memberof GoSetup
3201  * @version Introduced in firmware 6.3.1.83
3202  * @param setup GoSetup object.
3203  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3204  * @return kTRUE if a default divider is available and kFALSE if not available.
3205  */
3206 GoFx(kBool) GoSetup_XSubsamplingDefaultEnabledUsed(GoSetup setup, GoRole role);
3207 
3208 /**
3209  * Sets whether to use the sensor's default x-resolution divider or the user-selected divider.
3210  *
3211  * Note: Not all sensors will support a default x-resolution divider. If available as indicated
3212  * by GoSetup_XSubsamplingDefaultEnabledUsed(), this function allows the mode to be switched from
3213  * either Default (true) or a Custom (false) mode.
3214  *
3215  * @public @memberof GoSetup
3216  * @version Introduced in firmware 6.3.1.83
3217  * @param setup GoSetup object.
3218  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3219  * @param useDefault Determines whether to use the Default x-resolution divider (true) or Custom one set by the user (false).
3220  * @return Operation status.
3221  */
3222 GoFx(kStatus) GoSetup_SetXSubsamplingDefaultEnabled(GoSetup setup, GoRole role, kBool useDefault);
3223 
3224 /**
3225  * Returns whether the x-resolution divider default is being used.
3226  *
3227  * Note: Not all sensors will support a default x-resolution divider. If available as indicated
3228  * by GoSetup_XSubsamplingDefaultEnabledUsed(), this function returns the current mode set.
3229  *
3230  * @public @memberof GoSetup
3231  * @version Introduced in firmware 6.3.1.83
3232  * @param setup GoSetup object.
3233  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3234  * @return Indicates whether the default x-resolution divider mode is set to Default (kTRUE) or Custom (kFALSE).
3235  */
3236 GoFx(kBool) GoSetup_XSubsamplingDefaultEnabled(GoSetup setup, GoRole role);
3237 
3238 /**
3239  * Gets the count of valid z-resolution options.
3240  *
3241  * @public @memberof GoSetup
3242  * @version Introduced in firmware 4.0.10.27
3243  * @param setup GoSetup object.
3244  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3245  * @return Count of z-resolution options.
3246  */
3247 GoFx(kSize) GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role);
3248 
3249 /**
3250  * Gets the z-resolution option at the specified index.
3251  *
3252  * @public @memberof GoSetup
3253  * @version Introduced in firmware 4.0.10.27
3254  * @param setup GoSetup object.
3255  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3256  * @param index Index of the desired resolution option.
3257  * @return Z resolution option.
3258  * see GoSetup_ZSubsamplingOptionCount
3259  */
3260 GoFx(k32u) GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
3261 
3262 /**
3263  * Sets the current z-resolution divider.
3264  *
3265  * @public @memberof GoSetup
3266  * @version Introduced in firmware 4.0.10.27
3267  * @param setup GoSetup object.
3268  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3269  * @param zSubsampling Z subsampling divider (e.g. 1 - full res, 2 - half res).
3270  * @return Operation status.
3271  */
3272 GoFx(kStatus) GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling);
3273 
3274 /**
3275  * Gets the current z-resolution divider.
3276  *
3277  * @public @memberof GoSetup
3278  * @version Introduced in firmware 4.0.10.27
3279  * @param setup GoSetup object.
3280  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3281  * @return Z resolution divider (e.g. 1 - full res, 2 - half res).
3282  */
3283 GoFx(k32u) GoSetup_ZSubsampling(GoSetup setup, GoRole role);
3284 
3285 /**
3286  * Returns whether the value used for the z-resolution divider is the one set by the user or the system default value.
3287  *
3288  * @public @memberof GoSetup
3289  * @version Introduced in firmware 6.3.1.83
3290  * @param setup GoSetup object.
3291  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3292  * @return kTRUE if the user value is used and kFALSE if system default is used.
3293  */
3294 GoFx(kBool) GoSetup_ZSubsamplingUsed(GoSetup setup, GoRole role);
3295 
3296 /**
3297  * Gets the z-resolution divider system value.
3298  *
3299  * @public @memberof GoSetup
3300  * @version Introduced in firmware 6.3.1.83
3301  * @param setup GoSetup object.
3302  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3303  * @return Z resolution divider (e.g. 1 - full res, 2 - half res) system value.
3304  */
3305 GoFx(k32u) GoSetup_ZSubsamplingSystemValue(GoSetup setup, GoRole role);
3306 
3307 /**
3308  * Returns whether the sensor has a z-resolution divider default value or not.
3309  *
3310  * Note: Not all sensors will support a default z-resolution divider. If available, this
3311  * function indicates whether the current sensor has a default value.
3312  *
3313  * @public @memberof GoSetup
3314  * @version Introduced in firmware 6.3.1.83
3315  * @param setup GoSetup object.
3316  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3317  * @return kTRUE if a default divider is available and kFALSE if not available.
3318  */
3319 GoFx(kBool) GoSetup_ZSubsamplingDefaultEnabledUsed(GoSetup setup, GoRole role);
3320 
3321 /**
3322  * Sets whether to use the sensor's default z-resolution divider or the user-selected divider.
3323  *
3324  * Note: Not all sensors will support a default z-resolution divider. If available as indicated
3325  * by GoSetup_ZSubsamplingDefaultEnabledUsed(), this function allows the mode to be switched from
3326  * either Default (true) or a Custom (false) mode.
3327  *
3328  * @public @memberof GoSetup
3329  * @version Introduced in firmware 6.3.1.83
3330  * @param setup GoSetup object.
3331  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3332  * @param useDefault Determines whether to use the Default z-resolution divider (true) or Custom one set by the user (false).
3333  * @return Operation status.
3334  */
3335 GoFx(kStatus) GoSetup_SetZSubsamplingDefaultEnabled(GoSetup setup, GoRole role, kBool useDefault);
3336 
3337 /**
3338  * Returns whether the z-resolution divider default is being used.
3339  *
3340  * Note: Not all sensors will support a default x-resolution divider. If available as indicated
3341  * by GoSetup_XSubsamplingDefaultEnabledUsed(), this function returns the current mode set.
3342  *
3343  * @public @memberof GoSetup
3344  * @version Introduced in firmware 6.3.1.83
3345  * @param setup GoSetup object.
3346  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3347  * @return Indicates whether the default z-resolution divider mode is set to Default (kTRUE) or Custom (kFALSE).
3348  */
3349 GoFx(kBool) GoSetup_ZSubsamplingDefaultEnabled(GoSetup setup, GoRole role);
3350 
3351 /**
3352  * Gets the camera region-of-interest x origin.
3353  *
3354  * @public @memberof GoSetup
3355  * @version Introduced in firmware 4.0.10.27
3356  * @param setup GoSetup object.
3357  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3358  * @return Region of interest x origin (pixels).
3359  */
3360 GoFx(k32u) GoSetup_FrontCameraX(GoSetup setup, GoRole role);
3361 
3362 /**
3363  * Gets the camera region-of-interest y origin.
3364  *
3365  * @public @memberof GoSetup
3366  * @version Introduced in firmware 4.0.10.27
3367  * @param setup GoSetup object.
3368  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3369  * @return Region of interest y origin (pixels).
3370  */
3371 GoFx(k32u) GoSetup_FrontCameraY(GoSetup setup, GoRole role);
3372 
3373 /**
3374  * Gets the camera region-of-interest width.
3375  *
3376  * @public @memberof GoSetup
3377  * @version Introduced in firmware 4.0.10.27
3378  * @param setup GoSetup object.
3379  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3380  * @return Region of interest width (pixels).
3381  */
3382 GoFx(k32u) GoSetup_FrontCameraWidth(GoSetup setup, GoRole role);
3383 
3384 /**
3385  * Gets the camera region-of-interest height.
3386  *
3387  * @public @memberof GoSetup
3388  * @version Introduced in firmware 4.0.10.27
3389  * @param setup GoSetup object.
3390  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3391  * @return Region of interest height (pixels).
3392  */
3393 GoFx(k32u) GoSetup_FrontCameraHeight(GoSetup setup, GoRole role);
3394 
3395 /**
3396  * Returns a boolean representing whether the back camera element is used.
3397  *
3398  * @public @memberof GoSetup
3399  * @version Introduced in firmware 4.1.3.106
3400  * @param setup GoSetup object.
3401  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3402  * @return kTRUE if used, or kFALSE if not used.
3403  */
3404 GoFx(k32u) GoSetup_BackCameraUsed(GoSetup setup, GoRole role);
3405 
3406 /**
3407  * Gets the camera region-of-interest x origin.
3408  *
3409  * @public @memberof GoSetup
3410  * @version Introduced in firmware 4.0.10.27
3411  * @param setup GoSetup object.
3412  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3413  * @return Region of interest x origin (pixels).
3414  */
3415 GoFx(k32u) GoSetup_BackCameraX(GoSetup setup, GoRole role);
3416 
3417 /**
3418  * Gets the camera region-of-interest y origin.
3419  *
3420  * @public @memberof GoSetup
3421  * @version Introduced in firmware 4.0.10.27
3422  * @param setup GoSetup object.
3423  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3424  * @return Region of interest y origin (pixels).
3425  */
3426 GoFx(k32u) GoSetup_BackCameraY(GoSetup setup, GoRole role);
3427 
3428 /**
3429  * Gets the camera region-of-interest width.
3430  *
3431  * @public @memberof GoSetup
3432  * @version Introduced in firmware 4.0.10.27
3433  * @param setup GoSetup object.
3434  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3435  * @return Region of interest width (pixels).
3436  */
3437 GoFx(k32u) GoSetup_BackCameraWidth(GoSetup setup, GoRole role);
3438 
3439 /**
3440  * Gets the camera region-of-interest height.
3441  *
3442  * @public @memberof GoSetup
3443  * @version Introduced in firmware 4.0.10.27
3444  * @param setup GoSetup object.
3445  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3446  * @return Region of interest height (pixels).
3447  */
3448 GoFx(k32u) GoSetup_BackCameraHeight(GoSetup setup, GoRole role);
3449 
3450 /**
3451  * Enables tracking.
3452  *
3453  * @public @memberof GoSetup
3454  * @version Introduced in firmware 4.0.10.27
3455  * @param setup GoSetup object.
3456  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3457  * @param enable kTRUE to enable, or kFALSE to disable.
3458  * @return Operation status.
3459  */
3460 GoFx(kStatus) GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable);
3461 
3462 /**
3463  * Determines if tracking is enabled.
3464  *
3465  * @public @memberof GoSetup
3466  * @version Introduced in firmware 4.0.10.27
3467  * @param setup GoSetup object.
3468  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3469  * @return kTRUE if enabled, or kFALSE if disabled.
3470  */
3471 GoFx(kBool) GoSetup_TrackingEnabled(GoSetup setup, GoRole role);
3472 
3473 /**
3474  * Returns a boolean value representing whether the Tracking Enabled field is used.
3475  *
3476  * @public @memberof GoSetup
3477  * @version Introduced in firmware 4.1.3.106
3478  * @param setup GoSetup object.
3479  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3480  * @return kTRUE if used, or kFALSE if not used.
3481  */
3482 GoFx(kBool) GoSetup_TrackingUsed(GoSetup setup, GoRole role);
3483 
3484 /**
3485  * Sets the tracking window height.
3486  *
3487  * @public @memberof GoSetup
3488  * @version Introduced in firmware 4.0.10.27
3489  * @param setup GoSetup object.
3490  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3491  * @param height Tracking window height (mm).
3492  * @return Operation status.
3493  */
3494 GoFx(kStatus) GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height);
3495 
3496 /**
3497  * Gets the tracking window height.
3498  *
3499  * @public @memberof GoSetup
3500  * @version Introduced in firmware 4.0.10.27
3501  * @param setup GoSetup object.
3502  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3503  * @return Tracking window height (mm).
3504  */
3505 GoFx(k64f) GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role);
3506 
3507 /**
3508  * Gets the tracking window height minimum limit.
3509  *
3510  * @public @memberof GoSetup
3511  * @version Introduced in firmware 4.0.10.27
3512  * @param setup GoSetup object.
3513  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3514  * @return Tracking window height min(mm).
3515  */
3516 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role);
3517 
3518 /**
3519  * Gets the tracking window height maximum limit.
3520  *
3521  * @public @memberof GoSetup
3522  * @version Introduced in firmware 4.0.10.27
3523  * @param setup GoSetup object.
3524  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3525  * @return Tracking window height max(mm).
3526  */
3527 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role);
3528 
3529 /**
3530  * Sets the tracking window search threshold.
3531  *
3532  * @public @memberof GoSetup
3533  * @version Introduced in firmware 4.0.10.27
3534  * @param setup GoSetup object.
3535  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3536  * @param threshold Tracking window search threshold (%)
3537  * @return Operation status.
3538  */
3539 GoFx(kStatus) GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold);
3540 
3541 /**
3542  * Gets the tracking window search threshold.
3543  *
3544  * @public @memberof GoSetup
3545  * @version Introduced in firmware 4.0.10.27
3546  * @param setup GoSetup object.
3547  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3548  * @return Tracking window search threshold (%).
3549  */
3550 GoFx(k64f) GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role);
3551 
3552 /**
3553  * Returns the state of whether the user specified spacing interval is used.
3554  *
3555  * @public @memberof GoSetup
3556  * @version Introduced in firmware 4.0.10.27
3557  * @param setup GoSetup object.
3558  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3559  * @return kTRUE if the user value is used and kFALSE otherwise.
3560  */
3561 GoFx(kBool) GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role);
3562 
3563 /**
3564  * Gets the spacing interval system value.
3565  *
3566  * @public @memberof GoSetup
3567  * @version Introduced in firmware 4.0.10.27
3568  * @param setup GoSetup object.
3569  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3570  * @return Spacing interval.
3571  */
3572 GoFx(k64f) GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role);
3573 
3574 /**
3575  * Gets the spacing interval.
3576  *
3577  * @public @memberof GoSetup
3578  * @version Introduced in firmware 4.0.10.27
3579  * @param setup GoSetup object.
3580  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3581  * @return Spacing interval.
3582  */
3583 GoFx(k64f) GoSetup_SpacingInterval(GoSetup setup, GoRole role);
3584 
3585 /**
3586  * Sets the spacing interval.
3587  *
3588  * @public @memberof GoSetup
3589  * @note Supported with G3
3590  * @version Introduced in firmware 4.0.10.27
3591  * @param setup GoSetup object.
3592  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3593  * @param value The spacing interval.
3594  * @return Operation status.
3595  */
3596 GoFx(kStatus) GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value);
3597 
3598 /**
3599  * Gets the spacing interval value limit minimum.
3600  *
3601  * @public @memberof GoSetup
3602  * @version Introduced in firmware 4.0.10.27
3603  * @param setup GoSetup object.
3604  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3605  * @return Spacing interval value limit minimum.
3606  */
3607 GoFx(k64f) GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role);
3608 
3609 /**
3610  * Gets the spacing interval value limit maximum
3611  *
3612  * @public @memberof GoSetup
3613  * @version Introduced in firmware 4.0.10.27
3614  * @param setup GoSetup object.
3615  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3616  * @return Spacing interval value limit maximum.
3617  */
3618 GoFx(k64f) GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role);
3619 
3620 /**
3621  * Gets the spacing interval type.
3622  *
3623  * @public @memberof GoSetup
3624  * @version Introduced in firmware 4.0.10.27
3625  * @param setup GoSetup object.
3626  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3627  * @return The spacing interval type.
3628  */
3629 GoFx(GoSpacingIntervalType) GoSetup_SpacingIntervalType(GoSetup setup, GoRole role);
3630 
3631 /**
3632  * Sets the spacing interval type.
3633  *
3634  * @public @memberof GoSetup
3635  * @version Introduced in firmware 4.0.10.27
3636  * @param setup GoSetup object.
3637  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3638  * @param type The spacing interval type.
3639  * @return Operation status.
3640  */
3641 GoFx(kStatus) GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type);
3642 
3643 /**
3644  * Gets the system value representing whether or not the user specified spacing interval type setting is being used at the moment.
3645  *
3646  * @public @memberof GoSetup
3647  * @version Introduced in firmware 4.0.10.27
3648  * @param setup GoSetup object.
3649  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3650  * @return kTRUE if the user specified spacing interval type setting is used and kFALSE otherwise.
3651  */
3652 GoFx(kBool) GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role);
3653 
3654 /**
3655  * Gets the X spacing count.
3656  * This is the number of resampled profile points in the layout
3657  * for the configured X-axis range and X-axis increment/step within
3658  * the range for the specified sensor.
3659  *
3660  * @public @memberof GoSetup
3661  * @version Introduced in firmware 4.0.10.27
3662  * @param setup GoSetup object.
3663  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3664  * @return X spacing count.
3665  */
3666 GoFx(k32u) GoSetup_XSpacingCount(GoSetup setup, GoRole role);
3667 
3668 /**
3669  * Gets the Y spacing count.
3670  *
3671  * @public @memberof GoSetup
3672  * @version Introduced in firmware 4.0.10.27
3673  * @param setup GoSetup object.
3674  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3675  * @return Y spacing count.
3676  */
3677 GoFx(k32u) GoSetup_YSpacingCount(GoSetup setup, GoRole role);
3678 
3679 /**
3680  * Gets the intensity step index.
3681  *
3682  * @public @memberof GoSetup
3683  * @version Introduced in firmware 4.0.10.27
3684  * @param setup GoSetup object.
3685  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3686  * @return The intensity step index.
3687  */
3688 GoFx(kSize) GoSetup_IntensityStepIndex(GoSetup setup, GoRole role);
3689 
3690 /**
3691  * Sets the intensity step index.
3692  *
3693  * @public @memberof GoSetup
3694  * @version Introduced in firmware 4.0.10.27
3695  * @param setup GoSetup object.
3696  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3697  * @param index The exposure step index to use for intensity acquisition.
3698  * @return Operation status.
3699  * @see GoSetup_SetExposureMode, GoSetup_ExposureStepCount
3700  */
3701 GoFx(kStatus) GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index);
3702 
3703 /**
3704  * Gets the pattern sequence type option count.
3705  *
3706  * @public @memberof GoSetup
3707  * @version Introduced in firmware 4.2.4.7
3708  * @param setup GoSetup object.
3709  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3710  * @return Pattern sequence type option count.
3711  */
3712 GoFx(kSize) GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role);
3713 
3714 /**
3715  * Gets the pattern sequence type option at the given index.
3716  *
3717  * @public @memberof GoSetup
3718  * @version Introduced in firmware 4.2.4.7
3719  * @param setup GoSetup object.
3720  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3721  * @param index The index with which to retrieve a sequence type option.
3722  * @return A sequence type option value.
3723  * @see GoSetup_PatternSequenceOptionCount
3724  */
3725 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index);
3726 
3727 /**
3728  * Gets the pattern sequence type.
3729  *
3730  * @public @memberof GoSetup
3731  * @version Introduced in firmware 4.2.4.7
3732  * @param setup GoSetup object.
3733  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3734  * @return The pattern sequence type.
3735  */
3736 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceType(GoSetup setup, GoRole role);
3737 
3738 /**
3739  * Sets the pattern sequence type.
3740  *
3741  * @public @memberof GoSetup
3742  * @version Introduced in firmware 4.2.4.7
3743  * @param setup GoSetup object.
3744  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3745  * @param type The pattern sequence type to set.
3746  * @return Operation status.
3747  */
3748 GoFx(kStatus) GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type);
3749 
3750 /**
3751  * Returns a boolean value representing whether the pattern sequence type is used.
3752  *
3753  * @public @memberof GoSetup
3754  * @version Introduced in firmware 4.2.4.7
3755  * @param setup GoSetup object.
3756  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3757  * @return kTRUE if used and kFALSE otherwise.
3758  */
3759 GoFx(kBool) GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role);
3760 
3761 /**
3762  * Gets the current pattern sequence count.
3763  *
3764  * @public @memberof GoSetup
3765  * @version Introduced in firmware 4.2.4.7
3766  * @param setup GoSetup object.
3767  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3768  * @return The current pattern sequence count.
3769  */
3770 GoFx(kSize) GoSetup_PatternSequenceCount(GoSetup setup, GoRole role);
3771 
3772 /**
3773  * Gets the current phase pattern index.
3774  *
3775  * @public @memberof GoSetup
3776  * @version Introduced in firmware 5.3.19.50
3777  * @param setup GoSetup object.
3778  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3779  * @return The current phase pattern index.
3780  */
3781 GoFx(k32u) GoSetup_PatternSequenceIndex(GoSetup setup, GoRole role);
3782 
3783 /**
3784  * Sets the current phase pattern index.
3785  *
3786  * @public @memberof GoSetup
3787  * @version Introduced in firmware 5.3.19.50
3788  * @param setup GoSetup object.
3789  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3790  * @param index The index to use
3791  */
3792 GoFx(kStatus) GoSetup_SetPatternSequenceIndex(GoSetup setup, GoRole role, k32u index);
3793 
3794 /**
3795  * Gets the current phase pattern index used flag value.
3796  *
3797  * @public @memberof GoSetup
3798  * @version Introduced in firmware 5.3.19.50
3799  * @param setup GoSetup object.
3800  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3801  * @return The current phase pattern index used flag value.
3802  */
3803 GoFx(kBool) GoSetup_PatternSequenceIndexUsed(GoSetup setup, GoRole role);
3804 
3805 /**
3806  * Gets the current phase pattern index min value (inclusive).
3807  *
3808  * @public @memberof GoSetup
3809  * @version Introduced in firmware 5.3.19.50
3810  * @param setup GoSetup object.
3811  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3812  * @return The current phase pattern index minimum value (inclusive).
3813  */
3814 GoFx(k32u) GoSetup_PatternSequenceIndexMin(GoSetup setup, GoRole role);
3815 
3816 /**
3817  * Gets the current phase pattern index maximum value (inclusive).
3818  *
3819  * @public @memberof GoSetup
3820  * @version Introduced in firmware 5.3.19.50
3821  * @param setup GoSetup object.
3822  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3823  * @return The current phase pattern index maximum value (inclusive).
3824  */
3825 GoFx(k32u) GoSetup_PatternSequenceIndexMax(GoSetup setup, GoRole role);
3826 
3827 
3828 /**
3829  * Gets the layout configuration module.
3830  *
3831  * @public @memberof GoSetup
3832  * @version Introduced in firmware 4.0.10.27
3833  * @param setup GoSetup object.
3834  * @return Layout configuration module.
3835  */
3836 GoFx(GoLayout) GoSetup_Layout(GoSetup setup);
3837 
3838 /**
3839  * Gets the profile generation module, used for profile generation configuration.
3840  *
3841  * @public @memberof GoSetup
3842  * @version Introduced in firmware 4.2.4.7
3843  * @param setup GoSetup object.
3844  * @return Profile generation configuration module.
3845  */
3846 GoFx(GoProfileGeneration) GoSetup_ProfileGeneration(GoSetup setup);
3847 
3848 /**
3849  * Gets the surface generation module, used for surface generation configuration.
3850  *
3851  * @public @memberof GoSetup
3852  * @version Introduced in firmware 4.0.10.27
3853  * @param setup GoSetup object.
3854  * @return Surface generation configuration module.
3855  */
3856 GoFx(GoSurfaceGeneration) GoSetup_SurfaceGeneration(GoSetup setup);
3857 
3858 /**
3859  * Gets the part detection module, used for part detection configuration.
3860  *
3861  * @public @memberof GoSetup
3862  * @version Introduced in firmware 4.0.10.27
3863  * @param setup GoSetup object.
3864  * @return Part detection configuration module.
3865  */
3866 GoFx(GoPartDetection) GoSetup_PartDetection(GoSetup setup);
3867 
3868 /**
3869  * Gets the part matching module, used for part matching configuration.
3870  *
3871  * @public @memberof GoSetup
3872  * @version Introduced in firmware 4.2.4.7
3873  * @param setup GoSetup object.
3874  * @return Part matching configuration module.
3875  */
3876 GoFx(GoPartMatching) GoSetup_PartMatching(GoSetup setup);
3877 
3878 /**
3879 * Gets the advanced acquisition module, used for advanced acquisition configuration.
3880 *
3881 * @public @memberof GoSetup
3882 * @version Introduced in firmware 4.6
3883 * @param setup GoSetup object.
3884 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3885 * @return Advanced acquisition configuration module.
3886 */
3887 GoFx(GoAdvanced) GoSetup_Advanced(GoSetup setup, GoRole role);
3888 
3889 /**
3890  * Gets the Section configuration module, used for surface sections.
3891  *
3892  * @public @memberof GoSetup
3893  * @version Introduced in firmware 4.4.4.14
3894  * @param setup GoSetup object.
3895  * @return Section configuration module.
3896  */
3897 GoFx(GoSections) GoSetup_Sections(GoSetup setup);
3898 
3899 /**
3900  * Gets the tracheid configuration module.
3901  *
3902  * @public @memberof GoSetup
3903  * @version Introduced in firmware 4.5.3.57
3904  * @param setup GoSetup object.
3905  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3906  * @return Tracheid configuration module.
3907  */
3908 GoFx(GoTracheid) GoSetup_Tracheid(GoSetup setup, GoRole role);
3909 
3910 /**
3911 * Returns a boolean value representing the state of the independent exposures used field.
3912 * If this feature is available, it will use the exposure values and limits assigned to
3913 * both the front and back cameras.
3914 *
3915 * @public @memberof GoSetup
3916 * @version Introduced in firmware 4.6.0.140
3917 * @param setup GoSetup object.
3918 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3919 * @return kTRUE if used, or kFALSE if not used.
3920 */
3921 GoFx(kBool) GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role);
3922 
3923 /**
3924 * Enables independent exposures feature, i.e. separate exposures
3925 * for separate cameras.
3926 *
3927 * @public @memberof GoSetup
3928 * @version Introduced in firmware 4.6.0.140
3929 * @param setup GoSetup object.
3930 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3931 * @param enable kTRUE to enable, or kFALSE to disable.
3932 * @return Operation status.
3933 */
3934 GoFx(kStatus) GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable);
3935 
3936 /**
3937 * Determines if independent exposures feature is enabled.
3938 *
3939 * @public @memberof GoSetup
3940 * @version Introduced in firmware 4.6.0.140
3941 * @param setup GoSetup object.
3942 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3943 * @return kTRUE if enabled, or kFALSE if disabled.
3944 */
3945 GoFx(kBool) GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role);
3946 
3947 /**
3948 * Gets the maximum valid value for the front camera exposure setting.
3949 *
3950 * @public @memberof GoSetup
3951 * @version Introduced in firmware 4.6.0.140
3952 * @param setup GoSetup object.
3953 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3954 * @return Maximum valid auxiliary exposure value (microseconds).
3955 */
3956 GoFx(k64f) GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role);
3957 
3958 /**
3959 * Gets the minimum valid value for the front camara exposure setting.
3960 *
3961 * @public @memberof GoSetup
3962 * @version Introduced in firmware 4.6.0.140
3963 * @param setup GoSetup object.
3964 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3965 * @return Minimum valid auxiliary exposure value (microseconds).
3966 */
3967 GoFx(k64f) GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role);
3968 
3969 /**
3970 * Sets the front camera exposure value.
3971 *
3972 * @public @memberof GoSetup
3973 * @version Introduced in firmware 4.6.0.140
3974 * @param setup GoSetup object.
3975 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3976 * @param exposure Intended auxiliary exposure value.
3977 * @return Operation status.
3978 */
3979 GoFx(kStatus) GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure);
3980 
3981 /**
3982 * Gets the front camera exposure value.
3983 *
3984 * @public @memberof GoSetup
3985 * @version Introduced in firmware 4.6.0.140
3986 * @param setup GoSetup object.
3987 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3988 * @return Auxiliary exposure value (microseconds).
3989 */
3990 GoFx(k64f) GoSetup_FrontCameraExposure(GoSetup setup, GoRole role);
3991 
3992 /**
3993 * Gets the maximum valid value for the back camera exposure setting.
3994 *
3995 * @public @memberof GoSetup
3996 * @version Introduced in firmware 4.6.0.140
3997 * @param setup GoSetup object.
3998 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3999 * @return Maximum valid auxiliary exposure value (microseconds).
4000 */
4001 GoFx(k64f) GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role);
4002 
4003 /**
4004 * Gets the minimum valid value for the back camara exposure setting.
4005 *
4006 * @public @memberof GoSetup
4007 * @version Introduced in firmware 4.6.0.140
4008 * @param setup GoSetup object.
4009 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4010 * @return Minimum valid auxiliary exposure value (microseconds).
4011 */
4012 GoFx(k64f) GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role);
4013 
4014 /**
4015 * Sets the back camera exposure value.
4016 *
4017 * @public @memberof GoSetup
4018 * @version Introduced in firmware 4.6.0.140
4019 * @param setup GoSetup object.
4020 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4021 * @param exposure Intended auxiliary exposure value.
4022 * @return Operation status.
4023 */
4024 GoFx(kStatus) GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure);
4025 
4026 /**
4027 * Gets the back camera exposure value.
4028 *
4029 * @public @memberof GoSetup
4030 * @version Introduced in firmware 4.6.0.140
4031 * @param setup GoSetup object.
4032 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4033 * @return Auxiliary exposure value (microseconds).
4034 */
4035 GoFx(k64f) GoSetup_BackCameraExposure(GoSetup setup, GoRole role);
4036 
4037 /**
4038 * Gets the source used for generating intensity data.
4039 *
4040 * @public @memberof GoSetup
4041 * @version Introduced in firmware 4.6.0.152
4042 * @param setup GoSetup object.
4043 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4044 * @return Source of intensity data.
4045 */
4046 GoFx(GoIntensitySource) GoSetup_IntensitySource(GoSetup setup, GoRole role);
4047 
4048 /**
4049 * Sets the source to be used for generating intensity data.
4050 *
4051 * @public @memberof GoSetup
4052 * @version Introduced in firmware 4.6.0.152
4053 * @param setup GoSetup object.
4054 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4055 * @param source The source to be used.
4056 * @return Operation status.
4057 */
4058 GoFx(kStatus) GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source);
4059 
4060 /**
4061 * Gets the intensity data generation mode.
4062 *
4063 * @public @memberof GoSetup
4064 * @version Introduced in firmware 4.7.10.10
4065 * @param setup GoSetup object.
4066 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4067 * @return Intensity generation mode.
4068 */
4069 GoFx(GoIntensityMode) GoSetup_IntensityMode(GoSetup setup, GoRole role);
4070 
4071 /**
4072 * Sets the intensity data generation mode.
4073 *
4074 * @public @memberof GoSetup
4075 * @version Introduced in firmware 4.7.10.10
4076 * @param setup GoSetup object.
4077 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4078 * @param mode Intensity generation mode.
4079 * @return Operation status.
4080 */
4081 GoFx(kStatus) GoSetup_SetIntensityMode(GoSetup setup, GoRole role, GoIntensityMode mode);
4082 
4083 /**
4084 * Gets the availability of the intensity mode property.
4085 *
4086 * @public @memberof GoSetup
4087 * @version Introduced in firmware 4.7.10.10
4088 * @param setup GoSetup object.
4089 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4090 * @return kTRUE if available and kFALSE otherwise.
4091 */
4092 GoFx(kBool) GoSetup_IntensityModeUsed(GoSetup setup, GoRole role);
4093 
4094 /**
4095 * Gets the intensity source option at the given index.
4096 *
4097 * @public @memberof GoSetup
4098 * @version Introduced in firmware 4.6.0.152
4099 * @param setup GoSetup object.
4100 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4101 * @param index The index with which to retrieve an exposure mode option.
4102 * @return Intensity source set.
4103 * @see GoSetup_IntensitySourceOptionCount
4104 */
4105 GoFx(GoIntensitySource) GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index);
4106 
4107 /**
4108 * Gets the intensity source option count.
4109 *
4110 * @public @memberof GoSetup
4111 * @version Introduced in firmware 4.6.0.152
4112 * @param setup GoSetup object.
4113 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4114 * @return Intensity source option count.
4115 */
4116 GoFx(kSize) GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role);
4117 
4118 /**
4119 * Gets layout grid used state.
4120 *
4121 * @public @memberof GoSetup
4122 * @version Introduced in firmware 4.0.10.27
4123 * @param setup GoSetup object.
4124 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4125 * @return Whether grid is used in n-buddy system.
4126 */
4127 GoFx(kBool) GoSetup_LayoutGridUsed(GoSetup setup, GoRole role);
4128 
4129 /**
4130 * Gets layout grid direction system value being used on device in n-buddy system.
4131 *
4132 * @public @memberof GoSetup
4133 * @version Introduced in firmware 4.0.10.27
4134 * @param setup GoSetup object.
4135 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4136 * @return Whether grid direction is reversed system value.
4137 */
4138 GoFx(kBool) GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role);
4139 
4140 /**
4141 * Gets layout grid direction being configured (may not be applicable or used) on device in n-buddy system.
4142 *
4143 * @public @memberof GoSetup
4144 * @version Introduced in firmware 6.0.18.7
4145 * @param setup GoSetup object.
4146 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4147 * @return Whether grid direction is reversed.
4148 */
4149 GoFx(kBool) GoSetup_LayoutGridDirection(GoSetup setup, GoRole role);
4150 
4151 /**
4152 * Sets grid direction being configured (may not be applicable or used) on device in n-buddy system.
4153 *
4154 * @public @memberof GoSetup
4155 * @version Introduced in firmware 6.0.18.7
4156 * @param setup GoSetup object.
4157 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4158 * @param value Whether grid direction is reversed.
4159 * @return Operation status.
4160 */
4161 GoFx(kStatus) GoSetup_SetLayoutGridDirection(GoSetup setup, GoRole role, kBool value);
4162 
4163 /**
4164 * Gets column index system value being used on device in n-buddy system.
4165 *
4166 * @public @memberof GoSetup
4167 * @version Introduced in firmware 4.0.10.27
4168 * @param setup GoSetup object.
4169 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4170 * @return Layout grid column system value.
4171 */
4172 GoFx(k32s) GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role);
4173 
4174 /**
4175 * Gets column index being configured (may not be applicable or used) on device in n-buddy system.
4176 *
4177 * @public @memberof GoSetup
4178 * @version Introduced in firmware 6.0.18.7
4179 * @param setup GoSetup object.
4180 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4181 * @return column index.
4182 */
4183 GoFx(k32s) GoSetup_LayoutGridColumn(GoSetup setup, GoRole role);
4184 
4185 /**
4186 * Sets column index being configured (may not be applicable or used) on device in n-buddy system.
4187 *
4188 * @public @memberof GoSetup
4189 * @version Introduced in firmware 6.0.18.7
4190 * @param setup GoSetup object.
4191 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4192 * @param value Column index.
4193 * @return Operation status.
4194 */
4195 GoFx(kStatus) GoSetup_SetLayoutGridColumn(GoSetup setup, GoRole role, k32s value);
4196 
4197 /**
4198 * Gets row index system value being used on device in n-buddy system.
4199 *
4200 * @public @memberof GoSetup
4201 * @version Introduced in firmware 4.0.10.27
4202 * @param setup GoSetup object.
4203 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4204 * @return Layout grid row system value.
4205 */
4206 GoFx(k32s) GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role);
4207 
4208 /**
4209 * Gets row index being configured (may not be applicable or used) on device in n-buddy system.
4210 *
4211 * @public @memberof GoSetup
4212 * @version Introduced in firmware 6.0.18.7
4213 * @param setup GoSetup object.
4214 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4215 * @return row index.
4216 */
4217 GoFx(k32s) GoSetup_LayoutGridRow(GoSetup setup, GoRole role);
4218 
4219 /**
4220 * Sets row index being configured (may not be applicable or used) on device in n-buddy system.
4221 *
4222 * @public @memberof GoSetup
4223 * @version Introduced in firmware 6.0.18.7
4224 * @param setup GoSetup object.
4225 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4226 * @param value row index.
4227 * @return Operation status.
4228 */
4229 GoFx(kStatus) GoSetup_SetLayoutGridRow(GoSetup setup, GoRole role, k32s value);
4230 
4231 /**
4232 * Gets Multiplexing bank used state in n-buddy system.
4233 *
4234 * @public @memberof GoSetup
4235 * @version Introduced in firmware 4.0.10.27
4236 * @param setup GoSetup object.
4237 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4238 * @return Whether multiplexing bank is used.
4239 */
4240 GoFx(kBool) GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role);
4241 
4242 /**
4243 * Gets Multiplex bank system value being used on device in n-buddy system.
4244 *
4245 * @public @memberof GoSetup
4246 * @version Introduced in firmware 4.0.10.27
4247 * @param setup GoSetup object.
4248 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4249 * @return Multiplexing bank value system value.
4250 */
4251 GoFx(k32u) GoSetup_LayoutMultiplexingBankSystemValue(GoSetup setup, GoRole role);
4252 
4253 /**
4254 * Gets Multiplex bank value being configured (may not be applicable or used) on device in n-buddy system.
4255 *
4256 * @public @memberof GoSetup
4257 * @version Introduced in firmware 6.0.18.7
4258 * @param setup GoSetup object.
4259 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4260 * @return Multiplexing bank value.
4261 */
4262 GoFx(k32u) GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role);
4263 
4264 /**
4265 * Sets multiplexing bank value being configured (may not be applicable or used) on device in n-buddy system.
4266 *
4267 * @public @memberof GoSetup
4268 * @version Introduced in firmware 6.0.18.7
4269 * @param setup GoSetup object.
4270 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4271 * @param value Multiplexing bank value.
4272 * @return Operation status.
4273 */
4274 GoFx(kStatus) GoSetup_SetLayoutMultiplexingBank(GoSetup setup, GoRole role, k32u value);
4275 
4276 /**
4277  * [Deprecated] Use GoSetup_Advanced() instead.
4278  *
4279  * Gets the material acquisition module, used for material acquisition configuration.
4280  *
4281  * @deprecated
4282  * @public @memberof GoSetup
4283  * @version Introduced in firmware 4.1.3.106
4284  * @param setup GoSetup object.
4285  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
4286  * @return Material acquisition configuration module.
4287  */
4288 GoFx(GoMaterial) GoSetup_Material(GoSetup setup, GoRole role);
4289 
4290 #include <GoSdk/GoSetup.x.h>
4291 
4292 #endif
GoSetup::GoSetup_InputTriggerEnabledSystemValue
kBool GoSetup_InputTriggerEnabledSystemValue(GoSetup setup)
Gets the input trigger system value.
GoSetup::GoSetup_BarHoleCountValue
kSize GoSetup_BarHoleCountValue(GoSetup setup)
Gets the bar hole count system value.
GoSetup::GoSetup_EnableAlignmentEncoderCalibrate
kStatus GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled)
Enables encoder calibration after alignment.
GoSetup::GoSetup_OcclusionReductionEnabledUsed
kBool GoSetup_OcclusionReductionEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction configuration is used...
GoSetup::GoSetup_ActiveAreaHeightLimitMin
k64f GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaHeight setting.
GoSetup::GoSetup_ExternalInputZPulseIndex
k32u GoSetup_ExternalInputZPulseIndex(GoSetup setup)
Gets the external input index for triggering encoder Z-pulse.
GoSetup::GoSetup_BackgroundSuppressionRatio
k64u GoSetup_BackgroundSuppressionRatio(GoSetup setup)
Gets the background suppression ratio value.
GoSetup::GoSetup_SetXDecimationWindow
kStatus GoSetup_SetXDecimationWindow(GoSetup setup, k64f window)
Sets the x-direction decimation window.
GoSetup::GoSetup_ActiveAreaZLimitMin
k64f GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaZ setting.
GoSetup::GoSetup_UniformSpacingEnabledSystemValue
kBool GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup)
Gets the Uniform Spacing enabled system value.
GoSetup::GoSetup_ActiveAreaWidth
k64f GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role)
Gets the active area width.
GoSetup::GoSetup_XGapFillingUsed
kBool GoSetup_XGapFillingUsed(GoSetup setup)
Indicates whether X gap filling can be used for the current scan mode and device family.
GoSetup::GoSetup_ZSubsamplingDefaultEnabled
kBool GoSetup_ZSubsamplingDefaultEnabled(GoSetup setup, GoRole role)
Returns whether the z-resolution divider default is being used.
GoSetup::GoSetup_TriggerGateEnabled
kBool GoSetup_TriggerGateEnabled(GoSetup setup)
Reports whether the trigger gate feature is currently enabled.
GoSetup::GoSetup_XGapFillingWindowLimitMax
k64f GoSetup_XGapFillingWindowLimitMax(GoSetup setup)
Gets the x-direction gap-filling window maximum.
GoSetup::GoSetup_AlignmentMovingTargetOptionAt
GoAlignmentTarget GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index)
Gets the moving alignment target option at the given index.
GoSetup::GoSetup_ActiveAreaXLimitMax
k64f GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaX setting.
GoSetup::GoSetup_LayoutGridColumnSystemValue
k32s GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role)
Gets column index system value being used on device in n-buddy system.
GoSetup::GoSetup_ActiveAreaHeightLimitMax
k64f GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaHeight setting.
GoSetup::GoSetup_EnhancedSurfaceFlatnessFilterCoefficientMaxValue
k64f GoSetup_EnhancedSurfaceFlatnessFilterCoefficientMaxValue(GoSetup setup, GoRole role)
Gets the largest allowable enhanced surface flatness filter coefficient.
GoSetup::GoSetup_ZSubsamplingUsed
kBool GoSetup_ZSubsamplingUsed(GoSetup setup, GoRole role)
Returns whether the value used for the z-resolution divider is the one set by the user or the system ...
GoSetup::GoSetup_SetActiveAreaLength
kStatus GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value)
Sets the active area Length.
GoSetup::GoSetup_TriggerUnit
GoTriggerUnits GoSetup_TriggerUnit(GoSetup setup)
Gets the system trigger units.
GoSetup::GoSetup_SetPlateHoleCount
kStatus GoSetup_SetPlateHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration plate.
GoSetup::GoSetup_SetAlignmentType
kStatus GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type)
Sets the type used for alignment.
GoSetup::GoSetup_YMedianWindowLimitMin
k64f GoSetup_YMedianWindowLimitMin(GoSetup setup)
Gets the y-direction median window minimum.
GoSetup::GoSetup_LayoutGridRow
k32s GoSetup_LayoutGridRow(GoSetup setup, GoRole role)
Gets row index being configured (may not be applicable or used) on device in n-buddy system...
GoSetup::GoSetup_XSlopeUsed
kBool GoSetup_XSlopeUsed(GoSetup setup)
Indicates whether X slope can be used for the current scan mode and device family.
GoSetup::GoSetup_SetXSubsamplingDefaultEnabled
kStatus GoSetup_SetXSubsamplingDefaultEnabled(GoSetup setup, GoRole role, kBool useDefault)
Sets whether to use the sensor's default x-resolution divider or the user-selected divider...
GoSetup::GoSetup_ActiveAreaWidthLimitMax
k64f GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaWidth setting.
GoIntensitySource
Represents all possible sources of intensity data.
GoSetup::GoSetup_UniformSpacingAvailable
kBool GoSetup_UniformSpacingAvailable(GoSetup setup)
Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used a...
GoSetup::GoSetup_LayoutGridRowSystemValue
k32s GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role)
Gets row index system value being used on device in n-buddy system.
GoSetup::GoSetup_Exposure
k64f GoSetup_Exposure(GoSetup setup, GoRole role)
Gets the exposure value.
GoSetup::GoSetup_XMedianWindow
k64f GoSetup_XMedianWindow(GoSetup setup)
Gets the x-direction median window.
GoSetup::GoSetup_XGapFillingWindow
k64f GoSetup_XGapFillingWindow(GoSetup setup)
Gets the x-direction gap-filling window.
GoSetup::GoSetup_YGapFillingEnabled
kBool GoSetup_YGapFillingEnabled(GoSetup setup)
Gets the status of y-direction gap-filling.
GoAdvanced
Represents configurable advanced acquisition settings.
GoSetup::GoSetup_XGapFillingEnabled
kBool GoSetup_XGapFillingEnabled(GoSetup setup)
Gets the status of x-direction gap-filling.
GoSetup::GoSetup_EnableYMedian
kStatus GoSetup_EnableYMedian(GoSetup setup, kBool enable)
Sets the status of y-direction median.
GoSetup::GoSetup_ActiveAreaY
k64f GoSetup_ActiveAreaY(GoSetup setup, GoRole role)
Gets the active area Y.
GoSetup::GoSetup_SetReversalDistanceAutoEnabled
kStatus GoSetup_SetReversalDistanceAutoEnabled(GoSetup setup, kBool enabled)
This API is experimental and may change in a future release Enables or disables auto encoder reversal...
GoSetup::GoSetup_ZSubsamplingOptionAt
k32u GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the z-resolution option at the specified index.
GoPartDetection.h
Declares the GoPartDetection class.
GoSetup::GoSetup_EnableMaxFrameRate
kStatus GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable)
Enables or disables operation at full frame rate (ignoring frame rate setting).
GoSetup::GoSetup_TrackingAreaHeight
k64f GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role)
Gets the tracking window height.
GoSetup::GoSetup_ActiveAreaYLimitMin
k64f GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_ReversalDistanceAutoEnabled
kBool GoSetup_ReversalDistanceAutoEnabled(GoSetup setup)
This API is experimental and may change in a future release Returns whether or not auto encoder rever...
GoPreFilterType
Represents a prefilter type.
GoSetup::GoSetup_PatternSequenceTypeOptionCount
kSize GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role)
Gets the pattern sequence type option count.
GoSetup::GoSetup_XSubsamplingSystemValue
k32u GoSetup_XSubsamplingSystemValue(GoSetup setup, GoRole role)
Gets the x-resolution divider system value.
GoSetup::GoSetup_AddExposureStep
kStatus GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure)
Adds an exposure step.
GoSetup::GoSetup_TriggerDelay
k64f GoSetup_TriggerDelay(GoSetup setup)
Gets the trigger delay.
GoSetup::GoSetup_EnablePreferMasterTimeEncoderEnabled
kStatus GoSetup_EnablePreferMasterTimeEncoderEnabled(GoSetup setup, kBool enable)
Sets whether the time and encoder values are preferred to come from the Master rather than from the s...
GoSetup::GoSetup_SetActiveAreaWidth
kStatus GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value)
Sets the active area width.
GoSetup::GoSetup_TriggerExternalInputIndexUsed
kBool GoSetup_TriggerExternalInputIndexUsed(GoSetup setup)
Gets the flag indicating whether the external input trigger is being used.
GoSetup::GoSetup_BarDegreesOfFreedomUsed
kBool GoSetup_BarDegreesOfFreedomUsed(GoSetup setup)
Indicates if the degrees of freedom for bar alignment can be modified by the user.
GoSections.h
Declares the GoSections class.
GoSetup::GoSetup_BackCameraX
k32u GoSetup_BackCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
GoSetup::GoSetup_XSubsamplingOptionCount
kSize GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid x-resolution options.
GoSetup::GoSetup_BackCameraExposure
k64f GoSetup_BackCameraExposure(GoSetup setup, GoRole role)
Gets the back camera exposure value.
GoSetup::GoSetup_TransformedDataRegionX
k64f GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role)
Gets the transformed data region X value.
GoTracheid
Represents tracheid data.
GoSetup::GoSetup_SetAlignmentMovingTarget
kStatus GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target)
Sets the target type used for moving alignment calibration.
GoSetup::GoSetup_YMedianUsed
kBool GoSetup_YMedianUsed(GoSetup setup)
Indicates whether Y median can be used for the current scan mode and device family.
GoSetup::GoSetup_TriggerExternalInputIndexOptionCount
kSize GoSetup_TriggerExternalInputIndexOptionCount(GoSetup setup)
Gets the count of available external input trigger index options.
GoSetup::GoSetup_TriggerSourceOptionCount
kSize GoSetup_TriggerSourceOptionCount(GoSetup setup)
Gets the count of available trigger source options.
GoSetup::GoSetup_YSmoothingUsed
kBool GoSetup_YSmoothingUsed(GoSetup setup)
Indicates whether Y smoothing can be used for the current scan mode and device family.
GoSetup::GoSetup_TransformedDataRegionLength
k64f GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role)
Gets the transformed data region length value.
GoSetup::GoSetup_UniformSpacingEnabled
kBool GoSetup_UniformSpacingEnabled(GoSetup setup)
Gets the user specified Uniform Spacing enabled state.
GoSetup::GoSetup_IntensityEnabled
kBool GoSetup_IntensityEnabled(GoSetup setup)
Reports whether the profile intensity collection is enabled.
GoSetup::GoSetup_SetZSubsampling
kStatus GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling)
Sets the current z-resolution divider.
GoSetup::GoSetup_XDecimationEnabled
kBool GoSetup_XDecimationEnabled(GoSetup setup)
Gets the status of x-direction decimation.
GoSetup::GoSetup_AlignmentTypeOptionCount
kSize GoSetup_AlignmentTypeOptionCount(GoSetup setup)
Gets the alignment type option count.
GoSetup::GoSetup_EnableTriggerGate
kStatus GoSetup_EnableTriggerGate(GoSetup setup, kBool enable)
Sets the trigger gate feature.
GoSetup::GoSetup_YSmoothingWindow
k64f GoSetup_YSmoothingWindow(GoSetup setup)
Gets the y-direction smoothing window.
GoSetup::GoSetup_SetBackgroundSuppressionRatio
kStatus GoSetup_SetBackgroundSuppressionRatio(GoSetup setup, k64u ratio)
Sets the background suppression ratio value.
GoSetup::GoSetup_BarHoleCount
kSize GoSetup_BarHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration bar.
GoSetup::GoSetup_SetBarHoleDistance
kStatus GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance)
Sets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_SetLayoutGridRow
kStatus GoSetup_SetLayoutGridRow(GoSetup setup, GoRole role, k32s value)
Sets row index being configured (may not be applicable or used) on device in n-buddy system...
GoSetup::GoSetup_TrackingUsed
kBool GoSetup_TrackingUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the Tracking Enabled field is used.
GoSetup::GoSetup_EncoderTriggerMode
GoEncoderTriggerMode GoSetup_EncoderTriggerMode(GoSetup setup)
Gets the encoder trigger mode.
GoProfileGeneration
Represents a profile generation configuration.
GoSetup::GoSetup_TriggerBurstEnabled
kBool GoSetup_TriggerBurstEnabled(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enabled state...
GoSetup::GoSetup_IntensitySourceOptionCount
kSize GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role)
Gets the intensity source option count.
GoSetup::GoSetup_EncoderSpacingLimitMin
k64f GoSetup_EncoderSpacingLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Encoder Period setting.
GoSetup::GoSetup_SetDynamicExposureMax
kStatus GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure)
Sets the maximum value for the Dynamic Exposure setting.
GoSetup::GoSetup_FlickerFreeModeEnabled
kBool GoSetup_FlickerFreeModeEnabled(GoSetup setup)
Reports whether flicker free mode is enabled.
GoSetup::GoSetup_SetExposureMode
kStatus GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode)
Sets the exposure mode.
GoSetup::GoSetup_XSmoothingWindowLimitMin
k64f GoSetup_XSmoothingWindowLimitMin(GoSetup setup)
Gets the x-direction smoothing window minimum.
GoSetup::GoSetup_PatternSequenceIndexMin
k32u GoSetup_PatternSequenceIndexMin(GoSetup setup, GoRole role)
Gets the current phase pattern index min value (inclusive).
GoSetup::GoSetup_SetFrameRate
kStatus GoSetup_SetFrameRate(GoSetup setup, k64f frameRate)
Sets the current frame rate for time-based triggering.
GoSetup::GoSetup_TrackingSearchThreshold
k64f GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role)
Gets the tracking window search threshold.
GoSetup::GoSetup_ZSubsampling
k32u GoSetup_ZSubsampling(GoSetup setup, GoRole role)
Gets the current z-resolution divider.
GoSetup::GoSetup_SetActiveAreaX
kStatus GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value)
Sets the active area x origin.
GoSetup::GoSetup_IndependentExposuresUsed
kBool GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role)
Returns a boolean value representing the state of the independent exposures used field.
GoSetup::GoSetup_ZSubsamplingOptionCount
kSize GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid z-resolution options.
GoSetup::GoSetup_SelectCustomEnhancedSurfaceFlatnessFilter
kStatus GoSetup_SelectCustomEnhancedSurfaceFlatnessFilter(GoSetup setup, GoRole role, GoPreFilterLengthOption length, const GoPreFilterCoefficient *coefficientsArray)
Selects using a custom enhanced surface flatness filter, if device supports enhanced surface flatness...
GoSetup::GoSetup_EnhancedSurfaceFlatnessFilterCoefficientsExpectedSum
k64f GoSetup_EnhancedSurfaceFlatnessFilterCoefficientsExpectedSum(GoSetup setup, GoRole role)
Gets the expected value of the sum of all the enhanced surface flatness filter coefficients.
GoRole
Represents a user role. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx)
GoSetup::GoSetup_AlignmentUsed
kBool GoSetup_AlignmentUsed(GoSetup setup)
Indicates whether alignment can be used.
GoSetup::GoSetup_SetLayoutGridColumn
kStatus GoSetup_SetLayoutGridColumn(GoSetup setup, GoRole role, k32s value)
Sets column index being configured (may not be applicable or used) on device in n-buddy system...
GoSetup::GoSetup_SetSpacingIntervalType
kStatus GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type)
Sets the spacing interval type.
GoSetup::GoSetup_YSlopeEnabled
kBool GoSetup_YSlopeEnabled(GoSetup setup)
Gets the status of y-direction slope.
GoSetup::GoSetup_OcclusionReductionAlg
GoOcclusionReductionAlg GoSetup_OcclusionReductionAlg(GoSetup setup)
Gets the occlusion reduction algorithm.
GoSetup::GoSetup_FrameRateLimitMax
k64f GoSetup_FrameRateLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Frame Rate setting.
GoSetup::GoSetup_SetTriggerExternalInputIndex
kStatus GoSetup_SetTriggerExternalInputIndex(GoSetup setup, k32s index)
Sets the external input index to trigger profile/surface capturing.
GoSetup::GoSetup_ScanModeOptionAt
GoMode GoSetup_ScanModeOptionAt(GoSetup setup, kSize index)
Gets the scan mode option at the specified index.
GoSetup::GoSetup_PatternSequenceCount
kSize GoSetup_PatternSequenceCount(GoSetup setup, GoRole role)
Gets the current pattern sequence count.
GoMaterial
[Deprecated] Use GoAdvanced class instead.
GoAlignmentDegreesOfFreedom
Represents an alignment degree of freedom setting.
GoSetup::GoSetup_SetYGapFillingWindow
kStatus GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window)
Sets the y-direction gap-filling window.
GoSetup::GoSetup_ZSubsamplingDefaultEnabledUsed
kBool GoSetup_ZSubsamplingDefaultEnabledUsed(GoSetup setup, GoRole role)
Returns whether the sensor has a z-resolution divider default value or not.
GoSetup::GoSetup_SetPlateRefHoleDiameter
kStatus GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_BackCameraHeight
k32u GoSetup_BackCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
GoSetup::GoSetup_FrameRate
k64f GoSetup_FrameRate(GoSetup setup)
Reports the currently configured frame rate.
GoSetup::GoSetup_BackCameraUsed
k32u GoSetup_BackCameraUsed(GoSetup setup, GoRole role)
Returns a boolean representing whether the back camera element is used.
GoSetup::GoSetup_LaserIdleTime
k64u GoSetup_LaserIdleTime(GoSetup setup)
This API is experimental and may change in a future release Gets the idle time before laser deactivat...
GoSetup::GoSetup_IsEnhancedSurfaceFlatnessFilterSupported
kBool GoSetup_IsEnhancedSurfaceFlatnessFilterSupported(GoSetup setup, GoRole role)
Returns whether enhanced surface flatness filtering is supported on the device specified by the "role...
GoSetup::GoSetup_EnableUniformSpacing
kStatus GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable)
Sets the user specified Uniform Spacing enabled state.
GoSetup::GoSetup_SetLaserWakeupEncoderTravel
kStatus GoSetup_SetLaserWakeupEncoderTravel(GoSetup setup, k64u distance)
This API is experimental and may change in a future release Sets the encoder wakeup travel distance...
GoSetup::GoSetup_EnhancedSurfaceFlatnessFilterLength
GoPreFilterLengthOption GoSetup_EnhancedSurfaceFlatnessFilterLength(GoSetup setup, GoRole role)
Gets the enhanced surface flatness filter length selected, if device supports enhanced surface flatne...
GoSetup::GoSetup_XSpacingCount
k32u GoSetup_XSpacingCount(GoSetup setup, GoRole role)
Gets the X spacing count.
GoSetup::GoSetup_ActiveAreaZ
k64f GoSetup_ActiveAreaZ(GoSetup setup, GoRole role)
Gets the active area z origin.
GoSetup::GoSetup_BackgroundSuppressionEnabled
kBool GoSetup_BackgroundSuppressionEnabled(GoSetup setup)
Gets the background suppression enabled value.
GoTrigger
Represents a trigger.
GoSetup::GoSetup_ReversalDistanceSystemValue
k64f GoSetup_ReversalDistanceSystemValue(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
GoSetup::GoSetup_IntensityMode
GoIntensityMode GoSetup_IntensityMode(GoSetup setup, GoRole role)
Gets the intensity data generation mode.
GoSetup::GoSetup_EnableBackgroundSuppression
kStatus GoSetup_EnableBackgroundSuppression(GoSetup setup, kBool enabled)
Sets the background suppression enabled value.
GoSetup::GoSetup_YSpacingCount
k32u GoSetup_YSpacingCount(GoSetup setup, GoRole role)
Gets the Y spacing count.
GoSetup::GoSetup_FrontCameraWidth
k32u GoSetup_FrontCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
GoSetup::GoSetup_XSmoothingUsed
kBool GoSetup_XSmoothingUsed(GoSetup setup)
Indicates whether X smoothing can be used for the current scan mode and device family.
GoSetup::GoSetup_SpacingIntervalType
GoSpacingIntervalType GoSetup_SpacingIntervalType(GoSetup setup, GoRole role)
Gets the spacing interval type.
GoSetup::GoSetup_IntensitySourceOptionAt
GoIntensitySource GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the intensity source option at the given index.
GoSetup::GoSetup_PlateSecHoleDiameter
k64f GoSetup_PlateSecHoleDiameter(GoSetup setup)
Gets the diameter of the secondary hole defined on the calibration plate.
GoSetup::GoSetup_FrontCameraX
k32u GoSetup_FrontCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
GoSetup::GoSetup_DiskHeight
k64f GoSetup_DiskHeight(GoSetup setup)
Gets the height of the disk used for travel calibration.
GoSetup::GoSetup_PatternSequenceIndexUsed
kBool GoSetup_PatternSequenceIndexUsed(GoSetup setup, GoRole role)
Gets the current phase pattern index used flag value.
GoSetup::GoSetup_SetTrackingSearchThreshold
kStatus GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold)
Sets the tracking window search threshold.
GoSetup::GoSetup_FrameDataRate
k64f GoSetup_FrameDataRate(GoSetup setup)
Reports the current frame rate of normal (range, profile, or surface) data.
GoSetup::GoSetup_PlateHoleCount
kSize GoSetup_PlateHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration plate.
GoSetup::GoSetup_AlignmentType
GoAlignmentType GoSetup_AlignmentType(GoSetup setup)
Gets the type used for alignment calibration.
GoSetup::GoSetup_EnhancedSurfaceFlatnessFilterEnabled
kBool GoSetup_EnhancedSurfaceFlatnessFilterEnabled(GoSetup setup, GoRole role)
Checks if enhanced surface flatness is enabled, if device supports enhanced surface flatness filterin...
GoSetup::GoSetup_LayoutMultiplexingBank
k32u GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role)
Gets Multiplex bank value being configured (may not be applicable or used) on device in n-buddy syste...
GoSetup::GoSetup_TriggerBurstCount
k32u GoSetup_TriggerBurstCount(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst count...
GoSetup::GoSetup_AlignmentStationaryTargetOptionAt
GoAlignmentTarget GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index)
Gets the stationary alignment target option at the given index.
GoSetup::GoSetup_EnableTracking
kStatus GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable)
Enables tracking.
GoSetup::GoSetup_XSlopeEnabled
kBool GoSetup_XSlopeEnabled(GoSetup setup)
Gets the status of x-direction slope.
GoSetup::GoSetup_OcclusionReductionAlgUsed
kBool GoSetup_OcclusionReductionAlgUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction algorithm is used.
GoSetup::GoSetup_ActiveAreaLengthLimitMax
k64f GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaLength setting.
GoSetup::GoSetup_OcclusionReductionEnabled
kBool GoSetup_OcclusionReductionEnabled(GoSetup setup)
Gets the occlusion reduction enabled state.
GoSetup::GoSetup_Sections
GoSections GoSetup_Sections(GoSetup setup)
Gets the Section configuration module, used for surface sections.
GoSetup::GoSetup_Material
GoMaterial GoSetup_Material(GoSetup setup, GoRole role)
[Deprecated] Use GoSetup_Advanced() instead.
GoSetup::GoSetup_SetZSubsamplingDefaultEnabled
kStatus GoSetup_SetZSubsamplingDefaultEnabled(GoSetup setup, GoRole role, kBool useDefault)
Sets whether to use the sensor's default z-resolution divider or the user-selected divider...
GoSetup::GoSetup_IntensitySource
GoIntensitySource GoSetup_IntensitySource(GoSetup setup, GoRole role)
Gets the source used for generating intensity data.
GoSetup::GoSetup_EnableTemperatureSafety
kStatus GoSetup_EnableTemperatureSafety(GoSetup setup, kBool enable)
Enables the temperature saftey of the sensor system.
GoSetup::GoSetup_SelectBuiltInEnhancedSurfaceFlatnessFilter
kStatus GoSetup_SelectBuiltInEnhancedSurfaceFlatnessFilter(GoSetup setup, GoRole role, GoPreFilterType type, GoPreFilterLengthOption length)
Selects one of the builtin enhanced surface flatness filters to use, if device supports enhanced surf...
GoLayout
Represents a layout related sensor configuration.
GoSetup::GoSetup_EnableXSmoothing
kStatus GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled)
Sets the status of x-direction smoothing.
GoTracheid.h
Declares the GoTransform class.
GoSetup::GoSetup_Tracheid
GoTracheid GoSetup_Tracheid(GoSetup setup, GoRole role)
Gets the tracheid configuration module.
GoSetup::GoSetup_SetBarHeight
kStatus GoSetup_SetBarHeight(GoSetup setup, k64f height)
Sets the height of the bar used for travel calibration.
GoSetup::GoSetup_YMedianWindowLimitMax
k64f GoSetup_YMedianWindowLimitMax(GoSetup setup)
Gets the y-direction median window maximum.
GoSetup::GoSetup_SetActiveAreaY
kStatus GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value)
Sets the active area Y.
GoSetup::GoSetup_ClearPolygonCorners
kStatus GoSetup_ClearPolygonCorners(GoSetup setup)
Clears all corner parameter objects from the collection of polygon corners for alignment.
GoSetup::GoSetup_SetLaserIdleTime
kStatus GoSetup_SetLaserIdleTime(GoSetup setup, k64u time)
This API is experimental and may change in a future release Sets the time before the laser deactivate...
GoSetup::GoSetup_AlignmentMovingTarget
GoAlignmentTarget GoSetup_AlignmentMovingTarget(GoSetup setup)
Gets the target type used for moving alignment calibration.
GoSetup::GoSetup_YGapFillingWindow
k64f GoSetup_YGapFillingWindow(GoSetup setup)
Gets the y-direction gap-filling window.
GoSetup::GoSetup_TracheidRate
k64f GoSetup_TracheidRate(GoSetup setup)
Reports the current frame rate of Tracheid data.
GoSetup::GoSetup_XSmoothingWindow
k64f GoSetup_XSmoothingWindow(GoSetup setup)
Gets the x-direction smoothing window.
GoSetup::GoSetup_PolygonCornerCount
kSize GoSetup_PolygonCornerCount(GoSetup setup)
Gets the number of corner parameters defined in the collection of polygon corners.
GoSetup::GoSetup_SetBackCameraExposure
kStatus GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the back camera exposure value.
GoSetup::GoSetup_SpacingInterval
k64f GoSetup_SpacingInterval(GoSetup setup, GoRole role)
Gets the spacing interval.
GoSetup::GoSetup_XSubsamplingUsed
kBool GoSetup_XSubsamplingUsed(GoSetup setup, GoRole role)
Returns whether the value used for the x-resolution divider is the one set by the user or the system ...
GoSetup::GoSetup_DiskDiameter
k64f GoSetup_DiskDiameter(GoSetup setup)
Gets the diameter of the disk used for travel calibration.
GoSetup::GoSetup_TransformedDataRegionZ
k64f GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role)
Gets the transformed data region Z value.
GoSetup::GoSetup_TransmitLimit
k32u GoSetup_TransmitLimit(GoSetup setup)
Gets the main sensor's transmit limit.
GoSetup::GoSetup_LayoutGridColumn
k32s GoSetup_LayoutGridColumn(GoSetup setup, GoRole role)
Gets column index being configured (may not be applicable or used) on device in n-buddy system...
GoSetup::GoSetup_ActiveAreaXLimitMin
k64f GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaX setting.
GoSetup::GoSetup_SetTriggerBurstEnabled
kStatus GoSetup_SetTriggerBurstEnabled(GoSetup setup, kBool enable)
Enables the trigger burst.
GoSetup::GoSetup_ScanModeOptionCount
kSize GoSetup_ScanModeOptionCount(GoSetup setup)
Gets the scan mode option count.
GoSetup::GoSetup_TriggerGateEnabledSystemValue
kBool GoSetup_TriggerGateEnabledSystemValue(GoSetup setup)
Reports the trigger gate enabled system value.
GoSurfaceGeneration
Represents a surface generation configuration.
GoSetup::GoSetup_FrontCameraExposureLimitMax
k64f GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the front camera exposure setting.
GoSetup::GoSetup_TriggerExternalInputIndexOptionAt
GoAlignmentTarget GoSetup_TriggerExternalInputIndexOptionAt(GoSetup setup, kSize index)
Gets the external input trigger option at the given index.
GoSetup::GoSetup_YSmoothingEnabled
kBool GoSetup_YSmoothingEnabled(GoSetup setup)
Gets the status of y-direction smoothing.
GoSetup::GoSetup_SetBarHoleCount
kStatus GoSetup_SetBarHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration bar.
GoSetup::GoSetup_SetYSlopeWindow
kStatus GoSetup_SetYSlopeWindow(GoSetup setup, k64f window)
Sets the status of y-direction slope.
GoSdkDef.h
Essential SDK declarations.
GoSetup::GoSetup_EnableExternalInputZPulse
kStatus GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable)
Sets the state of the external input triggered encoder Z-pulse feature.
GoSetup::GoSetup_FrontCameraY
k32u GoSetup_FrontCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
GoSetup::GoSetup_SetEncoderSpacing
kStatus GoSetup_SetEncoderSpacing(GoSetup setup, k64f period)
Sets the current encoder period for encoder-based triggering.
GoSetup::GoSetup_SetBarDegreesOfFreedom
kStatus GoSetup_SetBarDegreesOfFreedom(GoSetup setup, GoAlignmentDegreesOfFreedom dof)
Sets the degrees of freedom used for bar alignment calibration.
GoSetup::GoSetup_Advanced
GoAdvanced GoSetup_Advanced(GoSetup setup, GoRole role)
Gets the advanced acquisition module, used for advanced acquisition configuration.
GoSetup::GoSetup_YMedianWindow
k64f GoSetup_YMedianWindow(GoSetup setup)
Gets the y-direction median window.
GoSetup::GoSetup_YDecimationWindow
k64f GoSetup_YDecimationWindow(GoSetup setup)
Gets the y-direction decimation window.
GoSetup::GoSetup_BarHoleDistance
k64f GoSetup_BarHoleDistance(GoSetup setup)
Gets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_YGapFillingWindowLimitMax
k64f GoSetup_YGapFillingWindowLimitMax(GoSetup setup)
Gets the y-direction gap-filling window maximum.
GoSetup::GoSetup_InputTriggerEnabledUsed
kBool GoSetup_InputTriggerEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user input trigger configuration is used.
GoSetup::GoSetup_XDecimationUsed
kBool GoSetup_XDecimationUsed(GoSetup setup)
Indicates whether X decimation can be used for the current scan mode and device family.
GoSetup::GoSetup_BarWidth
k64f GoSetup_BarWidth(GoSetup setup)
Gets the width of the bar used for travel calibration.
GoSetup::GoSetup_InputTriggerEnabled
kBool GoSetup_InputTriggerEnabled(GoSetup setup)
Gets the input trigger enabled state.
GoSetup::GoSetup_IndependentExposuresEnabled
kBool GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role)
Determines if independent exposures feature is enabled.
GoSetup::GoSetup_ReversalDistance
k64f GoSetup_ReversalDistance(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
GoSetup::GoSetup_IntensityModeUsed
kBool GoSetup_IntensityModeUsed(GoSetup setup, GoRole role)
Gets the availability of the intensity mode property.
GoSetup::GoSetup_XMedianWindowLimitMax
k64f GoSetup_XMedianWindowLimitMax(GoSetup setup)
Gets the x-direction median window maximum.
GoSetup::GoSetup_SpacingIntervalLimitMin
k64f GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role)
Gets the spacing interval value limit minimum.
GoSetup::GoSetup_EnableIntensity
kStatus GoSetup_EnableIntensity(GoSetup setup, kBool enable)
Enables profile intensity collection.
GoPartDetection
Represents the part detection parameters of the surface mode configuration.
GoSetup::GoSetup_SetTriggerSource
kStatus GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source)
Sets the trigger source for profile triggering.
GoIntensityMode
Represents all possible intensity generation modes for multiple exposures.
GoSetup::GoSetup_AlignmentMovingTargetOptionCount
kSize GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup)
Gets the moving alignment target option count.
GoSetup::GoSetup_SetScanMode
kStatus GoSetup_SetScanMode(GoSetup setup, GoMode mode)
Sets the scan mode.
GoSetup::GoSetup_YSlopeUsed
kBool GoSetup_YSlopeUsed(GoSetup setup)
Indicates whether Y slope can be used for the current scan mode and device family.
GoSetup::GoSetup_SurfaceGeneration
GoSurfaceGeneration GoSetup_SurfaceGeneration(GoSetup setup)
Gets the surface generation module, used for surface generation configuration.
GoSetup::GoSetup_PartMatching
GoPartMatching GoSetup_PartMatching(GoSetup setup)
Gets the part matching module, used for part matching configuration.
GoSetup::GoSetup_XSmoothingWindowLimitMax
k64f GoSetup_XSmoothingWindowLimitMax(GoSetup setup)
Gets the x-direction smoothing window maximum.
GoSetup::GoSetup_SetAlignmentStationaryTarget
kStatus GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target)
Sets the target type used for stationary alignment calibration.
GoSetup::GoSetup_SetTrackingAreaHeight
kStatus GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height)
Sets the tracking window height.
GoSetup::GoSetup_AlignmentStationaryTargetOptionCount
kSize GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup)
Gets the stationary alignment target option count.
GoSetup::GoSetup_YMedianEnabled
kBool GoSetup_YMedianEnabled(GoSetup setup)
Gets the status of y-direction median.
GoSetup::GoSetup_XSlopeWindowLimitMax
k64f GoSetup_XSlopeWindowLimitMax(GoSetup setup)
Gets the x-direction slope window maximum.
GoSetup::GoSetup_BarHeight
k64f GoSetup_BarHeight(GoSetup setup)
Gets the height of the bar used for travel calibration.
GoSetup::GoSetup_BackCameraY
k32u GoSetup_BackCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
GoSetup::GoSetup_TriggerGateEnabledUsed
kBool GoSetup_TriggerGateEnabledUsed(GoSetup setup)
Gets the system value representing whether or not the user specified trigger gate enabled setting is ...
GoSetup::GoSetup_EnableYSmoothing
kStatus GoSetup_EnableYSmoothing(GoSetup setup, kBool enable)
Sets the status of y-direction smoothing.
GoSetup::GoSetup_ActiveAreaLengthLimitMin
k64f GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaLength setting.
GoSetup::GoSetup_LaserSleepModeEnabled
kBool GoSetup_LaserSleepModeEnabled(GoSetup setup)
This API is experimental and may change in a future release Gets the laser sleep mode enabled state...
GoSetup::GoSetup_SpacingIntervalSystemValue
k64f GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role)
Gets the spacing interval system value.
GoSetup::GoSetup_SetPatternSequenceIndex
kStatus GoSetup_SetPatternSequenceIndex(GoSetup setup, GoRole role, k32u index)
Sets the current phase pattern index.
GoSetup::GoSetup_AlignmentStationaryTarget
GoAlignmentTarget GoSetup_AlignmentStationaryTarget(GoSetup setup)
Gets the target type used for stationary alignment calibration.
GoSetup::GoSetup_PatternSequenceTypeOptionAt
GoPatternSequenceType GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the pattern sequence type option at the given index.
GoSetup::GoSetup_FrameRateLimitMin
k64f GoSetup_FrameRateLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Frame Rate setting.
GoSetup::GoSetup_EnableXDecimation
kStatus GoSetup_EnableXDecimation(GoSetup setup, kBool enabled)
Sets the status of x-direction decimation.
GoSetup::GoSetup_ReversalDistanceAutoEnabledUsed
kBool GoSetup_ReversalDistanceAutoEnabledUsed(GoSetup setup)
This API is experimental and may change in a future release Returns whether or not auto encoder rever...
GoSetup::GoSetup_LaserSleepUsed
kBool GoSetup_LaserSleepUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the laser sleep mode used value...
GoSetup::GoSetup_TransformedDataRegionWidth
k64f GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role)
Gets the transformed data region width value.
GoSetup::GoSetup_SetExposure
kStatus GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the exposure value.
GoSetup::GoSetup_BarHoleCountUsed
kBool GoSetup_BarHoleCountUsed(GoSetup setup)
Indicates if the hole count can be modified by the user.
GoSetup::GoSetup_TriggerExternalInputIndex
k32s GoSetup_TriggerExternalInputIndex(GoSetup setup)
Gets the external input index to trigger profile/surface capturing.
GoSetup::GoSetup_TriggerBurstCountUsed
kBool GoSetup_TriggerBurstCountUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst used value...
GoSetup::GoSetup_YDecimationEnabled
kBool GoSetup_YDecimationEnabled(GoSetup setup)
Gets the status of y-direction decimation.
GoSetup::GoSetup_EnableFlickerFreeMode
kStatus GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable)
Enables flicker reduction mode.
GoSetup::GoSetup_YSlopeWindowLimitMin
k64f GoSetup_YSlopeWindowLimitMin(GoSetup setup)
Gets the y-direction slope window minimum.
GoSetup::GoSetup_TrackingAreaHeightLimitMin
k64f GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the tracking window height minimum limit.
GoSetup::GoSetup_ExternalInputZPulseEnabled
kBool GoSetup_ExternalInputZPulseEnabled(GoSetup setup)
Gets the state of the external input triggered encoder Z-pulse feature.
GoSetup::GoSetup_EnableEnhancedSurfaceFlatnessFilter
kStatus GoSetup_EnableEnhancedSurfaceFlatnessFilter(GoSetup setup, GoRole role, kBool enable)
Enables/disables use of enhanced surface flatness filtering if the device supports enhanced surface f...
GoSetup::GoSetup_BarHoleDiameterUsed
kBool GoSetup_BarHoleDiameterUsed(GoSetup setup)
Indicates if the hole diameter can be modified by the user.
GoSetup::GoSetup_Layout
GoLayout GoSetup_Layout(GoSetup setup)
Gets the layout configuration module.
GoSetup::GoSetup_IntensityStepIndex
kSize GoSetup_IntensityStepIndex(GoSetup setup, GoRole role)
Gets the intensity step index.
GoSetup::GoSetup_YDecimationWindowLimitMax
k64f GoSetup_YDecimationWindowLimitMax(GoSetup setup)
Gets the y-direction decimation window maximum.
GoTriggerUnits
Represents the system's primary synchronization domain.
GoSetup::GoSetup_SpacingIntervalTypeUsed
kBool GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role)
Gets the system value representing whether or not the user specified spacing interval type setting is...
GoSetup::GoSetup_ExposureStepAt
k64f GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index)
Get the exposure step value specified by index.
GoEncoderTriggerMode
Represents an encoder's triggering behavior.
GoSetup::GoSetup_TriggerDelayLimitMin
k64f GoSetup_TriggerDelayLimitMin(GoSetup setup)
Reports the minimum trigger delay, based on current settings.
GoPolygonCornerParameters
Corner parameters for polygon corner alignment.
Definition: GoSdkDef.h:645
GoSetup::GoSetup_BackCameraExposureLimitMax
k64f GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the back camera exposure setting.
GoSetup::GoSetup_SetReversalDistance
kStatus GoSetup_SetReversalDistance(GoSetup setup, k64f threshold)
This API is experimental and may change in a future release Sets the encoder reversal distance thresh...
GoSetup::GoSetup_SetActiveAreaZ
kStatus GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value)
Sets the active area z origin.
GoSetup::GoSetup_SetTriggerBurstCount
kStatus GoSetup_SetTriggerBurstCount(GoSetup setup, k32u count)
This API is experimental and may change in a future release Sets the trigger burst count...
GoAlignmentTarget
Represents an alignment target type.
GoSetup::GoSetup_FrontCameraExposure
k64f GoSetup_FrontCameraExposure(GoSetup setup, GoRole role)
Gets the front camera exposure value.
GoSetup::GoSetup_BarDegreesOfFreedom
GoAlignmentDegreesOfFreedom GoSetup_BarDegreesOfFreedom(GoSetup setup)
Gets the degrees of freedom used for bar alignment calibration.
GoSetup::GoSetup_LayoutMultiplexingBankUsed
kBool GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role)
Gets Multiplexing bank used state in n-buddy system.
GoExposureMode
Represents all possible exposure modes.
GoSetup::GoSetup_TriggerSource
GoTrigger GoSetup_TriggerSource(GoSetup setup)
Gets the trigger source for profile triggering.
GoSetup::GoSetup_YSmoothingWindowLimitMax
k64f GoSetup_YSmoothingWindowLimitMax(GoSetup setup)
Gets the y-direction smoothing window maximum.
GoSetup::GoSetup_SetPatternSequenceType
kStatus GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type)
Sets the pattern sequence type.
GoSetup::GoSetup_ClearExposureSteps
kStatus GoSetup_ClearExposureSteps(GoSetup setup, GoRole role)
Removes all exposure steps.
GoSetup::GoSetup_SetTriggerDelay
kStatus GoSetup_SetTriggerDelay(GoSetup setup, k64f delay)
Sets the trigger delay.
GoSurfaceGeneration.h
Declares the GoSurfaceGeneration class.
GoProfileGeneration.h
Declares the GoProfileGeneration class.
GoPatternSequenceType
Represents a pattern sequence type.
GoSetup::GoSetup_XMedianWindowLimitMin
k64f GoSetup_XMedianWindowLimitMin(GoSetup setup)
Gets the x-direction median window minimum.
GoSetup::GoSetup_PlateHeight
k64f GoSetup_PlateHeight(GoSetup setup)
Gets the height of the plate used for travel calibration.
GoSetup::GoSetup_XGapFillingWindowLimitMin
k64f GoSetup_XGapFillingWindowLimitMin(GoSetup setup)
Gets the x-direction gap-filling window minimum.
GoSetup::GoSetup_ExposureLimitMin
k64f GoSetup_ExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the Exposure setting.
GoSetup::GoSetup_EnhancedSurfaceFlatnessFilterType
GoPreFilterType GoSetup_EnhancedSurfaceFlatnessFilterType(GoSetup setup, GoRole role)
Gets the enhanced surface flatness filter type, if device supports enhanced surface flatness filterin...
GoSetup::GoSetup_SetLayoutMultiplexingBank
kStatus GoSetup_SetLayoutMultiplexingBank(GoSetup setup, GoRole role, k32u value)
Sets multiplexing bank value being configured (may not be applicable or used) on device in n-buddy sy...
GoSetup::GoSetup_SetSpacingInterval
kStatus GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value)
Sets the spacing interval.
GoSetup::GoSetup_SetXMedianWindow
kStatus GoSetup_SetXMedianWindow(GoSetup setup, k64f window)
Sets the x-direction median window.
GoSetup::GoSetup_YSlopeWindowLimitMax
k64f GoSetup_YSlopeWindowLimitMax(GoSetup setup)
Gets the y-direction slope window maximum.
GoSetup::GoSetup_SetPlateHeight
kStatus GoSetup_SetPlateHeight(GoSetup setup, k64f height)
Sets the height of the plate used for travel calibration.
GoSetup::GoSetup_SetLaserSleepModeEnabled
kStatus GoSetup_SetLaserSleepModeEnabled(GoSetup setup, kBool enable)
This API is experimental and may change in a future release Enables laser sleep mode.
GoSetup::GoSetup_TriggerDelayLimitMax
k64f GoSetup_TriggerDelayLimitMax(GoSetup setup)
Reports the maximum trigger delay, based on current settings.
GoSetup::GoSetup_XSmoothingEnabled
kBool GoSetup_XSmoothingEnabled(GoSetup setup)
Gets the status of x-direction smoothing.
GoSetup::GoSetup_PatternSequenceTypeUsed
kBool GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the pattern sequence type is used.
GoSetup::GoSetup_ExposureModeOptionAt
GoExposureMode GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the exposure mode option at the given index.
GoSetup::GoSetup_SetBarWidth
kStatus GoSetup_SetBarWidth(GoSetup setup, k64f width)
Sets the width of the bar used for travel calibration.
GoSetup::GoSetup_SetOcclusionReductionAlg
kStatus GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg)
Sets the occlusion reduction algorithm.
GoSetup::GoSetup_BackCameraWidth
k32u GoSetup_BackCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
GoSetup::GoSetup_PlateRefHoleDiameter
k64f GoSetup_PlateRefHoleDiameter(GoSetup setup)
Gets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_DynamicExposureMax
k64f GoSetup_DynamicExposureMax(GoSetup setup, GoRole role)
Gets the maximum value for the Dynamic Exposure setting.
GoSpacingIntervalType
Represents spacing interval types.
GoSetup::GoSetup_ExposureStepCount
kSize GoSetup_ExposureStepCount(GoSetup setup, GoRole role)
Get the number of exposure steps defined.
GoSetup::GoSetup_EnableInputTrigger
kStatus GoSetup_EnableInputTrigger(GoSetup setup, kBool enable)
Sets the input trigger enabled state.
GoSetup::GoSetup_LayoutMultiplexingBankSystemValue
k32u GoSetup_LayoutMultiplexingBankSystemValue(GoSetup setup, GoRole role)
Gets Multiplex bank system value being used on device in n-buddy system.
GoSetup::GoSetup_ReversalDistanceUsed
kBool GoSetup_ReversalDistanceUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
GoSetup::GoSetup_DynamicExposureMin
k64f GoSetup_DynamicExposureMin(GoSetup setup, GoRole role)
Gets the minimum value for the Dynamic Exposure setting.
GoAlignmentType
Represents an alignment type.
GoSetup::GoSetup_MaxFrameRateEnabled
kBool GoSetup_MaxFrameRateEnabled(GoSetup setup)
Reports whether or not system is configured to operate at full frame rate.
GoSetup::GoSetup_PatternSequenceType
GoPatternSequenceType GoSetup_PatternSequenceType(GoSetup setup, GoRole role)
Gets the pattern sequence type.
kDeprecate
#define kDeprecate(SYMBOL)
GoSetup::GoSetup_EnableYGapFilling
kStatus GoSetup_EnableYGapFilling(GoSetup setup, kBool enable)
Sets the status of y-direction gap-filling.
GoSetup::GoSetup_BarDegreesOfFreedomOptionAt
GoAlignmentDegreesOfFreedom GoSetup_BarDegreesOfFreedomOptionAt(GoSetup setup, kSize index)
Gets the bar alignment degrees of freedom option at the given index.
GoSetup::GoSetup_LayoutGridDirection
kBool GoSetup_LayoutGridDirection(GoSetup setup, GoRole role)
Gets layout grid direction being configured (may not be applicable or used) on device in n-buddy syst...
GoSetup::GoSetup_EncoderSpacing
k64f GoSetup_EncoderSpacing(GoSetup setup)
Gets the current encoder period for encoder-based triggering.
GoSetup::GoSetup_YDecimationUsed
kBool GoSetup_YDecimationUsed(GoSetup setup)
Indicates whether y decimation can be used for the current scan mode and device family.
GoSetup::GoSetup_YSlopeWindow
k64f GoSetup_YSlopeWindow(GoSetup setup)
Gets the y-direction slope window.
GoSetup::GoSetup_SetExternalInputZPulseIndex
kStatus GoSetup_SetExternalInputZPulseIndex(GoSetup setup, k32u index)
Sets the external input index for triggering encoder Z-pulse.
GoSetup::GoSetup_SetIntensitySource
kStatus GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source)
Sets the source to be used for generating intensity data.
GoSetup::GoSetup_ExposureModeOptionCount
kSize GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role)
Gets the exposure mode option count.
GoSetup::GoSetup_ActiveAreaHeight
k64f GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role)
Gets the active area height.
GoSetup::GoSetup_XSubsamplingDefaultEnabled
kBool GoSetup_XSubsamplingDefaultEnabled(GoSetup setup, GoRole role)
Returns whether the x-resolution divider default is being used.
GoSetup::GoSetup_EnableOcclusionReduction
kStatus GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable)
Sets the occlusion reduction enabled state.
GoSetup::GoSetup_TransformedDataRegionY
k64f GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role)
Gets the transformed data region Y value.
GoOcclusionReductionAlg
Represents an occlusion reduction algorithm.
GoSetup::GoSetup_ExposureMode
GoExposureMode GoSetup_ExposureMode(GoSetup setup, GoRole role)
Gets the exposure mode.
GoSetup::GoSetup_SetYSmoothingWindow
kStatus GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window)
Sets the y-direction smoothing window.
GoPartMatching
Represents the part matching parameters of the surface mode configuration.
GoSetup::GoSetup_SetLayoutGridDirection
kStatus GoSetup_SetLayoutGridDirection(GoSetup setup, GoRole role, kBool value)
Sets grid direction being configured (may not be applicable or used) on device in n-buddy system...
GoSetup::GoSetup_TransformedDataRegionHeight
k64f GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role)
Gets the transformed data region height value.
GoSetup::GoSetup_TriggerBurstEnabledUsed
kBool GoSetup_TriggerBurstEnabledUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enabled state...
GoSetup::GoSetup_LayoutGridDirectionSystemValue
kBool GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role)
Gets layout grid direction system value being used on device in n-buddy system.
GoMode
Represents a scan mode.
GoSetup::GoSetup_EnableXMedian
kStatus GoSetup_EnableXMedian(GoSetup setup, kBool enabled)
Sets the status of x-direction median.
GoSetup::GoSetup_XSlopeWindowLimitMin
k64f GoSetup_XSlopeWindowLimitMin(GoSetup setup)
Gets the x-direction slope window minimum.
GoSetup::GoSetup_LaserWakeupEncoderTravel
k64u GoSetup_LaserWakeupEncoderTravel(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder wakeup travel distance...
GoSetup::GoSetup_FrontCameraExposureLimitMin
k64f GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the front camara exposure setting.
GoSetup::GoSetup_XSubsamplingOptionAt
k32u GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the x-resolution option at the specified index.
GoSetup::GoSetup_SetIntensityStepIndex
kStatus GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index)
Sets the intensity step index.
GoSetup::GoSetup_ActiveAreaZLimitMax
k64f GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaZ setting.
GoSetup::GoSetup_SpacingIntervalLimitMax
k64f GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role)
Gets the spacing interval value limit maximum.
GoSetup::GoSetup_ActiveAreaWidthLimitMin
k64f GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaWidth setting.
GoSetup::GoSetup_AddPolygonCorner
kStatus GoSetup_AddPolygonCorner(GoSetup setup, GoPolygonCornerParameters *corner)
Adds a corner parameters object to the collection of polygon corners for alignment.
GoSetup::GoSetup_ActiveAreaYLimitMax
k64f GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_SetTransmitLimit
kStatus GoSetup_SetTransmitLimit(GoSetup setup, k32u limit)
Sets the main sensor's transmit limit.
GoSetup::GoSetup_EnableXGapFilling
kStatus GoSetup_EnableXGapFilling(GoSetup setup, kBool enable)
Sets the status of x-direction gap-filling.
GoSetup::GoSetup_EnhancedSurfaceFlatnessFilterCoefficientMinValue
k64f GoSetup_EnhancedSurfaceFlatnessFilterCoefficientMinValue(GoSetup setup, GoRole role)
Gets the smallest allowable enhanced surface flatness filter coefficient.
GoSetup::GoSetup_YGapFillingUsed
kBool GoSetup_YGapFillingUsed(GoSetup setup)
Indicates whether Y gap filling can be used for the current scan mode and device family.
GoSetup::GoSetup_SetDynamicExposureMin
kStatus GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure)
Sets the minimum value for the Dynamic Exposure setting.
GoSetup::GoSetup_SetActiveAreaHeight
kStatus GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value)
Sets the active area height.
GoSetup::GoSetup_EnableYSlope
kStatus GoSetup_EnableYSlope(GoSetup setup, kBool enable)
Sets the status of y-direction slope.
GoSetup::GoSetup_ProfileGeneration
GoProfileGeneration GoSetup_ProfileGeneration(GoSetup setup)
Gets the profile generation module, used for profile generation configuration.
GoSetup::GoSetup_TriggerSourceOptionAt
GoAlignmentTarget GoSetup_TriggerSourceOptionAt(GoSetup setup, kSize index)
Gets the trigger source option at the given index.
GoSetup::GoSetup_XSlopeWindow
k64f GoSetup_XSlopeWindow(GoSetup setup)
Gets the x-direction slope window.
GoSetup::GoSetup_XSubsamplingDefaultEnabledUsed
kBool GoSetup_XSubsamplingDefaultEnabledUsed(GoSetup setup, GoRole role)
Returns whether the sensor has a x-resolution divider default value or not.
GoSetup::GoSetup_SetFrontCameraExposure
kStatus GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the front camera exposure value.
GoSetup::GoSetup_EnhancedSurfaceFlatnessFilterCoefficients
const GoPreFilterCoefficient * GoSetup_EnhancedSurfaceFlatnessFilterCoefficients(GoSetup setup, GoRole role)
Gets all the enhanced surface flatness filter coefficients currently in use, if device supports enhan...
GoSetup::GoSetup_SetEncoderTriggerMode
kStatus GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode)
Sets the encoder trigger mode.
GoSetup::GoSetup_SpacingIntervalUsed
kBool GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role)
Returns the state of whether the user specified spacing interval is used.
GoSetup::GoSetup_OcclusionReductionEnabledSystemValue
kBool GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup)
Gets the occlusion reduction system value.
GoSetup::GoSetup_EnableXSlope
kStatus GoSetup_EnableXSlope(GoSetup setup, kBool enable)
Sets the status of x-direction slope.
GoSetup::GoSetup_ExternalInputZPulseIndexAvailable
kBool GoSetup_ExternalInputZPulseIndexAvailable(GoSetup setup)
Reports whether or not the external input index for encoder z-pulse triggering is used...
GoSetup::GoSetup_XDecimationWindow
k64f GoSetup_XDecimationWindow(GoSetup setup)
Gets the x-direction decimation window.
GoSetup::GoSetup_PatternSequenceIndexMax
k32u GoSetup_PatternSequenceIndexMax(GoSetup setup, GoRole role)
Gets the current phase pattern index maximum value (inclusive).
GoSetup::GoSetup_SetXGapFillingWindow
kStatus GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window)
Sets the status of x-direction gap-filling.
GoSetup::GoSetup_ScanMode
GoMode GoSetup_ScanMode(GoSetup setup)
Gets the scan mode.
GoSetup::GoSetup_LayoutGridUsed
kBool GoSetup_LayoutGridUsed(GoSetup setup, GoRole role)
Gets layout grid used state.
GoSetup::GoSetup_XDecimationWindowLimitMax
k64f GoSetup_XDecimationWindowLimitMax(GoSetup setup)
Gets the x-direction decimation window maximum.
GoSetup::GoSetup_FlickerFreeModeAvailable
kBool GoSetup_FlickerFreeModeAvailable(GoSetup setup)
Reports whether flicker free mode is available for use on this sensor.
GoSetup::GoSetup_ExposureLimitMax
k64f GoSetup_ExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the Exposure setting.
GoSetup::GoSetup_XMedianEnabled
kBool GoSetup_XMedianEnabled(GoSetup setup)
Gets the status of x-direction median.
GoSetup::GoSetup_SetBarHoleDiameter
kStatus GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of holes that are defined on the calibration bar.
GoSetup::GoSetup_TrackingAreaHeightLimitMax
k64f GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the tracking window height maximum limit.
GoSetup::GoSetup_FrontCameraHeight
k32u GoSetup_FrontCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
GoSetup::GoSetup_SetDiskHeight
kStatus GoSetup_SetDiskHeight(GoSetup setup, k64f height)
Sets the height of the disk used for travel calibration.
GoSetup::GoSetup_SetXSmoothingWindow
kStatus GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window)
Sets the x-direction smoothing window.
GoSetup::GoSetup_XSubsampling
k32u GoSetup_XSubsampling(GoSetup setup, GoRole role)
Gets the current x-resolution divider.
GoSetup::GoSetup_EnableIndependentExposures
kStatus GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable)
Enables independent exposures feature, i.e.
GoSetup::GoSetup_SetTriggerUnit
kStatus GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit)
Sets the system trigger units.
GoSetup::GoSetup_YGapFillingWindowLimitMin
k64f GoSetup_YGapFillingWindowLimitMin(GoSetup setup)
Gets the y-direction gap-filling window minimum.
GoSetup::GoSetup_PreferMasterTimeEncoderEnabled
kBool GoSetup_PreferMasterTimeEncoderEnabled(GoSetup setup)
Gets whether the time and encoder values are preferred to come from the Master rather than from the s...
GoSetup::GoSetup_ZSubsamplingSystemValue
k32u GoSetup_ZSubsamplingSystemValue(GoSetup setup, GoRole role)
Gets the z-resolution divider system value.
GoSetup::GoSetup_YDecimationWindowLimitMin
k64f GoSetup_YDecimationWindowLimitMin(GoSetup setup)
Gets the y-direction decimation window minimum.
GoSetup::GoSetup_BarHoleDiameter
k64f GoSetup_BarHoleDiameter(GoSetup setup)
Gets the diameter of holes that are defined on the calibration bar.
GoSetup
Represents a device configuration.
GoSetup::GoSetup_PolygonCornerAt
GoPolygonCornerParameters * GoSetup_PolygonCornerAt(GoSetup setup, kSize index)
Retrieves the reference to the corner parameters object from the collection of polygon corners...
GoPartMatching.h
Declares the GoPartMatching class.
GoSetup::GoSetup_BackCameraExposureLimitMin
k64f GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the back camara exposure setting.
GoSetup::GoSetup_SetDiskDiameter
kStatus GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the disk used for travel calibration.
GoSetup::GoSetup_SetYMedianWindow
kStatus GoSetup_SetYMedianWindow(GoSetup setup, k64f window)
Sets the y-direction median window.
GoSetup::GoSetup_XMedianUsed
kBool GoSetup_XMedianUsed(GoSetup setup)
Indicates whether X median can be used for the current scan mode and device family.
GoSetup::GoSetup_EnableYDecimation
kStatus GoSetup_EnableYDecimation(GoSetup setup, kBool enable)
Sets the status of y-direction decimation.
GoMaterial.h
Declares the GoMaterial class.
GoSetup::GoSetup_AlignmentTypeOptionAt
GoAlignmentType GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index)
Gets the alignment type option at the given index.
GoSetup::GoSetup_SetIntensityMode
kStatus GoSetup_SetIntensityMode(GoSetup setup, GoRole role, GoIntensityMode mode)
Sets the intensity data generation mode.
GoSetup::GoSetup_BarHoleDistanceUsed
kBool GoSetup_BarHoleDistanceUsed(GoSetup setup)
Indicates if the hole distance can be modified by the user.
GoSetup::GoSetup_TrackingEnabled
kBool GoSetup_TrackingEnabled(GoSetup setup, GoRole role)
Determines if tracking is enabled.
GoSetup::GoSetup_AlignmentEncoderCalibrateEnabled
kBool GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup)
Gets the value of the post alignment encoder calibration setting.
GoSetup::GoSetup_YSmoothingWindowLimitMin
k64f GoSetup_YSmoothingWindowLimitMin(GoSetup setup)
Gets the y-direction smoothing window minimum.
GoSections
Represents the collection of sections and limits for defining them.
GoSetup::GoSetup_SetXSubsampling
kStatus GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling)
Sets the current x-resolution divider.
GoLayout.h
Declares the GoLayout class.
GoSetup::GoSetup_SetYDecimationWindow
kStatus GoSetup_SetYDecimationWindow(GoSetup setup, k64f window)
Sets the y-direction decimation window.
GoPreFilterLengthOption
Represents the choices of the filter length (ie. how many prefilter coefficients to use for the prefi...
GoAdvanced.h
Declares the GoAdvanced class.
GoSetup::GoSetup_ActiveAreaLength
k64f GoSetup_ActiveAreaLength(GoSetup setup, GoRole role)
Gets the active area Length.
GoSetup::GoSetup_XDecimationWindowLimitMin
k64f GoSetup_XDecimationWindowLimitMin(GoSetup setup)
Gets the x-direction decimation window minimum.
GoSetup::GoSetup_SetXSlopeWindow
kStatus GoSetup_SetXSlopeWindow(GoSetup setup, k64f window)
Sets the status of x-direction slope.
GoSetup::GoSetup_PatternSequenceIndex
k32u GoSetup_PatternSequenceIndex(GoSetup setup, GoRole role)
Gets the current phase pattern index.
GoSetup::GoSetup_SetPlateSecHoleDiameter
kStatus GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the secondary hole defined on the calibration plate.
GoSetup::GoSetup_EncoderSpacingLimitMax
k64f GoSetup_EncoderSpacingLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Encoder Period setting.
GoSetup::GoSetup_BarDegreesOfFreedomOptionCount
kSize GoSetup_BarDegreesOfFreedomOptionCount(GoSetup setup)
Gets the degrees of freedom bar alignment target option count.
GoSetup::GoSetup_PartDetection
GoPartDetection GoSetup_PartDetection(GoSetup setup)
Gets the part detection module, used for part detection configuration.
GoSetup::GoSetup_ActiveAreaX
k64f GoSetup_ActiveAreaX(GoSetup setup, GoRole role)
Gets the active area x origin.