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-2026 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  * @param setup GoSetup object.
561  * @param limit New transmit limit to use.
562  * @return Operation status.
563  */
564 GoFx(kStatus) GoSetup_SetTransmitLimit(GoSetup setup, k32u limit);
565 
566 /**
567  * Gets the main sensor's transmit limit.
568  * @public @memberof GoSetup
569  * @param setup GoSetup object.
570  * @return Transmit limit.
571  */
572 GoFx(k32u) GoSetup_TransmitLimit(GoSetup setup);
573 
574 /**
575  * Gets the occlusion reduction enabled state.
576  *
577  * @public @memberof GoSetup
578  * @version Introduced in firmware 4.0.10.27
579  * @param setup GoSetup object.
580  * @return kTRUE if enabled and kFALSE otherwise.
581  */
582 GoFx(kBool) GoSetup_OcclusionReductionEnabled(GoSetup setup);
583 
584 /**
585  * Sets the occlusion reduction enabled state.
586  *
587  * @public @memberof GoSetup
588  * @version Introduced in firmware 4.0.10.27
589  * @param setup GoSetup object.
590  * @param enable kTRUE to enable it and kFALSE to disable it.
591  * @return Operation status.
592  */
593 GoFx(kStatus) GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable);
594 
595 /**
596  * Returns a boolean representing whether the user occlusion reduction configuration is used.
597  *
598  * @public @memberof GoSetup
599  * @version Introduced in firmware 4.3.3.124
600  * @param setup GoSetup object.
601  * @return kTRUE if used, or kFALSE if not used.
602  */
603 GoFx(kBool) GoSetup_OcclusionReductionEnabledUsed(GoSetup setup);
604 
605 /**
606  * Gets the occlusion reduction system value.
607  *
608  * @public @memberof GoSetup
609  * @version Introduced in firmware 4.3.3.124
610  * @param setup GoSetup object.
611  * @return kTRUE if enabled, or kFALSE if not.
612  */
613 GoFx(kBool) GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup);
614 
615 /**
616  * Gets the occlusion reduction algorithm.
617  *
618  * @public @memberof GoSetup
619  * @version Introduced in firmware 4.5.3.57
620  * @param setup GoSetup object.
621  * @return The occlusion reduction algorithm.
622  */
623 GoFx(GoOcclusionReductionAlg) GoSetup_OcclusionReductionAlg(GoSetup setup);
624 
625 /**
626  * Sets the occlusion reduction algorithm.
627  *
628  * @public @memberof GoSetup
629  * @version Introduced in firmware 4.5.3.57
630  * @param setup GoSetup object.
631  * @param alg The algorithm to use for occlusion reduction.
632  * @return Operation status.
633  */
634 GoFx(kStatus) GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg);
635 
636 /**
637  * Returns a boolean representing whether the user occlusion reduction algorithm is used.
638  *
639  * @public @memberof GoSetup
640  * @version Introduced in firmware 4.5.3.57
641  * @param setup GoSetup object.
642  * @return kTRUE if used, or kFALSE if not used.
643  */
644 GoFx(kBool) GoSetup_OcclusionReductionAlgUsed(GoSetup setup);
645 
646 //class - trigger
647 
648 /**
649  * Sets the system trigger units.
650  * Ignored if GoSetup_TriggerSource is time or encoder
651  *
652  * @public @memberof GoSetup
653  * @version Introduced in firmware 4.0.10.27
654  * @param setup GoSetup object.
655  * @param unit The system trigger unit.
656  * @return Operation status.
657  */
658 GoFx(kStatus) GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit);
659 
660 /**
661  * Gets the system trigger units.
662  * Ignored if GoSetup_TriggerSource is time or encoder
663  *
664  * @public @memberof GoSetup
665  * @version Introduced in firmware 4.0.10.27
666  * @param setup GoSetup object.
667  * @return The system domain.
668  */
669 GoFx(GoTriggerUnits) GoSetup_TriggerUnit(GoSetup setup);
670 
671 /**
672  * Sets the trigger source for profile triggering.
673  *
674  * @public @memberof GoSetup
675  * @version Introduced in firmware 4.0.10.27
676  * @param setup GoSetup object.
677  * @param source Profile trigger source.
678  * @return Operation status.
679  */
680 GoFx(kStatus) GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source);
681 
682 /**
683  * Gets the trigger source for profile triggering.
684  *
685  * @public @memberof GoSetup
686  * @version Introduced in firmware 4.0.10.27
687  * @param setup GoSetup object.
688  * @return Profile trigger source.
689  */
690 GoFx(GoTrigger) GoSetup_TriggerSource(GoSetup setup);
691 
692 /**
693  * Gets the count of available trigger source options.
694  *
695  * @public @memberof GoSetup
696  * @version Introduced in firmware 5.1.3.14
697  * @param setup GoSetup object.
698  * @return Count of trigger source options.
699  */
700 GoFx(kSize) GoSetup_TriggerSourceOptionCount(GoSetup setup);
701 
702 /**
703  * Gets the trigger source option at the given index.
704  *
705  * @public @memberof GoSetup
706  * @version Introduced in firmware 5.1.3.14
707  * @param setup GoSetup object.
708  * @param index The index with which to retrieve the trigger source option.
709  * @return The trigger source option.
710  * @see GoSetup_TriggerSourceOptionCount
711  */
712 GoFx(GoAlignmentTarget) GoSetup_TriggerSourceOptionAt(GoSetup setup, kSize index);
713 
714 /**
715  * Gets the flag indicating whether the external input trigger is being used.
716  *
717  * @public @memberof GoSetup
718  * @version Introduced in firmware 5.1.3.14
719  * @param setup GoSetup object.
720  * @return TRUE if being used, FALSE otherwise.
721  */
722 GoFx(kBool) GoSetup_TriggerExternalInputIndexUsed(GoSetup setup);
723 
724 /**
725  * Sets the external input index to trigger profile/surface capturing.
726  *
727  * @public @memberof GoSetup
728  * @version Introduced in firmware 5.1.3.14
729  * @param setup GoSetup object.
730  * @param index External digital input index.
731  * @return Operation status.
732  */
733 GoFx(kStatus) GoSetup_SetTriggerExternalInputIndex(GoSetup setup, k32s index);
734 
735 /**
736  * Gets the external input index to trigger profile/surface capturing.
737  *
738  * @public @memberof GoSetup
739  * @version Introduced in firmware 5.1.3.14
740  * @param setup GoSetup object.
741  * @return External input index to trigger capturing.
742  */
743 GoFx(k32s) GoSetup_TriggerExternalInputIndex(GoSetup setup);
744 
745 /**
746  * Gets the count of available external input trigger index options.
747  *
748  * @public @memberof GoSetup
749  * @version Introduced in firmware 5.1.3.14
750  * @param setup GoSetup object.
751  * @return Count of external input index options.
752  */
753 GoFx(kSize) GoSetup_TriggerExternalInputIndexOptionCount(GoSetup setup);
754 
755 /**
756  * Gets the external input trigger option at the given index.
757  *
758  * @public @memberof GoSetup
759  * @version Introduced in firmware 5.1.3.14
760  * @param setup GoSetup object.
761  * @param index The index with which to retrieve the external input index option.
762  * @return The external input index option.
763  * @see GoSetup_TriggerExternalInputIndexOptionCount
764  */
765 GoFx(GoAlignmentTarget) GoSetup_TriggerExternalInputIndexOptionAt(GoSetup setup, kSize index);
766 
767 /**
768  * Sets the trigger delay. Depending on GoDomain, units are uS or mm.
769  *
770  * @public @memberof GoSetup
771  * @version Introduced in firmware 4.0.10.27
772  * @param setup GoSetup object.
773  * @param delay Trigger delay (uS or mm).
774  * @return Operation status.
775  */
776 GoFx(kStatus) GoSetup_SetTriggerDelay(GoSetup setup, k64f delay);
777 
778 /**
779  * Gets the trigger delay. Depending on GoDomain, units are uS or mm.
780  *
781  * @public @memberof GoSetup
782  * @version Introduced in firmware 4.0.10.27
783  * @param setup GoSetup object.
784  * @return Trigger delay (uS or mm).
785  */
786 GoFx(k64f) GoSetup_TriggerDelay(GoSetup setup);
787 
788 /**
789  * Reports the minimum trigger delay, based on current settings.
790  * Depending on GoDomain, units are uS or mm.
791  *
792  * @public @memberof GoSetup
793  * @version Introduced in firmware 4.0.10.27
794  * @param setup GoSetup object.
795  * @return Minimum trigger delay (uS or mm).
796  */
797 GoFx(k64f) GoSetup_TriggerDelayLimitMin(GoSetup setup);
798 
799 /**
800  * Reports the maximum trigger delay, based on current settings.
801  * Depending on GoDomain, units are uS or mm.
802  *
803  * @public @memberof GoSetup
804  * @version Introduced in firmware 4.0.10.27
805  * @param setup GoSetup object.
806  * @return Maximum trigger delay (uS or mm).
807  */
808 GoFx(k64f) GoSetup_TriggerDelayLimitMax(GoSetup setup);
809 
810 /**
811  * Sets the trigger gate feature.
812  *
813  * @public @memberof GoSetup
814  * @version Introduced in firmware 4.0.10.27
815  * @param setup GoSetup object.
816  * @param enable Enables trigger gate operation.
817  * @return Operation status.
818  */
819 GoFx(kStatus) GoSetup_EnableTriggerGate(GoSetup setup, kBool enable);
820 
821 /**
822  * Reports whether the trigger gate feature is currently enabled.
823  *
824  * @public @memberof GoSetup
825  * @version Introduced in firmware 4.0.10.27
826  * @param setup GoSetup object.
827  * @return kTRUE if enabled, or kFALSE if disabled.
828  */
829 GoFx(kBool) GoSetup_TriggerGateEnabled(GoSetup setup);
830 
831 /**
832  * Gets the system value representing whether or not the user specified trigger gate enabled setting is being used at the moment.
833  *
834  * @public @memberof GoSetup
835  * @version Introduced in firmware 4.0.10.27
836  * @param setup GoSetup object.
837  * @return kTRUE if the user specified setting is used and kFALSE otherwise.
838  */
839 GoFx(kBool) GoSetup_TriggerGateEnabledUsed(GoSetup setup);
840 
841 /**
842  * Reports the trigger gate enabled system value.
843  *
844  * @public @memberof GoSetup
845  * @version Introduced in firmware 4.0.10.27
846  * @param setup GoSetup object.
847  * @return kTRUE if enabled, or kFALSE if disabled.
848  */
849 GoFx(kBool) GoSetup_TriggerGateEnabledSystemValue(GoSetup setup);
850 
851 /**
852  * Enables or disables operation at full frame rate (ignoring frame rate setting).
853  *
854  * @public @memberof GoSetup
855  * @version Introduced in firmware 4.0.10.27
856  * @param setup GoSetup object.
857  * @param enable Enables full frame rate operation.
858  * @return Operation status.
859  */
860 GoFx(kStatus) GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable);
861 
862 /**
863  * Reports whether or not system is configured to operate at full frame rate.
864  *
865  * @public @memberof GoSetup
866  * @version Introduced in firmware 4.0.10.27
867  * @param setup GoSetup object.
868  * @return True if system operates at full frame rate; false otherwise.
869  */
870 GoFx(kBool) GoSetup_MaxFrameRateEnabled(GoSetup setup);
871 
872 /**
873  * Sets the current frame rate for time-based triggering. The maximum frame
874  * rate option must be disabled to use the value set in this function.
875  *
876  * @public @memberof GoSetup
877  * @version Introduced in firmware 4.0.10.27
878  * @param setup GoSetup object.
879  * @param frameRate Frame Rate value (Hz).
880  * @return Operation status.
881  * @see GoSetup_EnableMaxFrameRate, GoSetup_MaxFrameRateEnabled
882  */
883 GoFx(kStatus) GoSetup_SetFrameRate(GoSetup setup, k64f frameRate);
884 
885 /**
886  * Reports the currently configured frame rate.
887  *
888  * @public @memberof GoSetup
889  * @version Introduced in firmware 4.0.10.27
890  * @param setup GoSetup object.
891  * @return Maximum frame rate (Hz).
892  */
893 GoFx(k64f) GoSetup_FrameRate(GoSetup setup);
894 
895 /**
896 * Reports the current frame rate of Tracheid data
897 *
898 * @public @memberof GoSetup
899 * @version Introduced in firmware 4.8.0.35
900 * @param setup GoSetup object.
901 * @return Tracheid frame rate (Hz).
902 */
903 GoFx(k64f) GoSetup_TracheidRate(GoSetup setup);
904 
905 /**
906 * Reports the current frame rate of normal (range, profile, or surface) data
907 *
908 * @public @memberof GoSetup
909 * @version Introduced in firmware 4.8.0.35
910 * @param setup GoSetup object.
911 * @return Frame Data Rate (Hz).
912 */
913 GoFx(k64f) GoSetup_FrameDataRate(GoSetup setup);
914 
915 /**
916  * Constraint for the minimum valid value of the Frame Rate setting.
917  *
918  * @public @memberof GoSetup
919  * @version Introduced in firmware 4.0.10.27
920  * @param setup GoSetup object.
921  * @return Minimum valid Frame Rate setting (Hz).
922  */
923 GoFx(k64f) GoSetup_FrameRateLimitMin(GoSetup setup);
924 
925 /**
926  * Constraint for the maximum valid value of the Frame Rate setting.
927  *
928  * @public @memberof GoSetup
929  * @version Introduced in firmware 4.0.10.27
930  * @param setup GoSetup object.
931  * @return Maximum valid Frame Rate setting (Hz).
932  */
933 GoFx(k64f) GoSetup_FrameRateLimitMax(GoSetup setup);
934 
935 /**
936  * Sets the encoder trigger mode.
937  *
938  * @public @memberof GoSetup
939  * @version Introduced in firmware 4.0.10.27
940  * @param setup GoSetup object.
941  * @param mode Encoder trigger mode.
942  * @return Operation status.
943  */
944 GoFx(kStatus) GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode);
945 
946 /**
947  * Gets the encoder trigger mode.
948  *
949  * @public @memberof GoSetup
950  * @version Introduced in firmware 4.0.10.27
951  * @param setup GoSetup object.
952  * @return Encoder trigger mode.
953  */
954 GoFx(GoEncoderTriggerMode) GoSetup_EncoderTriggerMode(GoSetup setup);
955 
956 /**
957  * Sets the current encoder period for encoder-based triggering.
958  *
959  * @public @memberof GoSetup
960  * @version Introduced in firmware 4.0.10.27
961  * @param setup GoSetup object.
962  * @param period Encoder period (mm).
963  * @return Operation status.
964  */
965 GoFx(kStatus) GoSetup_SetEncoderSpacing(GoSetup setup, k64f period);
966 
967 /**
968  * Gets the current encoder period for encoder-based triggering.
969  *
970  * @public @memberof GoSetup
971  * @version Introduced in firmware 4.0.10.27
972  * @param setup GoSetup object.
973  * @return Encoder period (mm).
974  */
975 GoFx(k64f) GoSetup_EncoderSpacing(GoSetup setup);
976 
977 /**
978  * Constraint for the minimum valid value of the Encoder Period setting.
979  *
980  * @public @memberof GoSetup
981  * @version Introduced in firmware 4.0.10.27
982  * @param setup GoSetup object.
983  * @return Minimum valid Encoder Period setting (mm).
984  */
985 GoFx(k64f) GoSetup_EncoderSpacingLimitMin(GoSetup setup);
986 
987 /**
988  * Constraint for the maximum valid value of the Encoder Period setting.
989  *
990  * @public @memberof GoSetup
991  * @version Introduced in firmware 4.0.10.27
992  * @param setup GoSetup object.
993  * @return Maximum valid Encoder Period setting (mm).
994  */
995 GoFx(k64f) GoSetup_EncoderSpacingLimitMax(GoSetup setup);
996 
997 /**
998  * Enables profile intensity collection.
999  *
1000  * @public @memberof GoSetup
1001  * @version Introduced in firmware 4.0.10.27
1002  * @param setup GoSetup object.
1003  * @param enable kTRUE to enable, or kFALSE to disable.
1004  * @return Operation status.
1005  */
1006 GoFx(kStatus) GoSetup_EnableIntensity(GoSetup setup, kBool enable);
1007 
1008 /**
1009  * Reports whether the profile intensity collection is enabled.
1010  *
1011  * @public @memberof GoSetup
1012  * @version Introduced in firmware 4.0.10.27
1013  * @param setup GoSetup object.
1014  * @return kTRUE if enabled, or kFALSE if disabled.
1015  */
1016 GoFx(kBool) GoSetup_IntensityEnabled(GoSetup setup);
1017 
1018 /**
1019 * Enables flicker reduction mode.
1020 *
1021 * @public @memberof GoSetup
1022 * @version Introduced in firmware 4.6.2.31
1023 * @param setup GoSetup object.
1024 * @param enable kTRUE to enable, or kFALSE to disable.
1025 * @return Operation status.
1026 */
1027 GoFx(kStatus) GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable);
1028 
1029 
1030 /**
1031 * Reports whether flicker free mode is enabled.
1032 *
1033 * @public @memberof GoSetup
1034 * @version Introduced in firmware 4.6.2.31
1035 * @param setup GoSetup object.
1036 * @return kTRUE if enabled, or kFALSE if disabled.
1037 */
1038 GoFx(kBool) GoSetup_FlickerFreeModeEnabled(GoSetup setup);
1039 
1040 /**
1041 * Reports whether flicker free mode is available for use on this sensor.
1042 *
1043 * @public @memberof GoSetup
1044 * @version Introduced in firmware 4.6.2.31
1045 * @param setup GoSetup object.
1046 * @return kTRUE if available, or kFALSE if not.
1047 */
1048 GoFx(kBool) GoSetup_FlickerFreeModeAvailable(GoSetup setup);
1049 
1050 //class - alignment
1051 
1052 /**
1053  * Gets the input trigger enabled state.
1054  *
1055  * @public @memberof GoSetup
1056  * @version Introduced in firmware 4.0.10.27
1057  * @param setup GoSetup object.
1058  * @return kTRUE if enabled and kFALSE otherwise.
1059  */
1060 GoFx(kBool) GoSetup_InputTriggerEnabled(GoSetup setup);
1061 
1062 /**
1063  * Returns a boolean representing whether the user input trigger configuration is used.
1064  *
1065  * @public @memberof GoSetup
1066  * @version Introduced in firmware 4.3.3.124
1067  * @param setup GoSetup object.
1068  * @return kTRUE if used, or kFALSE if not used.
1069  */
1070 GoFx(kBool) GoSetup_InputTriggerEnabledUsed(GoSetup setup);
1071 
1072 /**
1073  * Gets the input trigger system value.
1074  *
1075  * @public @memberof GoSetup
1076  * @version Introduced in firmware 4.3.3.124
1077  * @param setup GoSetup object.
1078  * @return kTRUE if enabled, or kFALSE if not.
1079  */
1080 GoFx(kBool) GoSetup_InputTriggerEnabledSystemValue(GoSetup setup);
1081 
1082 /**
1083  * Sets the input trigger enabled state.
1084  *
1085  * @public @memberof GoSetup
1086  * @version Introduced in firmware 4.0.10.27
1087  * @param setup GoSetup object.
1088  * @param enable kTRUE to enable it and kFALSE to disable it.
1089  */
1090 GoFx(kStatus) GoSetup_EnableInputTrigger(GoSetup setup, kBool enable);
1091 
1092 /**
1093  * Indicates whether alignment can be used.
1094  *
1095  * @public @memberof GoSetup
1096  * @version Introduced in firmware 4.5.3.57
1097  * @param setup GoSetup object.
1098  * @return True if alignment is available for use.
1099  */
1100 GoFx(kBool) GoSetup_AlignmentUsed(GoSetup setup);
1101 
1102 /**
1103  * Sets the type used for alignment.
1104  *
1105  * @public @memberof GoSetup
1106  * @version Introduced in firmware 4.0.10.27
1107  * @param setup GoSetup object.
1108  * @param type Alignment type (stationary or moving).
1109  * @return Operation status.
1110  */
1111 GoFx(kStatus) GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type);
1112 
1113 /**
1114  * Gets the type used for alignment calibration.
1115  *
1116  * @public @memberof GoSetup
1117  * @version Introduced in firmware 4.0.10.27
1118  * @param setup GoSetup object.
1119  * @return Alignment type (stationary or moving).
1120  */
1121 GoFx(GoAlignmentType) GoSetup_AlignmentType(GoSetup setup);
1122 
1123 /**
1124  * Gets the alignment type option at the given index.
1125  *
1126  * @public @memberof GoSetup
1127  * @version Introduced in firmware 4.0.10.27
1128  * @param setup GoSetup object.
1129  * @param index The index with which to retrieve an alignment type option.
1130  * @return Alignment type option.
1131  * @see GoSetup_AlignmentTypeOptionCount
1132  */
1133 GoFx(GoAlignmentType) GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index);
1134 
1135 /**
1136  * Gets the alignment type option count.
1137  *
1138  * @public @memberof GoSetup
1139  * @version Introduced in firmware 4.0.10.27
1140  * @param setup GoSetup object.
1141  * @return Alignment type option count.
1142  */
1143 GoFx(kSize) GoSetup_AlignmentTypeOptionCount(GoSetup setup);
1144 
1145 /**
1146  * Enables encoder calibration after alignment.
1147  *
1148  * @public @memberof GoSetup
1149  * @version Introduced in firmware 4.0.10.27
1150  * @param setup GoSetup object.
1151  * @param enabled kTRUE to enable encoder calibration after alignment, kFALSE to disable it.
1152  * @return Operation status.
1153  */
1154 GoFx(kStatus) GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled);
1155 
1156 /**
1157  * Gets the value of the post alignment encoder calibration setting.
1158  *
1159  * @public @memberof GoSetup
1160  * @version Introduced in firmware 4.0.10.27
1161  * @param setup GoSetup object.
1162  * @return kTRUE if post alignment encoder calibration is enabled. kFALSE otherwise.
1163  */
1164 GoFx(kBool) GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup);
1165 
1166 /**
1167  * Sets the target type used for stationary alignment calibration.
1168  *
1169  * @public @memberof GoSetup
1170  * @version Introduced in firmware 4.0.10.27
1171  * @param setup GoSetup object.
1172  * @param target Alignment target type.
1173  * @return Operation status.
1174  */
1175 GoFx(kStatus) GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target);
1176 
1177 /**
1178  * Gets the target type used for stationary alignment calibration.
1179  *
1180  * @public @memberof GoSetup
1181  * @version Introduced in firmware 4.0.10.27
1182  * @param setup GoSetup object.
1183  * @return Alignment target type.
1184  */
1185 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTarget(GoSetup setup);
1186 
1187 /**
1188  * Gets the stationary alignment target option count.
1189  *
1190  * @public @memberof GoSetup
1191  * @version Introduced in firmware 4.0.10.27
1192  * @param setup GoSetup object.
1193  * @return The alignment target count.
1194  */
1195 GoFx(kSize) GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup);
1196 
1197 /**
1198  * Gets the stationary alignment target option at the given index.
1199  *
1200  * @public @memberof GoSetup
1201  * @version Introduced in firmware 4.0.10.27
1202  * @param setup GoSetup object.
1203  * @param index The index with which to retrieve an alignment target.
1204  * @return The alignment target option.
1205  * @see GoSetup_AlignmentStationaryTargetOptionCount
1206  */
1207 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index);
1208 
1209 /**
1210  * Sets the target type used for moving alignment calibration.
1211  *
1212  * @public @memberof GoSetup
1213  * @note Supported with G1, G2
1214  * @version Introduced in firmware 4.0.10.27
1215  * @param setup GoSetup object.
1216  * @param target Alignment target type.
1217  * @return Operation status.
1218  */
1219 GoFx(kStatus) GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target);
1220 
1221 /**
1222  * Gets the target type used for moving alignment calibration.
1223  *
1224  * @public @memberof GoSetup
1225  * @note Supported with G1, G2
1226  * @version Introduced in firmware 4.0.10.27
1227  * @param setup GoSetup object.
1228  * @return Alignment target type.
1229  */
1230 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTarget(GoSetup setup);
1231 
1232 /**
1233  * Gets the moving alignment target option count.
1234  *
1235  * @public @memberof GoSetup
1236  * @note Supported with G1, G2
1237  * @version Introduced in firmware 4.0.10.27
1238  * @param setup GoSetup object.
1239  * @return The alignment target count.
1240  */
1241 GoFx(kSize) GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup);
1242 
1243 /**
1244 * Gets the moving alignment target option at the given index.
1245 *
1246 * @public @memberof GoSetup
1247 * @note Supported with G1, G2
1248 * @version Introduced in firmware 4.0.10.27
1249 * @param setup GoSetup object.
1250 * @param index The index with which to retrieve an alignment target.
1251 * @return The alignment target option.
1252 * @see GoSetup_AlignmentMovingTargetOptionCount
1253 */
1254 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index);
1255 
1256 /**
1257  * Sets the diameter of the disk used for travel calibration.
1258  *
1259  * @public @memberof GoSetup
1260  * @note Supported with G1, G2
1261  * @version Introduced in firmware 4.0.10.27
1262  * @param setup GoSetup object.
1263  * @param diameter Disk diameter (mm).
1264  * @return Operation status.
1265  */
1266 GoFx(kStatus) GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter);
1267 
1268 /**
1269  * Gets the diameter of the disk used for travel calibration.
1270  *
1271  * @public @memberof GoSetup
1272  * @note Supported with G1, G2
1273  * @version Introduced in firmware 4.0.10.27
1274  * @param setup GoSetup object.
1275  * @return Disk diameter (mm).
1276  */
1277 GoFx(k64f) GoSetup_DiskDiameter(GoSetup setup);
1278 
1279 /**
1280  * Sets the height of the disk used for travel calibration.
1281  *
1282  * @public @memberof GoSetup
1283  * @note Supported with G1, G2
1284  * @version Introduced in firmware 4.0.10.27
1285  * @param setup GoSetup object.
1286  * @param height Disk height (mm).
1287  * @return Operation status.
1288  */
1289 GoFx(kStatus) GoSetup_SetDiskHeight(GoSetup setup, k64f height);
1290 
1291 /**
1292  * Gets the height of the disk used for travel calibration.
1293  *
1294  * @public @memberof GoSetup
1295  * @note Supported with G1, G2
1296  * @version Introduced in firmware 4.0.10.27
1297  * @param setup GoSetup object.
1298  * @return Disk height (mm).
1299  */
1300 GoFx(k64f) GoSetup_DiskHeight(GoSetup setup);
1301 
1302 /**
1303  * Sets the width of the bar used for travel calibration.
1304  *
1305  * @public @memberof GoSetup
1306  * @version Introduced in firmware 4.0.10.27
1307  * @param setup GoSetup object.
1308  * @param width Bar width (mm).
1309  * @return Operation status.
1310  */
1311 GoFx(kStatus) GoSetup_SetBarWidth(GoSetup setup, k64f width);
1312 
1313 /**
1314  * Gets the width of the bar used for travel calibration.
1315  *
1316  * @public @memberof GoSetup
1317  * @version Introduced in firmware 4.0.10.27
1318  * @param setup GoSetup object.
1319  * @return Bar width (mm).
1320  */
1321 GoFx(k64f) GoSetup_BarWidth(GoSetup setup);
1322 
1323 /**
1324  * Sets the height of the bar used for travel calibration.
1325  *
1326  * @public @memberof GoSetup
1327  * @version Introduced in firmware 4.0.10.27
1328  * @param setup GoSetup object.
1329  * @param height Bar height (mm).
1330  * @return Operation status.
1331  */
1332 GoFx(kStatus) GoSetup_SetBarHeight(GoSetup setup, k64f height);
1333 
1334 /**
1335  * Gets the height of the bar used for travel calibration.
1336  *
1337  * @public @memberof GoSetup
1338  * @version Introduced in firmware 4.0.10.27
1339  * @param setup GoSetup object.
1340  * @return Bar height (mm).
1341  */
1342 GoFx(k64f) GoSetup_BarHeight(GoSetup setup);
1343 
1344 /**
1345 * Indicates if the hole count can be modified by the user.
1346 *
1347 * @public @memberof GoSetup
1348 * @version Introduced in firmware 4.6.3.51
1349 * @param setup GoSetup object.
1350 * @return kTRUE if used. kFALSE if not.
1351 */
1352 GoFx(kBool) GoSetup_BarHoleCountUsed(GoSetup setup);
1353 
1354 /**
1355 * Gets the bar hole count system value.
1356 *
1357 * @public @memberof GoSetup
1358 * @version Introduced in firmware 4.6.3.51
1359 * @param setup GoSetup object.
1360 * @return Number of columns.
1361 */
1362 GoFx(kSize) GoSetup_BarHoleCountValue(GoSetup setup);
1363 
1364 /**
1365  * Sets the number of holes that are defined on the calibration bar.
1366  *
1367  * @public @memberof GoSetup
1368  * @version Introduced in firmware 4.0.10.27
1369  * @param setup GoSetup object.
1370  * @param count Hole count.
1371  * @return Operation status.
1372  */
1373 GoFx(kStatus) GoSetup_SetBarHoleCount(GoSetup setup, kSize count);
1374 
1375 /**
1376  * Gets the number of holes that are defined on the calibration bar.
1377  *
1378  * @public @memberof GoSetup
1379  * @version Introduced in firmware 4.0.10.27
1380  * @param setup GoSetup object.
1381  * @return Hole count.
1382  */
1383 GoFx(kSize) GoSetup_BarHoleCount(GoSetup setup);
1384 
1385 /**
1386 * Indicates if the hole distance can be modified by the user.
1387 *
1388 * @public @memberof GoSetup
1389 * @version Introduced in firmware 4.6.3.51
1390 * @param setup GoSetup object.
1391 * @return kTRUE if used. kFALSE if not.
1392 */
1393 GoFx(kBool) GoSetup_BarHoleDistanceUsed(GoSetup setup);
1394 
1395 /**
1396  * Sets the distance between holes that are defined on the calibration bar.
1397  *
1398  * @public @memberof GoSetup
1399  * @version Introduced in firmware 4.0.10.27
1400  * @param setup GoSetup object.
1401  * @param distance Hole distance (mm).
1402  * @return Operation status.
1403  */
1404 GoFx(kStatus) GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance);
1405 
1406 /**
1407  * Gets the distance between holes that are defined on the calibration bar.
1408  *
1409  * @public @memberof GoSetup
1410  * @version Introduced in firmware 4.0.10.27
1411  * @param setup GoSetup object.
1412  * @return Hole distance (mm).
1413  */
1414 GoFx(k64f) GoSetup_BarHoleDistance(GoSetup setup);
1415 
1416 /**
1417 * Indicates if the hole diameter can be modified by the user.
1418 *
1419 * @public @memberof GoSetup
1420 * @version Introduced in firmware 4.6.3.55
1421 * @param setup GoSetup object.
1422 * @return kTRUE if used. kFALSE if not.
1423 */
1424 GoFx(kBool) GoSetup_BarHoleDiameterUsed(GoSetup setup);
1425 
1426 /**
1427  * Sets the diameter of holes that are defined on the calibration bar.
1428  *
1429  * @public @memberof GoSetup
1430  * @version Introduced in firmware 4.0.10.27
1431  * @param setup GoSetup object.
1432  * @param diameter Hole diameter (mm).
1433  * @return Operation status.
1434  */
1435 GoFx(kStatus) GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter);
1436 
1437 /**
1438  * Gets the diameter of holes that are defined on the calibration bar.
1439  *
1440  * @public @memberof GoSetup
1441  * @version Introduced in firmware 4.0.10.27
1442  * @param setup GoSetup object.
1443  * @return Hole diameter (mm).
1444  */
1445 GoFx(k64f) GoSetup_BarHoleDiameter(GoSetup setup);
1446 
1447 /**
1448  * Sets the degrees of freedom used for bar alignment calibration.
1449  *
1450  * @public @memberof GoSetup
1451  * @version Introduced in firmware 4.7.3.70
1452  * @param setup GoSetup object.
1453  * @param dof Alignment degrees of freedom for the bar.
1454  * @return Operation status.
1455  */
1456 GoFx(kStatus) GoSetup_SetBarDegreesOfFreedom(GoSetup setup, GoAlignmentDegreesOfFreedom dof);
1457 
1458 /**
1459  * Gets the degrees of freedom used for bar alignment calibration.
1460  *
1461  * @public @memberof GoSetup
1462  * @version Introduced in firmware 4.7.3.70
1463  * @param setup GoSetup object.
1464  * @return Degrees of freedom setting for the bar alignment.
1465  */
1466 GoFx(GoAlignmentDegreesOfFreedom) GoSetup_BarDegreesOfFreedom( GoSetup setup );
1467 
1468 /**
1469 * Indicates if the degrees of freedom for bar alignment can be modified by the user.
1470 *
1471 * @public @memberof GoSetup
1472 * @version Introduced in firmware 4.7.3.70
1473 * @param setup GoSetup object.
1474 * @return kTRUE if used. kFALSE if not.
1475 */
1476 GoFx(kBool) GoSetup_BarDegreesOfFreedomUsed(GoSetup setup);
1477 
1478 /**
1479  * Gets the degrees of freedom bar alignment target option count.
1480  *
1481  * @public @memberof GoSetup
1482  * @version Introduced in firmware 4.7.3.70
1483  * @param setup GoSetup object.
1484  * @return The bar alignment degrees of freedom option count.
1485  */
1486 GoFx(kSize) GoSetup_BarDegreesOfFreedomOptionCount(GoSetup setup);
1487 
1488 /**
1489  * Gets the bar alignment degrees of freedom option at the given index.
1490  *
1491  * @public @memberof GoSetup
1492  * @version Introduced in firmware 4.7.3.70
1493  * @param setup GoSetup object.
1494  * @param index The index with which to retrieve the degree of freedom.
1495  * @return The degrees of freedom option set at the index.
1496  */
1497 GoFx(GoAlignmentDegreesOfFreedom) GoSetup_BarDegreesOfFreedomOptionAt(GoSetup setup, kSize index);
1498 
1499 /**
1500  * Sets the height of the plate used for travel calibration.
1501  *
1502  * @public @memberof GoSetup
1503  * @version Introduced in firmware 4.0.10.27
1504  * @param setup GoSetup object.
1505  * @param height Plate height (mm).
1506  * @return Operation status.
1507  */
1508 GoFx(kStatus) GoSetup_SetPlateHeight(GoSetup setup, k64f height);
1509 
1510 /**
1511  * Gets the height of the plate used for travel calibration.
1512  *
1513  * @public @memberof GoSetup
1514  * @version Introduced in firmware 4.0.10.27
1515  * @param setup GoSetup object.
1516  * @return Plate height (mm).
1517  */
1518 GoFx(k64f) GoSetup_PlateHeight(GoSetup setup);
1519 
1520 /**
1521  * Sets the number of holes that are defined on the calibration plate.
1522  *
1523  * @public @memberof GoSetup
1524  * @version Introduced in firmware 4.0.10.27
1525  * @param setup GoSetup object.
1526  * @param count Hole count.
1527  * @return Operation status.
1528  */
1529 GoFx(kStatus) GoSetup_SetPlateHoleCount(GoSetup setup, kSize count);
1530 
1531 /**
1532  * Gets the number of holes that are defined on the calibration plate.
1533  *
1534  * @public @memberof GoSetup
1535  * @version Introduced in firmware 4.0.10.27
1536  * @param setup GoSetup object.
1537  * @return Hole count.
1538  */
1539 GoFx(kSize) GoSetup_PlateHoleCount(GoSetup setup);
1540 
1541 /**
1542  * Sets the diameter of the reference hole defined on the calibration plate.
1543  *
1544  * @public @memberof GoSetup
1545  * @version Introduced in firmware 4.0.10.27
1546  * @param setup GoSetup object.
1547  * @param diameter Hole diameter (mm).
1548  * @return Operation status.
1549  */
1550 GoFx(kStatus) GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter);
1551 
1552 /**
1553  * Gets the diameter of the reference hole defined on the calibration plate.
1554  *
1555  * @public @memberof GoSetup
1556  * @version Introduced in firmware 4.0.10.27
1557  * @param setup GoSetup object.
1558  * @return Hole diameter (mm).
1559  */
1560 GoFx(k64f) GoSetup_PlateRefHoleDiameter(GoSetup setup);
1561 
1562 /**
1563  * Sets the diameter of the secondary hole defined on the calibration plate.
1564  *
1565  * @public @memberof GoSetup
1566  * @version Introduced in firmware 4.0.10.27
1567  * @param setup GoSetup object.
1568  * @param diameter Hole diameter (mm).
1569  * @return Operation status.
1570  */
1571 GoFx(kStatus) GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter);
1572 
1573 /**
1574  * Gets the diameter of the secondary hole defined on the calibration plate.
1575  *
1576  * @public @memberof GoSetup
1577  * @version Introduced in firmware 4.0.10.27
1578  * @param setup GoSetup object.
1579  * @return Hole diameter (mm).
1580  */
1581 GoFx(k64f) GoSetup_PlateSecHoleDiameter(GoSetup setup);
1582 
1583 /**
1584  * Adds a corner parameters object to the collection of polygon corners for alignment.
1585  *
1586  * @public @memberof GoSetup
1587  * @version Introduced in firmware 4.8.0.72
1588  * @param setup GoSetup object.
1589  * @param corner Reference to GoPolygonCornerParameters object.
1590  * @return Operation status.
1591  */
1592 GoFx(kStatus) GoSetup_AddPolygonCorner(GoSetup setup, GoPolygonCornerParameters* corner);
1593 
1594 /* Adds corner parameters to the collection of polygon corners for alignment.
1595  *
1596  * @public @memberof GoSetup
1597  * @version Introduced in firmware 4.8.0.86
1598  * @param pointx X coordinate of corner.
1599  * @param pointz Z coordinate of corner.
1600  * @param devices Array list of devices assigned to corner.
1601  * @return Operation status.
1602  */
1603 GoFx(kStatus) GoSetup_AddPolygonCornerParams(GoSetup setup, k64f pointx, k64f pointz, const kChar *devices);
1604 
1605 /**
1606  * Clears all corner parameter objects from the collection of polygon corners for alignment.
1607  *
1608  * @public @memberof GoSetup
1609  * @version Introduced in firmware 4.8.0.72
1610  * @param setup GoSetup object.
1611  * @return Operation status.
1612  */
1613 GoFx(kStatus) GoSetup_ClearPolygonCorners(GoSetup setup);
1614 
1615 /**
1616  * Retrieves the reference to the corner parameters object from the collection of polygon corners.
1617  *
1618  * @public @memberof GoSetup
1619  * @version Introduced in firmware 4.8.0.72
1620  * @param setup GoSetup object.
1621  * @param index Index in the collection of polygon corners.
1622  * @return Reference to corresponding corner parameters.
1623  */
1624 GoFx(GoPolygonCornerParameters*) GoSetup_PolygonCornerAt(GoSetup setup, kSize index);
1625 
1626 /**
1627  * Gets the number of corner parameters defined in the collection of polygon corners.
1628  *
1629  * @public @memberof GoSetup
1630  * @version Introduced in firmware 4.8.0.72
1631  * @param setup GoSetup object.
1632  * @return Number of corner parameters in polygon.
1633  */
1634 GoFx(kSize) GoSetup_PolygonCornerCount(GoSetup setup);
1635 
1636 
1637 /**
1638  * Indicates whether X smoothing can be used for the current scan mode and device family.
1639  *
1640  * @public @memberof GoSetup
1641  * @note Supported with G1, G2
1642  * @version Introduced in firmware 4.5.3.57
1643  * @param setup GoSetup object.
1644  * @return True if x-smoothing is available for use.
1645  */
1646 GoFx(kBool) GoSetup_XSmoothingUsed(GoSetup setup);
1647 
1648 /**
1649  * Sets the status of x-direction smoothing.
1650  *
1651  * @public @memberof GoSetup
1652  * @note Supported with G1, G2
1653  * @version Introduced in firmware 4.0.10.27
1654  * @param setup GoSetup object.
1655  * @param enabled Enable or disable x-smoothing
1656  * @return Operation status.
1657  */
1658 GoFx(kStatus) GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled);
1659 
1660 /**
1661  * Gets the status of x-direction smoothing.
1662  *
1663  * @public @memberof GoSetup
1664  * @note Supported with G1, G2
1665  * @version Introduced in firmware 4.0.10.27
1666  * @param setup GoSetup object.
1667  * @return True if x-smoothing is enabled.
1668  */
1669 GoFx(kBool) GoSetup_XSmoothingEnabled(GoSetup setup);
1670 
1671 /**
1672  * Sets the x-direction smoothing window.
1673  *
1674  * @public @memberof GoSetup
1675  * @note Supported with G1, G2
1676  * @version Introduced in firmware 4.0.10.27
1677  * @param setup GoSetup object.
1678  * @param window The x-smoothing window (mm).
1679  * @return Operation status.
1680  */
1681 GoFx(kStatus) GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window);
1682 
1683 /**
1684  * Gets the x-direction smoothing window.
1685  *
1686  * @public @memberof GoSetup
1687  * @note Supported with G1, G2
1688  * @version Introduced in firmware 4.0.10.27
1689  * @param setup GoSetup object.
1690  * @return The x-smoothing window (mm).
1691  */
1692 GoFx(k64f) GoSetup_XSmoothingWindow(GoSetup setup);
1693 
1694 /**
1695  * Gets the x-direction smoothing window minimum.
1696  *
1697  * @public @memberof GoSetup
1698  * @note Supported with G1, G2
1699  * @version Introduced in firmware 4.0.10.27
1700  * @param setup GoSetup object.
1701  * @return The x-smoothing window min (mm).
1702  */
1703 GoFx(k64f) GoSetup_XSmoothingWindowLimitMin(GoSetup setup);
1704 
1705 /**
1706  * Gets the x-direction smoothing window maximum.
1707  *
1708  * @public @memberof GoSetup
1709  * @note Supported with G1, G2
1710  * @version Introduced in firmware 4.0.10.27
1711  * @param setup GoSetup object.
1712  * @return The x-smoothing window max (mm).
1713  */
1714 GoFx(k64f) GoSetup_XSmoothingWindowLimitMax(GoSetup setup);
1715 
1716 /**
1717  * Indicates whether X median can be used for the current scan mode and device family.
1718  *
1719  * @public @memberof GoSetup
1720  * @note Supported with G1, G2
1721  * @version Introduced in firmware 4.5.3.57
1722  * @param setup GoSetup object.
1723  * @return True if x-median is available for use.
1724  */
1725 GoFx(kBool) GoSetup_XMedianUsed(GoSetup setup);
1726 
1727 /**
1728  * Sets the status of x-direction median.
1729  *
1730  * @public @memberof GoSetup
1731  * @note Supported with G1, G2
1732  * @version Introduced in firmware 4.1.3.106
1733  * @param setup GoSetup object.
1734  * @param enabled Enable or disable x-median
1735  * @return Operation status.
1736  */
1737 GoFx(kStatus) GoSetup_EnableXMedian(GoSetup setup, kBool enabled);
1738 
1739 /**
1740  * Gets the status of x-direction median.
1741  *
1742  * @public @memberof GoSetup
1743  * @note Supported with G1, G2
1744  * @version Introduced in firmware 4.1.3.106
1745  * @param setup GoSetup object.
1746  * @return True if x-median is enabled.
1747  */
1748 GoFx(kBool) GoSetup_XMedianEnabled(GoSetup setup);
1749 
1750 /**
1751  * Sets the x-direction median window.
1752  *
1753  * @public @memberof GoSetup
1754  * @note Supported with G1, G2
1755  * @version Introduced in firmware 4.1.3.106
1756  * @param setup GoSetup object.
1757  * @param window The x-median window (mm).
1758  * @return Operation status.
1759  */
1760 GoFx(kStatus) GoSetup_SetXMedianWindow(GoSetup setup, k64f window);
1761 
1762 /**
1763  * Gets the x-direction median window.
1764  *
1765  * @public @memberof GoSetup
1766  * @note Supported with G1, G2
1767  * @version Introduced in firmware 4.1.3.106
1768  * @param setup GoSetup object.
1769  * @return The x-median window (mm).
1770  */
1771 GoFx(k64f) GoSetup_XMedianWindow(GoSetup setup);
1772 
1773 /**
1774  * Gets the x-direction median window minimum.
1775  *
1776  * @public @memberof GoSetup
1777  * @note Supported with G1, G2
1778  * @version Introduced in firmware 4.1.3.106
1779  * @param setup GoSetup object.
1780  * @return The x-median window min (mm).
1781  */
1782 GoFx(k64f) GoSetup_XMedianWindowLimitMin(GoSetup setup);
1783 
1784 /**
1785  * Gets the x-direction median window maximum.
1786  *
1787  * @public @memberof GoSetup
1788  * @note Supported with G1, G2
1789  * @version Introduced in firmware 4.1.3.106
1790  * @param setup GoSetup object.
1791  * @return The x-median window max (mm).
1792  */
1793 GoFx(k64f) GoSetup_XMedianWindowLimitMax(GoSetup setup);
1794 
1795 /**
1796  * Indicates whether X decimation can be used for the current scan mode and device family.
1797  *
1798  * @public @memberof GoSetup
1799  * @note Supported with G1, G2
1800  * @version Introduced in firmware 4.5.3.57
1801  * @param setup GoSetup object.
1802  * @return True if x-decimation is available for use.
1803  */
1804 GoFx(kBool) GoSetup_XDecimationUsed(GoSetup setup);
1805 
1806 /**
1807  * Sets the status of x-direction decimation.
1808  *
1809  * @public @memberof GoSetup
1810  * @note Supported with G1, G2
1811  * @version Introduced in firmware 4.1.3.106
1812  * @param setup GoSetup object.
1813  * @param enabled Enable or disable x-decimation
1814  * @return Operation status.
1815  */
1816 GoFx(kStatus) GoSetup_EnableXDecimation(GoSetup setup, kBool enabled);
1817 
1818 /**
1819  * Gets the status of x-direction decimation.
1820  *
1821  * @public @memberof GoSetup
1822  * @note Supported with G1, G2
1823  * @version Introduced in firmware 4.1.3.106
1824  * @param setup GoSetup object.
1825  * @return True if x-decimation is enabled.
1826  */
1827 GoFx(kBool) GoSetup_XDecimationEnabled(GoSetup setup);
1828 
1829 /**
1830  * Sets the x-direction decimation window.
1831  *
1832  * @public @memberof GoSetup
1833  * @note Supported with G1, G2
1834  * @version Introduced in firmware 4.1.3.106
1835  * @param setup GoSetup object.
1836  * @param window The x-decimation window (mm).
1837  * @return Operation status.
1838  */
1839 GoFx(kStatus) GoSetup_SetXDecimationWindow(GoSetup setup, k64f window);
1840 
1841 /**
1842  * Gets the x-direction decimation window.
1843  *
1844  * @public @memberof GoSetup
1845  * @note Supported with G1, G2
1846  * @version Introduced in firmware 4.1.3.106
1847  * @param setup GoSetup object.
1848  * @return The x-decimation window (mm).
1849  */
1850 GoFx(k64f) GoSetup_XDecimationWindow(GoSetup setup);
1851 
1852 /**
1853  * Gets the x-direction decimation window minimum.
1854  *
1855  * @public @memberof GoSetup
1856  * @note Supported with G1, G2
1857  * @version Introduced in firmware 4.1.3.106
1858  * @param setup GoSetup object.
1859  * @return The x-decimation window min (mm).
1860  */
1861 GoFx(k64f) GoSetup_XDecimationWindowLimitMin(GoSetup setup);
1862 
1863 /**
1864  * Gets the x-direction decimation window maximum.
1865  *
1866  * @public @memberof GoSetup
1867  * @note Supported with G1, G2
1868  * @version Introduced in firmware 4.1.3.106
1869  * @param setup GoSetup object.
1870  * @return The x-decimation window max (mm).
1871  */
1872 GoFx(k64f) GoSetup_XDecimationWindowLimitMax(GoSetup setup);
1873 
1874 /**
1875  * Indicates whether X gap filling can be used for the current scan mode and device family.
1876  *
1877  * @public @memberof GoSetup
1878  * @note Supported with G1, G2
1879  * @version Introduced in firmware 4.5.3.57
1880  * @param setup GoSetup object.
1881  * @return True if x-gap filling is available for use.
1882  */
1883 GoFx(kBool) GoSetup_XGapFillingUsed(GoSetup setup);
1884 
1885 /**
1886  * Sets the status of x-direction gap-filling.
1887  *
1888  * @public @memberof GoSetup
1889  * @note Supported with G1, G2
1890  * @version Introduced in firmware 4.0.10.27
1891  * @param setup GoSetup object.
1892  * @param enable Enable or disable x-gap-filling
1893  * @return Operation status.
1894  */
1895 GoFx(kStatus) GoSetup_EnableXGapFilling(GoSetup setup, kBool enable);
1896 
1897 /**
1898  * Gets the status of x-direction gap-filling.
1899  *
1900  * @public @memberof GoSetup
1901  * @note Supported with G1, G2
1902  * @version Introduced in firmware 4.0.10.27
1903  * @param setup GoSetup object.
1904  * @return True if x-gap-filling is enabled.
1905  */
1906 GoFx(kBool) GoSetup_XGapFillingEnabled(GoSetup setup);
1907 
1908 /**
1909  * Sets the status of x-direction gap-filling.
1910  *
1911  * @public @memberof GoSetup
1912  * @note Supported with G1, G2
1913  * @version Introduced in firmware 4.0.10.27
1914  * @param setup GoSetup object.
1915  * @param window Enable or disable x-gap-filling
1916  * @return Operation status.
1917  */
1918 GoFx(kStatus) GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window);
1919 
1920 /**
1921  * Gets the x-direction gap-filling window.
1922  *
1923  * @public @memberof GoSetup
1924  * @note Supported with G1, G2
1925  * @version Introduced in firmware 4.0.10.27
1926  * @param setup GoSetup object.
1927  * @return The x-gap-filling window (mm).
1928  */
1929 GoFx(k64f) GoSetup_XGapFillingWindow(GoSetup setup);
1930 
1931 /**
1932  * Gets the x-direction gap-filling window minimum.
1933  *
1934  * @public @memberof GoSetup
1935  * @note Supported with G1, G2
1936  * @version Introduced in firmware 4.0.10.27
1937  * @param setup GoSetup object.
1938  * @return The x-gap-filling window min (mm).
1939  */
1940 GoFx(k64f) GoSetup_XGapFillingWindowLimitMin(GoSetup setup);
1941 
1942 /**
1943  * Gets the x-direction gap-filling window maximum.
1944  *
1945  * @public @memberof GoSetup
1946  * @note Supported with G1, G2
1947  * @version Introduced in firmware 4.0.10.27
1948  * @param setup GoSetup object.
1949  * @return The x-gap-filling window max (mm).
1950  */
1951 GoFx(k64f) GoSetup_XGapFillingWindowLimitMax(GoSetup setup);
1952 
1953 /**
1954  * Indicates whether X slope can be used for the current scan mode and device family.
1955  *
1956  * @public @memberof GoSetup
1957  * @note Supported with G1, G2
1958  * @version Introduced in firmware 4.5.3.57
1959  * @param setup GoSetup object.
1960  * @return True if x-slope is available for use.
1961  */
1962 GoFx(kBool) GoSetup_XSlopeUsed(GoSetup setup);
1963 
1964 /**
1965  * Sets the status of x-direction slope.
1966  *
1967  * @public @memberof GoSetup
1968  * @note Supported with G1, G2
1969  * @version Introduced in firmware 4.5.2.0
1970  * @param setup GoSetup object.
1971  * @param enable Enable or disable x-slope
1972  * @return Operation status.
1973  */
1974 GoFx(kStatus) GoSetup_EnableXSlope(GoSetup setup, kBool enable);
1975 
1976 /**
1977  * Gets the status of x-direction slope.
1978  *
1979  * @public @memberof GoSetup
1980  * @note Supported with G1, G2
1981  * @version Introduced in firmware 4.5.2.0
1982  * @param setup GoSetup object.
1983  * @return True if x-slope is enabled.
1984  */
1985 GoFx(kBool) GoSetup_XSlopeEnabled(GoSetup setup);
1986 
1987 /**
1988  * Sets the status of x-direction slope.
1989  *
1990  * @public @memberof GoSetup
1991  * @note Supported with G1, G2
1992  * @version Introduced in firmware 4.5.2.0
1993  * @param setup GoSetup object.
1994  * @param window Enable or disable x-slope
1995  * @return Operation status.
1996  */
1997 GoFx(kStatus) GoSetup_SetXSlopeWindow(GoSetup setup, k64f window);
1998 
1999 /**
2000  * Gets the x-direction slope window.
2001  *
2002  * @public @memberof GoSetup
2003  * @note Supported with G1, G2
2004  * @version Introduced in firmware 4.5.2.0
2005  * @param setup GoSetup object.
2006  * @return The x-slope window (mm).
2007  */
2008 GoFx(k64f) GoSetup_XSlopeWindow(GoSetup setup);
2009 
2010 /**
2011  * Gets the x-direction slope window minimum.
2012  *
2013  * @public @memberof GoSetup
2014  * @note Supported with G1, G2
2015  * @version Introduced in firmware 4.5.2.0
2016  * @param setup GoSetup object.
2017  * @return The x-slope window min (mm).
2018  */
2019 GoFx(k64f) GoSetup_XSlopeWindowLimitMin(GoSetup setup);
2020 
2021 /**
2022  * Gets the x-direction slope window maximum.
2023  *
2024  * @public @memberof GoSetup
2025  * @note Supported with G1, G2
2026  * @version Introduced in firmware 4.5.2.0
2027  * @param setup GoSetup object.
2028  * @return The x-slope window max (mm).
2029  */
2030 GoFx(k64f) GoSetup_XSlopeWindowLimitMax(GoSetup setup);
2031 
2032 /**
2033  * Indicates whether Y smoothing can be used for the current scan mode and device family.
2034  *
2035  * @public @memberof GoSetup
2036  * @note Supported with G1, G2
2037  * @version Introduced in firmware 4.5.3.57
2038  * @param setup GoSetup object.
2039  * @return True if y-smoothing is available for use.
2040  */
2041 GoFx(kBool) GoSetup_YSmoothingUsed(GoSetup setup);
2042 
2043 /**
2044  * Sets the status of y-direction smoothing.
2045  *
2046  * @public @memberof GoSetup
2047  * @note Supported with G1, G2
2048  * @version Introduced in firmware 4.0.10.27
2049  * @param setup GoSetup object.
2050  * @param enable Enable or disable y-smoothing
2051  * @return Operation status.
2052  */
2053 GoFx(kStatus) GoSetup_EnableYSmoothing(GoSetup setup, kBool enable);
2054 
2055 /**
2056  * Gets the status of y-direction smoothing.
2057  *
2058  * @public @memberof GoSetup
2059  * @note Supported with G1, G2
2060  * @version Introduced in firmware 4.0.10.27
2061  * @param setup GoSetup object.
2062  * @return True if y-smoothing is enabled.
2063  */
2064 GoFx(kBool) GoSetup_YSmoothingEnabled(GoSetup setup);
2065 
2066 /**
2067  * Sets the y-direction smoothing window.
2068  *
2069  * @public @memberof GoSetup
2070  * @note Supported with G1, G2
2071  * @version Introduced in firmware 4.0.10.27
2072  * @param setup GoSetup object.
2073  * @param window The y-smoothing window (mm).
2074  * @return Operation status.
2075  */
2076 GoFx(kStatus) GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window);
2077 
2078 /**
2079  * Gets the y-direction smoothing window.
2080  *
2081  * @public @memberof GoSetup
2082  * @note Supported with G1, G2
2083  * @version Introduced in firmware 4.0.10.27
2084  * @param setup GoSetup object.
2085  * @return The y-smoothing window (mm).
2086  */
2087 GoFx(k64f) GoSetup_YSmoothingWindow(GoSetup setup);
2088 
2089 /**
2090  * Gets the y-direction smoothing window minimum.
2091  *
2092  * @public @memberof GoSetup
2093  * @note Supported with G1, G2
2094  * @version Introduced in firmware 4.0.10.27
2095  * @param setup GoSetup object.
2096  * @return The y-smoothing window min (mm).
2097  */
2098 GoFx(k64f) GoSetup_YSmoothingWindowLimitMin(GoSetup setup);
2099 
2100 /**
2101  * Gets the y-direction smoothing window maximum.
2102  *
2103  * @public @memberof GoSetup
2104  * @note Supported with G1, G2
2105  * @version Introduced in firmware 4.0.10.27
2106  * @param setup GoSetup object.
2107  * @return The y-smoothing window max (mm).
2108  */
2109 GoFx(k64f) GoSetup_YSmoothingWindowLimitMax(GoSetup setup);
2110 
2111 /**
2112  * Indicates whether Y median can be used for the current scan mode and device family.
2113  *
2114  * @public @memberof GoSetup
2115  * @note Supported with G1, G2
2116  * @version Introduced in firmware 4.5.3.57
2117  * @param setup GoSetup object.
2118  * @return True if y-median is available for use.
2119  */
2120 GoFx(kBool) GoSetup_YMedianUsed(GoSetup setup);
2121 
2122 /**
2123  * Sets the status of y-direction median.
2124  *
2125  * @public @memberof GoSetup
2126  * @note Supported with G1, G2
2127  * @version Introduced in firmware 4.1.3.106
2128  * @param setup GoSetup object.
2129  * @param enable Enable or disable y-median
2130  * @return Operation status.
2131  */
2132 GoFx(kStatus) GoSetup_EnableYMedian(GoSetup setup, kBool enable);
2133 
2134 /**
2135  * Gets the status of y-direction median.
2136  *
2137  * @public @memberof GoSetup
2138  * @note Supported with G1, G2
2139  * @version Introduced in firmware 4.1.3.106
2140  * @param setup GoSetup object.
2141  * @return True if y-median is enabled.
2142  */
2143 GoFx(kBool) GoSetup_YMedianEnabled(GoSetup setup);
2144 
2145 /**
2146  * Sets the y-direction median window.
2147  *
2148  * @public @memberof GoSetup
2149  * @note Supported with G1, G2
2150  * @version Introduced in firmware 4.1.3.106
2151  * @param setup GoSetup object.
2152  * @param window The y-median window (mm).
2153  * @return Operation status.
2154  */
2155 GoFx(kStatus) GoSetup_SetYMedianWindow(GoSetup setup, k64f window);
2156 
2157 /**
2158  * Gets the y-direction median window.
2159  *
2160  * @public @memberof GoSetup
2161  * @note Supported with G1, G2
2162  * @version Introduced in firmware 4.1.3.106
2163  * @param setup GoSetup object.
2164  * @return The y-median window (mm).
2165  */
2166 GoFx(k64f) GoSetup_YMedianWindow(GoSetup setup);
2167 
2168 /**
2169  * Gets the y-direction median window minimum.
2170  *
2171  * @public @memberof GoSetup
2172  * @note Supported with G1, G2
2173  * @version Introduced in firmware 4.1.3.106
2174  * @param setup GoSetup object.
2175  * @return The y-median window min (mm).
2176  */
2177 GoFx(k64f) GoSetup_YMedianWindowLimitMin(GoSetup setup);
2178 
2179 /**
2180  * Gets the y-direction median window maximum.
2181  *
2182  * @public @memberof GoSetup
2183  * @note Supported with G1, G2
2184  * @version Introduced in firmware 4.1.3.106
2185  * @param setup GoSetup object.
2186  * @return The y-median window max (mm).
2187  */
2188 GoFx(k64f) GoSetup_YMedianWindowLimitMax(GoSetup setup);
2189 
2190 /**
2191  * Indicates whether y decimation can be used for the current scan mode and device family.
2192  *
2193  * @public @memberof GoSetup
2194  * @note Supported with G1, G2
2195  * @version Introduced in firmware 4.5.3.57
2196  * @param setup GoSetup object.
2197  * @return True if y-decimation is available for use.
2198  */
2199 GoFx(kBool) GoSetup_YDecimationUsed(GoSetup setup);
2200 
2201 /**
2202  * Sets the status of y-direction decimation.
2203  *
2204  * @public @memberof GoSetup
2205  * @note Supported with G1, G2
2206  * @version Introduced in firmware 4.1.3.106
2207  * @param setup GoSetup object.
2208  * @param enable Enable or disable y-decimation
2209  * @return Operation status.
2210  */
2211 GoFx(kStatus) GoSetup_EnableYDecimation(GoSetup setup, kBool enable);
2212 
2213 /**
2214  * Gets the status of y-direction decimation.
2215  *
2216  * @public @memberof GoSetup
2217  * @note Supported with G1, G2
2218  * @version Introduced in firmware 4.1.3.106
2219  * @param setup GoSetup object.
2220  * @return True if y-decimation is enabled.
2221  */
2222 GoFx(kBool) GoSetup_YDecimationEnabled(GoSetup setup);
2223 
2224 /**
2225  * Sets the y-direction decimation window.
2226  *
2227  * @public @memberof GoSetup
2228  * @note Supported with G1, G2
2229  * @version Introduced in firmware 4.1.3.106
2230  * @param setup GoSetup object.
2231  * @param window The y-decimation window (mm).
2232  * @return Operation status.
2233  */
2234 GoFx(kStatus) GoSetup_SetYDecimationWindow(GoSetup setup, k64f window);
2235 
2236 /**
2237  * Gets the y-direction decimation window.
2238  *
2239  * @public @memberof GoSetup
2240  * @note Supported with G1, G2
2241  * @version Introduced in firmware 4.1.3.106
2242  * @param setup GoSetup object.
2243  * @return The y-decimation window (mm).
2244  */
2245 GoFx(k64f) GoSetup_YDecimationWindow(GoSetup setup);
2246 
2247 /**
2248  * Gets the y-direction decimation window minimum.
2249  *
2250  * @public @memberof GoSetup
2251  * @note Supported with G1, G2
2252  * @version Introduced in firmware 4.1.3.106
2253  * @param setup GoSetup object.
2254  * @return The y-decimation window min (mm).
2255  */
2256 GoFx(k64f) GoSetup_YDecimationWindowLimitMin(GoSetup setup);
2257 
2258 /**
2259  * Gets the y-direction decimation window maximum.
2260  *
2261  * @public @memberof GoSetup
2262  * @note Supported with G1, G2
2263  * @version Introduced in firmware 4.1.3.106
2264  * @param setup GoSetup object.
2265  * @return The y-decimation window max (mm).
2266  */
2267 GoFx(k64f) GoSetup_YDecimationWindowLimitMax(GoSetup setup);
2268 
2269 /**
2270  * Indicates whether Y slope can be used for the current scan mode and device family.
2271  *
2272  * @public @memberof GoSetup
2273  * @note Supported with G1, G2
2274  * @version Introduced in firmware 4.5.3.57
2275  * @param setup GoSetup object.
2276  * @return True if y-slope is available for use.
2277  */
2278 GoFx(kBool) GoSetup_YSlopeUsed(GoSetup setup);
2279 
2280 /**
2281  * Sets the status of y-direction slope.
2282  *
2283  * @public @memberof GoSetup
2284  * @note Supported with G1, G2
2285  * @version Introduced in firmware 4.5.2.0
2286  * @param setup GoSetup object.
2287  * @param enable Enable or disable y-slope
2288  * @return Operation status.
2289  */
2290 GoFx(kStatus) GoSetup_EnableYSlope(GoSetup setup, kBool enable);
2291 
2292 /**
2293  * Gets the status of y-direction slope.
2294  *
2295  * @public @memberof GoSetup
2296  * @note Supported with G1, G2
2297  * @version Introduced in firmware 4.5.2.0
2298  * @param setup GoSetup object.
2299  * @return True if y-slope is enabled.
2300  */
2301 GoFx(kBool) GoSetup_YSlopeEnabled(GoSetup setup);
2302 
2303 /**
2304  * Sets the status of y-direction slope.
2305  *
2306  * @public @memberof GoSetup
2307  * @note Supported with G1, G2
2308  * @version Introduced in firmware 4.5.2.0
2309  * @param setup GoSetup object.
2310  * @param window Enable or disable y-slope
2311  * @return Operation status.
2312  */
2313 GoFx(kStatus) GoSetup_SetYSlopeWindow(GoSetup setup, k64f window);
2314 
2315 /**
2316  * Gets the y-direction slope window.
2317  *
2318  * @public @memberof GoSetup
2319  * @note Supported with G1, G2
2320  * @version Introduced in firmware 4.5.2.0
2321  * @param setup GoSetup object.
2322  * @return The y-slope window (mm).
2323  */
2324 GoFx(k64f) GoSetup_YSlopeWindow(GoSetup setup);
2325 
2326 /**
2327  * Gets the y-direction slope window minimum.
2328  *
2329  * @public @memberof GoSetup
2330  * @note Supported with G1, G2
2331  * @version Introduced in firmware 4.5.2.0
2332  * @param setup GoSetup object.
2333  * @return The y-slope window min (mm).
2334  */
2335 GoFx(k64f) GoSetup_YSlopeWindowLimitMin(GoSetup setup);
2336 
2337 /**
2338  * Gets the y-direction slope window maximum.
2339  *
2340  * @public @memberof GoSetup
2341  * @note Supported with G1, G2
2342  * @version Introduced in firmware 4.5.2.0
2343  * @param setup GoSetup object.
2344  * @return The y-slope window max (mm).
2345  */
2346 GoFx(k64f) GoSetup_YSlopeWindowLimitMax(GoSetup setup);
2347 
2348 /**
2349  * Indicates whether Y gap filling can be used for the current scan mode and device family.
2350  *
2351  * @public @memberof GoSetup
2352  * @note Supported with G2
2353  * @version Introduced in firmware 4.5.3.57
2354  * @param setup GoSetup object.
2355  * @return True if y-gap filling is available for use.
2356  */
2357 GoFx(kBool) GoSetup_YGapFillingUsed(GoSetup setup);
2358 
2359 /**
2360  * Sets the status of y-direction gap-filling.
2361  *
2362  * @public @memberof GoSetup
2363  * @note Supported with G2
2364  * @version Introduced in firmware 4.0.10.27
2365  * @param setup GoSetup object.
2366  * @param enable Enable or disable y-gap-filling
2367  * @return Operation status.
2368  */
2369 GoFx(kStatus) GoSetup_EnableYGapFilling(GoSetup setup, kBool enable);
2370 
2371 /**
2372  * Gets the status of y-direction gap-filling.
2373  *
2374  * @public @memberof GoSetup
2375  * @note Supported with G2
2376  * @version Introduced in firmware 4.0.10.27
2377  * @param setup GoSetup object.
2378  * @return True if y-gap-filling is enabled.
2379  */
2380 GoFx(kBool) GoSetup_YGapFillingEnabled(GoSetup setup);
2381 
2382 /**
2383  * Sets the y-direction gap-filling window.
2384  *
2385  * @public @memberof GoSetup
2386  * @note Supported with G2
2387  * @version Introduced in firmware 4.0.10.27
2388  * @param setup GoSetup object.
2389  * @param window The y-gap-filling window (mm).
2390  * @return
2391  */
2392 GoFx(kStatus) GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window);
2393 
2394 /**
2395  * Gets the y-direction gap-filling window.
2396  *
2397  * @public @memberof GoSetup
2398  * @note Supported with G2
2399  * @version Introduced in firmware 4.0.10.27
2400  * @param setup GoSetup object.
2401  * @return The y-gap-filling window (mm).
2402  */
2403 GoFx(k64f) GoSetup_YGapFillingWindow(GoSetup setup);
2404 
2405 /**
2406  * Gets the y-direction gap-filling window minimum.
2407  *
2408  * @public @memberof GoSetup
2409  * @note Supported with G2
2410  * @version Introduced in firmware 4.0.10.27
2411  * @param setup GoSetup object.
2412  * @return The y-gap-filling window min (mm).
2413  */
2414 GoFx(k64f) GoSetup_YGapFillingWindowLimitMin(GoSetup setup);
2415 
2416 /**
2417  * Gets the y-direction gap-filling window maximum.
2418  *
2419  * @public @memberof GoSetup
2420  * @note Supported with G2
2421  * @version Introduced in firmware 4.0.10.27
2422  * @param setup GoSetup object.
2423  * @return The y-gap-filling window max (mm).
2424  */
2425 GoFx(k64f) GoSetup_YGapFillingWindowLimitMax(GoSetup setup);
2426 
2427 /**
2428  * Gets the maximum valid value for the Exposure setting.
2429  *
2430  * @public @memberof GoSetup
2431  * @version Introduced in firmware 4.0.10.27
2432  * @param setup GoSetup object.
2433  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2434  * @return Maximum valid Exposure value (microseconds).
2435  */
2436 GoFx(k64f) GoSetup_ExposureLimitMax(GoSetup setup, GoRole role);
2437 
2438 /**
2439  * Gets the minimum valid value for the Exposure setting.
2440  *
2441  * @public @memberof GoSetup
2442  * @version Introduced in firmware 4.0.10.27
2443  * @param setup GoSetup object.
2444  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2445  * @return Minimum valid Exposure value (microseconds).
2446  */
2447 GoFx(k64f) GoSetup_ExposureLimitMin(GoSetup setup, GoRole role);
2448 
2449 /**
2450  * Sets the exposure value.
2451  *
2452  * @public @memberof GoSetup
2453  * @version Introduced in firmware 4.0.10.27
2454  * @param setup GoSetup object.
2455  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2456  * @param exposure Intended exposure value.
2457  * @return Operation status.
2458  */
2459 GoFx(kStatus) GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure);
2460 
2461 /**
2462  * Gets the exposure value.
2463  *
2464  * @public @memberof GoSetup
2465  * @version Introduced in firmware 4.0.10.27
2466  * @param setup GoSetup object.
2467  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2468  * @return Exposure value (microseconds).
2469  */
2470 GoFx(k64f) GoSetup_Exposure(GoSetup setup, GoRole role);
2471 
2472 /**
2473  * Gets the exposure mode.
2474  *
2475  * @public @memberof GoSetup
2476  * @version Introduced in firmware 4.0.10.27
2477  * @param setup GoSetup object.
2478  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2479  * @return Exposure mode.
2480  */
2481 GoFx(GoExposureMode) GoSetup_ExposureMode(GoSetup setup, GoRole role);
2482 
2483 /**
2484  * Sets the exposure mode.
2485  *
2486  * @public @memberof GoSetup
2487  * @version Introduced in firmware 4.0.10.27
2488  * @param setup GoSetup object.
2489  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2490  * @param mode The exposure mode to use.
2491  * @return Operation status.
2492  */
2493 GoFx(kStatus) GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode);
2494 
2495 /**
2496  * Gets the exposure mode option at the given index.
2497  *
2498  * @public @memberof GoSetup
2499  * @version Introduced in firmware 4.0.10.27
2500  * @param setup GoSetup object.
2501  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2502  * @param index The index with which to retrieve an exposure mode option.
2503  * @return Exposure mode option.
2504  * @see GoSetup_ExposureModeOptionCount
2505  */
2506 GoFx(GoExposureMode) GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index);
2507 
2508 /**
2509  * Gets the exposure mode option count.
2510  *
2511  * @public @memberof GoSetup
2512  * @version Introduced in firmware 4.0.10.27
2513  * @param setup GoSetup object.
2514  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2515  * @return Exposure mode option count.
2516  */
2517 GoFx(kSize) GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role);
2518 
2519 /**
2520  * Adds an exposure step
2521  *
2522  * @public @memberof GoSetup
2523  * @version Introduced in firmware 4.0.10.27
2524  * @param setup GoSetup object.
2525  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2526  * @param exposure Exposure value (microseconds).
2527  * @return Operation status.
2528  */
2529 GoFx(kStatus) GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure);
2530 
2531 /**
2532  * Removes all exposure steps.
2533  *
2534  * @public @memberof GoSetup
2535  * @version Introduced in firmware 4.0.10.27
2536  * @param setup GoSetup object.
2537  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2538  * @return Operation status.
2539  */
2540 GoFx(kStatus) GoSetup_ClearExposureSteps(GoSetup setup, GoRole role);
2541 
2542 /**
2543  * Get the exposure step value specified by index
2544  *
2545  * @public @memberof GoSetup
2546  * @version Introduced in firmware 4.0.10.27
2547  * @param setup GoSetup object.
2548  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2549  * @param index The index of the exposure step to get.
2550  * @return The exposure step value (microseconds).
2551  * @see GoSetup_ExposureStepCount
2552  */
2553 GoFx(k64f) GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index);
2554 
2555 /**
2556  * Get the number of exposure steps defined
2557  *
2558  * @public @memberof GoSetup
2559  * @version Introduced in firmware 4.0.10.27
2560  * @param setup GoSetup object.
2561  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2562  * @return The count of exposure steps.
2563  */
2564 GoFx(kSize) GoSetup_ExposureStepCount(GoSetup setup, GoRole role);
2565 
2566 /**
2567  * Gets the maximum value for the Dynamic Exposure setting.
2568  *
2569  * @public @memberof GoSetup
2570  * @version Introduced in firmware 4.0.10.27
2571  * @param setup GoSetup object.
2572  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2573  * @return Maximum Dynamic Exposure value (microseconds).
2574  */
2575 GoFx(k64f) GoSetup_DynamicExposureMax(GoSetup setup, GoRole role);
2576 
2577 /**
2578  * Sets the maximum value for the Dynamic Exposure setting.
2579  *
2580  * @public @memberof GoSetup
2581  * @version Introduced in firmware 4.0.10.27
2582  * @param setup GoSetup object.
2583  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2584  * @param exposure Maximum Dynamic Exposure value (microseconds).
2585  * @return Operation status.
2586  */
2587 GoFx(kStatus) GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure);
2588 
2589 /**
2590  * Gets the minimum value for the Dynamic Exposure setting.
2591  *
2592  * @public @memberof GoSetup
2593  * @version Introduced in firmware 4.0.10.27
2594  * @param setup GoSetup object.
2595  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2596  * @return Minimum Dynamic Exposure value (microseconds).
2597  */
2598 GoFx(k64f) GoSetup_DynamicExposureMin(GoSetup setup, GoRole role);
2599 
2600 /**
2601  * Sets the minimum value for the Dynamic Exposure setting.
2602  *
2603  * @public @memberof GoSetup
2604  * @version Introduced in firmware 4.0.10.27
2605  * @param setup GoSetup object.
2606  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2607  * @param exposure Minumum Dynamic Exposure value (microseconds).
2608  * @return Operation status.
2609  */
2610 GoFx(kStatus) GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure);
2611 
2612 /**
2613  * Gets the minimum valid value for the ActiveAreaHeight setting.
2614  *
2615  * @public @memberof GoSetup
2616  * @version Introduced in firmware 4.0.10.27
2617  * @param setup GoSetup object.
2618  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2619  * @return Minimum valid ActiveAreaHeight value (mm).
2620  */
2621 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role);
2622 
2623 /**
2624  * Gets the maximum valid value for the ActiveAreaHeight setting.
2625  *
2626  * @public @memberof GoSetup
2627  * @version Introduced in firmware 4.0.10.27
2628  * @param setup GoSetup object.
2629  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2630  * @return Maximum valid active area height value (mm).
2631  */
2632 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role);
2633 
2634 /**
2635  * Gets the active area height.
2636  *
2637  * @public @memberof GoSetup
2638  * @version Introduced in firmware 4.0.10.27
2639  * @param setup GoSetup object.
2640  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2641  * @return Active area height (mm).
2642  */
2643 GoFx(k64f) GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role);
2644 
2645 /**
2646  * Sets the active area height.
2647  *
2648  * @public @memberof GoSetup
2649  * @version Introduced in firmware 4.0.10.27
2650  * @param setup GoSetup object.
2651  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2652  * @param value Active area height (mm).
2653  * @return Operation status.
2654  */
2655 GoFx(kStatus) GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value);
2656 
2657 /**
2658  * Gets the minimum valid value for the ActiveAreaLength setting.
2659  *
2660  * @public @memberof GoSetup
2661  * @version Introduced in firmware 4.0.10.27
2662  * @param setup GoSetup object.
2663  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2664  * @return Minimum valid ActiveAreaLength value (mm).
2665  */
2666 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role);
2667 
2668 /**
2669  * Gets the maximum valid value for the ActiveAreaLength setting.
2670  *
2671  * @public @memberof GoSetup
2672  * @version Introduced in firmware 4.0.10.27
2673  * @param setup GoSetup object.
2674  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2675  * @return Maximum valid ActiveAreaLength value (mm).
2676  */
2677 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role);
2678 
2679 /**
2680  * Sets the active area Length.
2681  *
2682  * @public @memberof GoSetup
2683  * @version Introduced in firmware 4.0.10.27
2684  * @param setup GoSetup object.
2685  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2686  * @param value Active area Length (mm).
2687  * @return Operation status.
2688  */
2689 GoFx(kStatus) GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value);
2690 
2691 /**
2692  * Gets the active area Length.
2693  *
2694  * @public @memberof GoSetup
2695  * @version Introduced in firmware 4.0.10.27
2696  * @param setup GoSetup object.
2697  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2698  * @return Active area Length (mm).
2699  */
2700 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
2701 
2702 
2703 /**
2704  * Gets the minimum valid value for the ActiveAreaWidth setting.
2705  *
2706  * @public @memberof GoSetup
2707  * @version Introduced in firmware 4.0.10.27
2708  * @param setup GoSetup object.
2709  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2710  * @return Minimum valid ActiveAreaWidth value (mm).
2711  */
2712 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role);
2713 
2714 /**
2715  * Gets the maximum valid value for the ActiveAreaWidth setting.
2716  *
2717  * @public @memberof GoSetup
2718  * @version Introduced in firmware 4.0.10.27
2719  * @param setup GoSetup object.
2720  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2721  * @return Maximum valid ActiveAreaWidth value (mm).
2722  */
2723 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role);
2724 
2725 /**
2726  * Sets the active area width.
2727  *
2728  * @public @memberof GoSetup
2729  * @version Introduced in firmware 4.0.10.27
2730  * @param setup GoSetup object.
2731  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2732  * @param value Active area width (mm).
2733  * @return Operation status.
2734  */
2735 GoFx(kStatus) GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value);
2736 
2737 /**
2738  * Gets the active area width.
2739  *
2740  * @public @memberof GoSetup
2741  * @version Introduced in firmware 4.0.10.27
2742  * @param setup GoSetup object.
2743  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2744  * @return Active area width (mm).
2745  */
2746 GoFx(k64f) GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role);
2747 
2748 /**
2749  * Gets the minimum valid value for the ActiveAreaX setting.
2750  *
2751  * @public @memberof GoSetup
2752  * @version Introduced in firmware 4.0.10.27
2753  * @param setup GoSetup object.
2754  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2755  * @return Minimum valid ActiveAreaX value (mm).
2756  */
2757 GoFx(k64f) GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role);
2758 
2759 /**
2760  * Gets the maximum valid value for the ActiveAreaX setting.
2761  *
2762  * @public @memberof GoSetup
2763  * @version Introduced in firmware 4.0.10.27
2764  * @param setup GoSetup object.
2765  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2766  * @return Maximum valid ActiveAreaX value (mm).
2767  */
2768 GoFx(k64f) GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role);
2769 
2770 /**
2771  * Sets the active area x origin.
2772  *
2773  * @public @memberof GoSetup
2774  * @version Introduced in firmware 4.0.10.27
2775  * @param setup GoSetup object.
2776  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2777  * @param value Active area x origin (mm).
2778  * @return Operation status.
2779  */
2780 GoFx(kStatus) GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value);
2781 
2782 /**
2783  * Gets the active area x origin.
2784  *
2785  * @public @memberof GoSetup
2786  * @version Introduced in firmware 4.0.10.27
2787  * @param setup GoSetup object.
2788  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2789  * @return Active area x origin (mm).
2790  */
2791 GoFx(k64f) GoSetup_ActiveAreaX(GoSetup setup, GoRole role);
2792 
2793 /**
2794  * Gets the minimum valid value for the ActiveAreaY setting.
2795  *
2796  * @public @memberof GoSetup
2797  * @version Introduced in firmware 4.0.10.27
2798  * @param setup GoSetup object.
2799  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2800  * @return Minimum valid ActiveAreaY value (mm).
2801  */
2802 GoFx(k64f) GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role);
2803 
2804 /**
2805  * Gets the maximum valid value for the ActiveAreaY setting.
2806  *
2807  * @public @memberof GoSetup
2808  * @version Introduced in firmware 4.0.10.27
2809  * @param setup GoSetup object.
2810  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2811  * @return Maximum valid ActiveAreaY value (mm).
2812  */
2813 GoFx(k64f) GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role);
2814 
2815 /**
2816  * Sets the active area Y.
2817  *
2818  * @public @memberof GoSetup
2819  * @version Introduced in firmware 4.0.10.27
2820  * @param setup GoSetup object.
2821  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2822  * @param value Active area y origin (mm).
2823  * @return Operation status.
2824  */
2825 GoFx(kStatus) GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value);
2826 
2827 /**
2828  * Gets the active area Y.
2829  *
2830  * @public @memberof GoSetup
2831  * @version Introduced in firmware 4.0.10.27
2832  * @param setup GoSetup object.
2833  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2834  * @return Active area y origin (mm).
2835  */
2836 GoFx(k64f) GoSetup_ActiveAreaY(GoSetup setup, GoRole role);
2837 
2838 /**
2839  * Gets the minimum valid value for the ActiveAreaZ setting.
2840  *
2841  * @public @memberof GoSetup
2842  * @version Introduced in firmware 4.0.10.27
2843  * @param setup GoSetup object.
2844  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2845  * @return Minimum valid ActiveAreaZ value (mm).
2846  */
2847 GoFx(k64f) GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role);
2848 
2849 /**
2850  * Gets the maximum valid value for the ActiveAreaZ setting.
2851  *
2852  * @public @memberof GoSetup
2853  * @version Introduced in firmware 4.0.10.27
2854  * @param setup GoSetup object.
2855  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2856  * @return Maximum valid ActiveAreaZ value (mm).
2857  */
2858 GoFx(k64f) GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role);
2859 
2860 /**
2861  * Sets the active area z origin.
2862  *
2863  * @public @memberof GoSetup
2864  * @version Introduced in firmware 4.0.10.27
2865  * @param setup GoSetup object.
2866  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2867  * @param value Active area z origin (mm).
2868  * @return Operation status.
2869  */
2870 GoFx(kStatus) GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value);
2871 
2872 /**
2873  * Gets the active area z origin.
2874  *
2875  * @public @memberof GoSetup
2876  * @version Introduced in firmware 4.0.10.27
2877  * @param setup GoSetup object.
2878  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2879  * @return Active area z origin (mm).
2880  */
2881 GoFx(k64f) GoSetup_ActiveAreaZ(GoSetup setup, GoRole role);
2882 
2883 /**
2884  * Gets the transformed data region X value.
2885  *
2886  * @public @memberof GoSetup
2887  * @version Introduced in firmware 4.0.10.27
2888  * @param setup GoSetup object.
2889  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2890  * @return The transformed data region X value.
2891  */
2892 GoFx(k64f) GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role);
2893 
2894 /**
2895  * Gets the transformed data region Y value.
2896  *
2897  * @public @memberof GoSetup
2898  * @version Introduced in firmware 4.0.10.27
2899  * @param setup GoSetup object.
2900  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2901  * @return The transformed data region Y value.
2902  */
2903 GoFx(k64f) GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role);
2904 
2905 /**
2906  * Gets the transformed data region Z value.
2907  *
2908  * @public @memberof GoSetup
2909  * @version Introduced in firmware 4.0.10.27
2910  * @param setup GoSetup object.
2911  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2912  * @return The transformed data region Z value.
2913  */
2914 GoFx(k64f) GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role);
2915 
2916 /**
2917  * Gets the transformed data region width value.
2918  *
2919  * @public @memberof GoSetup
2920  * @version Introduced in firmware 4.0.10.27
2921  * @param setup GoSetup object.
2922  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2923  * @return The transformed data region width value.
2924  */
2925 GoFx(k64f) GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role);
2926 
2927 /**
2928  * Gets the transformed data region length value.
2929  *
2930  * @public @memberof GoSetup
2931  * @version Introduced in firmware 4.0.10.27
2932  * @param setup GoSetup object.
2933  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2934  * @return The transformed data region length value.
2935  */
2936 GoFx(k64f) GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role);
2937 
2938 /**
2939  * Gets the transformed data region height value.
2940  *
2941  * @public @memberof GoSetup
2942  * @version Introduced in firmware 4.0.10.27
2943  * @param setup GoSetup object.
2944  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2945  * @return The transformed data region height value.
2946  */
2947 GoFx(k64f) GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role);
2948 
2949 /**
2950  * Gets the count of valid x-resolution options.
2951  *
2952  * @public @memberof GoSetup
2953  * @version Introduced in firmware 4.0.10.27
2954  * @param setup GoSetup object.
2955  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2956  * @return Count of x-resolution options.
2957  */
2958 GoFx(kSize) GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role);
2959 
2960 /**
2961  * Gets the x-resolution option at the specified index.
2962  *
2963  * @public @memberof GoSetup
2964  * @version Introduced in firmware 4.0.10.27
2965  * @param setup GoSetup object.
2966  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2967  * @param index Index of the desired resolution option.
2968  * @return X resolution option.
2969  * @see GoSetup_XSubsamplingOptionCount
2970  */
2971 GoFx(k32u) GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
2972 
2973 /**
2974  * Sets the current x-resolution divider.
2975  *
2976  * @public @memberof GoSetup
2977  * @version Introduced in firmware 4.0.10.27
2978  * @param setup GoSetup object.
2979  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2980  * @param xSubsampling X subsampling divider (e.g. 1 - full res, 2 - half res).
2981  * @return Operation status.
2982  */
2983 GoFx(kStatus) GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling);
2984 
2985 /**
2986  * Gets the current x-resolution divider.
2987  *
2988  * @public @memberof GoSetup
2989  * @version Introduced in firmware 4.0.10.27
2990  * @param setup GoSetup object.
2991  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
2992  * @return X resolution divider (e.g. 1 - full res, 2 - half res).
2993  */
2994 GoFx(k32u) GoSetup_XSubsampling(GoSetup setup, GoRole role);
2995 
2996 /**
2997  * Gets the count of valid z-resolution options.
2998  *
2999  * @public @memberof GoSetup
3000  * @version Introduced in firmware 4.0.10.27
3001  * @param setup GoSetup object.
3002  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3003  * @return Count of z-resolution options.
3004  */
3005 GoFx(kSize) GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role);
3006 
3007 /**
3008  * Gets the z-resolution option at the specified index.
3009  *
3010  * @public @memberof GoSetup
3011  * @version Introduced in firmware 4.0.10.27
3012  * @param setup GoSetup object.
3013  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3014  * @param index Index of the desired resolution option.
3015  * @return Z resolution option.
3016  * see GoSetup_ZSubsamplingOptionCount
3017  */
3018 GoFx(k32u) GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
3019 
3020 /**
3021  * Sets the current z-resolution divider.
3022  *
3023  * @public @memberof GoSetup
3024  * @version Introduced in firmware 4.0.10.27
3025  * @param setup GoSetup object.
3026  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3027  * @param zSubsampling Z subsampling divider (e.g. 1 - full res, 2 - half res).
3028  * @return Operation status.
3029  */
3030 GoFx(kStatus) GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling);
3031 
3032 /**
3033  * Gets the current z-resolution divider.
3034  *
3035  * @public @memberof GoSetup
3036  * @version Introduced in firmware 4.0.10.27
3037  * @param setup GoSetup object.
3038  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3039  * @return Z resolution divider (e.g. 1 - full res, 2 - half res).
3040  */
3041 GoFx(k32u) GoSetup_ZSubsampling(GoSetup setup, GoRole role);
3042 
3043 /**
3044  * Gets the camera region-of-interest x origin.
3045  *
3046  * @public @memberof GoSetup
3047  * @version Introduced in firmware 4.0.10.27
3048  * @param setup GoSetup object.
3049  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3050  * @return Region of interest x origin (pixels).
3051  */
3052 GoFx(k32u) GoSetup_FrontCameraX(GoSetup setup, GoRole role);
3053 
3054 /**
3055  * Gets the camera region-of-interest y origin.
3056  *
3057  * @public @memberof GoSetup
3058  * @version Introduced in firmware 4.0.10.27
3059  * @param setup GoSetup object.
3060  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3061  * @return Region of interest y origin (pixels).
3062  */
3063 GoFx(k32u) GoSetup_FrontCameraY(GoSetup setup, GoRole role);
3064 
3065 /**
3066  * Gets the camera region-of-interest width.
3067  *
3068  * @public @memberof GoSetup
3069  * @version Introduced in firmware 4.0.10.27
3070  * @param setup GoSetup object.
3071  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3072  * @return Region of interest width (pixels).
3073  */
3074 GoFx(k32u) GoSetup_FrontCameraWidth(GoSetup setup, GoRole role);
3075 
3076 /**
3077  * Gets the camera region-of-interest height.
3078  *
3079  * @public @memberof GoSetup
3080  * @version Introduced in firmware 4.0.10.27
3081  * @param setup GoSetup object.
3082  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3083  * @return Region of interest height (pixels).
3084  */
3085 GoFx(k32u) GoSetup_FrontCameraHeight(GoSetup setup, GoRole role);
3086 
3087 /**
3088  * Returns a boolean representing whether the back camera element is used.
3089  *
3090  * @public @memberof GoSetup
3091  * @version Introduced in firmware 4.1.3.106
3092  * @param setup GoSetup object.
3093  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3094  * @return kTRUE if used, or kFALSE if not used.
3095  */
3096 GoFx(k32u) GoSetup_BackCameraUsed(GoSetup setup, GoRole role);
3097 
3098 /**
3099  * Gets the camera region-of-interest x origin.
3100  *
3101  * @public @memberof GoSetup
3102  * @version Introduced in firmware 4.0.10.27
3103  * @param setup GoSetup object.
3104  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3105  * @return Region of interest x origin (pixels).
3106  */
3107 GoFx(k32u) GoSetup_BackCameraX(GoSetup setup, GoRole role);
3108 
3109 /**
3110  * Gets the camera region-of-interest y origin.
3111  *
3112  * @public @memberof GoSetup
3113  * @version Introduced in firmware 4.0.10.27
3114  * @param setup GoSetup object.
3115  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3116  * @return Region of interest y origin (pixels).
3117  */
3118 GoFx(k32u) GoSetup_BackCameraY(GoSetup setup, GoRole role);
3119 
3120 /**
3121  * Gets the camera region-of-interest width.
3122  *
3123  * @public @memberof GoSetup
3124  * @version Introduced in firmware 4.0.10.27
3125  * @param setup GoSetup object.
3126  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3127  * @return Region of interest width (pixels).
3128  */
3129 GoFx(k32u) GoSetup_BackCameraWidth(GoSetup setup, GoRole role);
3130 
3131 /**
3132  * Gets the camera region-of-interest height.
3133  *
3134  * @public @memberof GoSetup
3135  * @version Introduced in firmware 4.0.10.27
3136  * @param setup GoSetup object.
3137  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3138  * @return Region of interest height (pixels).
3139  */
3140 GoFx(k32u) GoSetup_BackCameraHeight(GoSetup setup, GoRole role);
3141 
3142 /**
3143  * Enables tracking.
3144  *
3145  * @public @memberof GoSetup
3146  * @version Introduced in firmware 4.0.10.27
3147  * @param setup GoSetup object.
3148  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3149  * @param enable kTRUE to enable, or kFALSE to disable.
3150  * @return Operation status.
3151  */
3152 GoFx(kStatus) GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable);
3153 
3154 /**
3155  * Determines if tracking is enabled.
3156  *
3157  * @public @memberof GoSetup
3158  * @version Introduced in firmware 4.0.10.27
3159  * @param setup GoSetup object.
3160  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3161  * @return kTRUE if enabled, or kFALSE if disabled.
3162  */
3163 GoFx(kBool) GoSetup_TrackingEnabled(GoSetup setup, GoRole role);
3164 
3165 /**
3166  * Returns a boolean value representing whether the Tracking Enabled field is used.
3167  *
3168  * @public @memberof GoSetup
3169  * @version Introduced in firmware 4.1.3.106
3170  * @param setup GoSetup object.
3171  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3172  * @return kTRUE if used, or kFALSE if not used.
3173  */
3174 GoFx(kBool) GoSetup_TrackingUsed(GoSetup setup, GoRole role);
3175 
3176 /**
3177  * Sets the tracking window height.
3178  *
3179  * @public @memberof GoSetup
3180  * @version Introduced in firmware 4.0.10.27
3181  * @param setup GoSetup object.
3182  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3183  * @param height Tracking window height (mm).
3184  * @return Operation status.
3185  */
3186 GoFx(kStatus) GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height);
3187 
3188 /**
3189  * Gets the tracking window height.
3190  *
3191  * @public @memberof GoSetup
3192  * @version Introduced in firmware 4.0.10.27
3193  * @param setup GoSetup object.
3194  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3195  * @return Tracking window height (mm).
3196  */
3197 GoFx(k64f) GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role);
3198 
3199 /**
3200  * Gets the tracking window height minimum limit.
3201  *
3202  * @public @memberof GoSetup
3203  * @version Introduced in firmware 4.0.10.27
3204  * @param setup GoSetup object.
3205  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3206  * @return Tracking window height min(mm).
3207  */
3208 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role);
3209 
3210 /**
3211  * Gets the tracking window height maximum limit.
3212  *
3213  * @public @memberof GoSetup
3214  * @version Introduced in firmware 4.0.10.27
3215  * @param setup GoSetup object.
3216  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3217  * @return Tracking window height max(mm).
3218  */
3219 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role);
3220 
3221 /**
3222  * Sets the tracking window search threshold.
3223  *
3224  * @public @memberof GoSetup
3225  * @version Introduced in firmware 4.0.10.27
3226  * @param setup GoSetup object.
3227  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3228  * @param threshold Tracking window search threshold (%)
3229  * @return Operation status.
3230  */
3231 GoFx(kStatus) GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold);
3232 
3233 /**
3234  * Gets the tracking window search threshold.
3235  *
3236  * @public @memberof GoSetup
3237  * @version Introduced in firmware 4.0.10.27
3238  * @param setup GoSetup object.
3239  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3240  * @return Tracking window search threshold (%).
3241  */
3242 GoFx(k64f) GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role);
3243 
3244 /**
3245  * Returns the state of whether the user specified spacing interval is used.
3246  *
3247  * @public @memberof GoSetup
3248  * @version Introduced in firmware 4.0.10.27
3249  * @param setup GoSetup object.
3250  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3251  * @return kTRUE if the user value is used and kFALSE otherwise.
3252  */
3253 GoFx(kBool) GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role);
3254 
3255 /**
3256  * Gets the spacing interval system value.
3257  *
3258  * @public @memberof GoSetup
3259  * @version Introduced in firmware 4.0.10.27
3260  * @param setup GoSetup object.
3261  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3262  * @return Spacing interval.
3263  */
3264 GoFx(k64f) GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role);
3265 
3266 /**
3267  * Gets the spacing interval.
3268  *
3269  * @public @memberof GoSetup
3270  * @version Introduced in firmware 4.0.10.27
3271  * @param setup GoSetup object.
3272  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3273  * @return Spacing interval.
3274  */
3275 GoFx(k64f) GoSetup_SpacingInterval(GoSetup setup, GoRole role);
3276 
3277 /**
3278  * Sets the spacing interval.
3279  *
3280  * @public @memberof GoSetup
3281  * @note Supported with G3
3282  * @version Introduced in firmware 4.0.10.27
3283  * @param setup GoSetup object.
3284  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3285  * @param value The spacing interval.
3286  * @return Operation status.
3287  */
3288 GoFx(kStatus) GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value);
3289 
3290 /**
3291  * Gets the spacing interval value limit minimum.
3292  *
3293  * @public @memberof GoSetup
3294  * @version Introduced in firmware 4.0.10.27
3295  * @param setup GoSetup object.
3296  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3297  * @return Spacing interval value limit minimum.
3298  */
3299 GoFx(k64f) GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role);
3300 
3301 /**
3302  * Gets the spacing interval value limit maximum
3303  *
3304  * @public @memberof GoSetup
3305  * @version Introduced in firmware 4.0.10.27
3306  * @param setup GoSetup object.
3307  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3308  * @return Spacing interval value limit maximum.
3309  */
3310 GoFx(k64f) GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role);
3311 
3312 /**
3313  * Gets the spacing interval type.
3314  *
3315  * @public @memberof GoSetup
3316  * @version Introduced in firmware 4.0.10.27
3317  * @param setup GoSetup object.
3318  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3319  * @return The spacing interval type.
3320  */
3321 GoFx(GoSpacingIntervalType) GoSetup_SpacingIntervalType(GoSetup setup, GoRole role);
3322 
3323 /**
3324  * Sets the spacing interval type.
3325  *
3326  * @public @memberof GoSetup
3327  * @version Introduced in firmware 4.0.10.27
3328  * @param setup GoSetup object.
3329  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3330  * @param type The spacing interval type.
3331  * @return Operation status.
3332  */
3333 GoFx(kStatus) GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type);
3334 
3335 /**
3336  * Gets the system value representing whether or not the user specified spacing interval type setting is being used at the moment.
3337  *
3338  * @public @memberof GoSetup
3339  * @version Introduced in firmware 4.0.10.27
3340  * @param setup GoSetup object.
3341  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3342  * @return kTRUE if the user specified spacing interval type setting is used and kFALSE otherwise.
3343  */
3344 GoFx(kBool) GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role);
3345 
3346 /**
3347  * Gets the X spacing count.
3348  *
3349  * @public @memberof GoSetup
3350  * @version Introduced in firmware 4.0.10.27
3351  * @param setup GoSetup object.
3352  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3353  * @return X spacing count.
3354  */
3355 GoFx(k32u) GoSetup_XSpacingCount(GoSetup setup, GoRole role);
3356 
3357 /**
3358  * Gets the Y spacing count.
3359  *
3360  * @public @memberof GoSetup
3361  * @version Introduced in firmware 4.0.10.27
3362  * @param setup GoSetup object.
3363  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3364  * @return Y spacing count.
3365  */
3366 GoFx(k32u) GoSetup_YSpacingCount(GoSetup setup, GoRole role);
3367 
3368 /**
3369  * Gets the intensity step index.
3370  *
3371  * @public @memberof GoSetup
3372  * @version Introduced in firmware 4.0.10.27
3373  * @param setup GoSetup object.
3374  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3375  * @return The intensity step index.
3376  */
3377 GoFx(kSize) GoSetup_IntensityStepIndex(GoSetup setup, GoRole role);
3378 
3379 /**
3380  * Sets the intensity step index.
3381  *
3382  * @public @memberof GoSetup
3383  * @version Introduced in firmware 4.0.10.27
3384  * @param setup GoSetup object.
3385  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3386  * @param index The exposure step index to use for intensity acquisition.
3387  * @return Operation status.
3388  * @see GoSetup_SetExposureMode, GoSetup_ExposureStepCount
3389  */
3390 GoFx(kStatus) GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index);
3391 
3392 /**
3393  * Gets the pattern sequence type option count.
3394  *
3395  * @public @memberof GoSetup
3396  * @version Introduced in firmware 4.2.4.7
3397  * @param setup GoSetup object.
3398  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3399  * @return Pattern sequence type option count.
3400  */
3401 GoFx(kSize) GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role);
3402 
3403 /**
3404  * Gets the pattern sequence type option at the given index.
3405  *
3406  * @public @memberof GoSetup
3407  * @version Introduced in firmware 4.2.4.7
3408  * @param setup GoSetup object.
3409  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3410  * @param index The index with which to retrieve a sequence type option.
3411  * @return A sequence type option value.
3412  * @see GoSetup_PatternSequenceOptionCount
3413  */
3414 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index);
3415 
3416 /**
3417  * Gets the pattern sequence type.
3418  *
3419  * @public @memberof GoSetup
3420  * @version Introduced in firmware 4.2.4.7
3421  * @param setup GoSetup object.
3422  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3423  * @return The pattern sequence type.
3424  */
3425 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceType(GoSetup setup, GoRole role);
3426 
3427 /**
3428  * Sets the pattern sequence type.
3429  *
3430  * @public @memberof GoSetup
3431  * @version Introduced in firmware 4.2.4.7
3432  * @param setup GoSetup object.
3433  * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3434  * @param type The pattern sequence type to set.
3435  * @return Operation status.
3436  */
3437 GoFx(kStatus) GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type);
3438 
3439 /**
3440  * Returns a boolean value representing whether the pattern sequence type is used.
3441  *
3442  * @public @memberof GoSetup
3443  * @version Introduced in firmware 4.2.4.7
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 kTRUE if used and kFALSE otherwise.
3447  */
3448 GoFx(kBool) GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role);
3449 
3450 /**
3451  * Gets the current pattern sequence count.
3452  *
3453  * @public @memberof GoSetup
3454  * @version Introduced in firmware 4.2.4.7
3455  * @param setup GoSetup object.
3456  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3457  * @return The current pattern sequence count.
3458  */
3459 GoFx(kSize) GoSetup_PatternSequenceCount(GoSetup setup, GoRole role);
3460 
3461 /**
3462  * Gets the current phase pattern index.
3463  *
3464  * @public @memberof GoSetup
3465  * @version Introduced in firmware 5.3.19.50
3466  * @param setup GoSetup object.
3467  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3468  * @return The current phase pattern index.
3469  */
3470 GoFx(k32u) GoSetup_PatternSequenceIndex(GoSetup setup, GoRole role);
3471 
3472 /**
3473  * Sets the current phase pattern index.
3474  *
3475  * @public @memberof GoSetup
3476  * @version Introduced in firmware 5.3.19.50
3477  * @param setup GoSetup object.
3478  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3479  * @param index The index to use
3480  */
3481 GoFx(kStatus) GoSetup_SetPatternSequenceIndex(GoSetup setup, GoRole role, k32u index);
3482 
3483 /**
3484  * Gets the current phase pattern index used flag value.
3485  *
3486  * @public @memberof GoSetup
3487  * @version Introduced in firmware 5.3.19.50
3488  * @param setup GoSetup object.
3489  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3490  * @return The current phase pattern index used flag value.
3491  */
3492 GoFx(kBool) GoSetup_PatternSequenceIndexUsed(GoSetup setup, GoRole role);
3493 
3494 /**
3495  * Gets the current phase pattern index min value (inclusive).
3496  *
3497  * @public @memberof GoSetup
3498  * @version Introduced in firmware 5.3.19.50
3499  * @param setup GoSetup object.
3500  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3501  * @return The current phase pattern index minimum value (inclusive).
3502  */
3503 GoFx(k32u) GoSetup_PatternSequenceIndexMin(GoSetup setup, GoRole role);
3504 
3505 /**
3506  * Gets the current phase pattern index maximum value (inclusive).
3507  *
3508  * @public @memberof GoSetup
3509  * @version Introduced in firmware 5.3.19.50
3510  * @param setup GoSetup object.
3511  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3512  * @return The current phase pattern index maximum value (inclusive).
3513  */
3514 GoFx(k32u) GoSetup_PatternSequenceIndexMax(GoSetup setup, GoRole role);
3515 
3516 
3517 /**
3518  * Gets the layout configuration module.
3519  *
3520  * @public @memberof GoSetup
3521  * @version Introduced in firmware 4.0.10.27
3522  * @param setup GoSetup object.
3523  * @return Layout configuration module.
3524  */
3525 GoFx(GoLayout) GoSetup_Layout(GoSetup setup);
3526 
3527 /**
3528  * Gets the profile generation module, used for profile generation configuration.
3529  *
3530  * @public @memberof GoSetup
3531  * @version Introduced in firmware 4.2.4.7
3532  * @param setup GoSetup object.
3533  * @return Profile generation configuration module.
3534  */
3535 GoFx(GoProfileGeneration) GoSetup_ProfileGeneration(GoSetup setup);
3536 
3537 /**
3538  * Gets the surface generation module, used for surface generation configuration.
3539  *
3540  * @public @memberof GoSetup
3541  * @version Introduced in firmware 4.0.10.27
3542  * @param setup GoSetup object.
3543  * @return Surface generation configuration module.
3544  */
3545 GoFx(GoSurfaceGeneration) GoSetup_SurfaceGeneration(GoSetup setup);
3546 
3547 /**
3548  * Gets the part detection module, used for part detection configuration.
3549  *
3550  * @public @memberof GoSetup
3551  * @version Introduced in firmware 4.0.10.27
3552  * @param setup GoSetup object.
3553  * @return Part detection configuration module.
3554  */
3555 GoFx(GoPartDetection) GoSetup_PartDetection(GoSetup setup);
3556 
3557 /**
3558  * Gets the part matching module, used for part matching configuration.
3559  *
3560  * @public @memberof GoSetup
3561  * @version Introduced in firmware 4.2.4.7
3562  * @param setup GoSetup object.
3563  * @return Part matching configuration module.
3564  */
3565 GoFx(GoPartMatching) GoSetup_PartMatching(GoSetup setup);
3566 
3567 /**
3568 * Gets the advanced acquisition module, used for advanced acquisition configuration.
3569 *
3570 * @public @memberof GoSetup
3571 * @version Introduced in firmware 4.6
3572 * @param setup GoSetup object.
3573 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3574 * @return Advanced acquisition configuration module.
3575 */
3576 GoFx(GoAdvanced) GoSetup_Advanced(GoSetup setup, GoRole role);
3577 
3578 /**
3579  * @deprecated Gets the material acquisition module, used for material acquisition configuration.
3580  *
3581  * @public @memberof GoSetup
3582  * @version Introduced in firmware 4.1.3.106
3583  * @param setup GoSetup object.
3584  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3585  * @return Material acquisition configuration module.
3586  */
3587 GoFx(GoMaterial) GoSetup_Material(GoSetup setup, GoRole role);
3588 
3589 /**
3590  * Gets the Section configuration module, used for surface sections.
3591  *
3592  * @public @memberof GoSetup
3593  * @version Introduced in firmware 4.4.4.14
3594  * @param setup GoSetup object.
3595  * @return Section configuration module.
3596  */
3597 GoFx(GoSections) GoSetup_Sections(GoSetup setup);
3598 
3599 /**
3600  * Gets the tracheid configuration module.
3601  *
3602  * @public @memberof GoSetup
3603  * @version Introduced in firmware 4.5.3.57
3604  * @param setup GoSetup object.
3605  * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3606  * @return Tracheid configuration module.
3607  */
3608 GoFx(GoTracheid) GoSetup_Tracheid(GoSetup setup, GoRole role);
3609 
3610 /**
3611 * Returns a boolean value representing the state of the independent exposures used field.
3612 * If this feature is available, it will use the exposure values and limits assigned to
3613 * both the front and back cameras.
3614 *
3615 * @public @memberof GoSetup
3616 * @version Introduced in firmware 4.6.0.140
3617 * @param setup GoSetup object.
3618 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3619 * @return kTRUE if used, or kFALSE if not used.
3620 */
3621 GoFx(kBool) GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role);
3622 
3623 /**
3624 * Enables independent exposures feature, i.e. separate exposures
3625 * for separate cameras.
3626 *
3627 * @public @memberof GoSetup
3628 * @version Introduced in firmware 4.6.0.140
3629 * @param setup GoSetup object.
3630 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3631 * @param enable kTRUE to enable, or kFALSE to disable.
3632 * @return Operation status.
3633 */
3634 GoFx(kStatus) GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable);
3635 
3636 /**
3637 * Determines if independent exposures feature is enabled.
3638 *
3639 * @public @memberof GoSetup
3640 * @version Introduced in firmware 4.6.0.140
3641 * @param setup GoSetup object.
3642 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3643 * @return kTRUE if enabled, or kFALSE if disabled.
3644 */
3645 GoFx(kBool) GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role);
3646 
3647 /**
3648 * Gets the maximum valid value for the front camera exposure setting.
3649 *
3650 * @public @memberof GoSetup
3651 * @version Introduced in firmware 4.6.0.140
3652 * @param setup GoSetup object.
3653 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3654 * @return Maximum valid auxiliary exposure value (microseconds).
3655 */
3656 GoFx(k64f) GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role);
3657 
3658 /**
3659 * Gets the minimum valid value for the front camara exposure setting.
3660 *
3661 * @public @memberof GoSetup
3662 * @version Introduced in firmware 4.6.0.140
3663 * @param setup GoSetup object.
3664 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3665 * @return Minimum valid auxiliary exposure value (microseconds).
3666 */
3667 GoFx(k64f) GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role);
3668 
3669 /**
3670 * Sets the front camera exposure value.
3671 *
3672 * @public @memberof GoSetup
3673 * @version Introduced in firmware 4.6.0.140
3674 * @param setup GoSetup object.
3675 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3676 * @param exposure Intended auxiliary exposure value.
3677 * @return Operation status.
3678 */
3679 GoFx(kStatus) GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure);
3680 
3681 /**
3682 * Gets the front camera exposure value.
3683 *
3684 * @public @memberof GoSetup
3685 * @version Introduced in firmware 4.6.0.140
3686 * @param setup GoSetup object.
3687 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3688 * @return Auxiliary exposure value (microseconds).
3689 */
3690 GoFx(k64f) GoSetup_FrontCameraExposure(GoSetup setup, GoRole role);
3691 
3692 /**
3693 * Gets the maximum valid value for the back camera exposure setting.
3694 *
3695 * @public @memberof GoSetup
3696 * @version Introduced in firmware 4.6.0.140
3697 * @param setup GoSetup object.
3698 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3699 * @return Maximum valid auxiliary exposure value (microseconds).
3700 */
3701 GoFx(k64f) GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role);
3702 
3703 /**
3704 * Gets the minimum valid value for the back camara exposure setting.
3705 *
3706 * @public @memberof GoSetup
3707 * @version Introduced in firmware 4.6.0.140
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 Minimum valid auxiliary exposure value (microseconds).
3711 */
3712 GoFx(k64f) GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role);
3713 
3714 /**
3715 * Sets the back camera exposure value.
3716 *
3717 * @public @memberof GoSetup
3718 * @version Introduced in firmware 4.6.0.140
3719 * @param setup GoSetup object.
3720 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3721 * @param exposure Intended auxiliary exposure value.
3722 * @return Operation status.
3723 */
3724 GoFx(kStatus) GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure);
3725 
3726 /**
3727 * Gets the back camera exposure value.
3728 *
3729 * @public @memberof GoSetup
3730 * @version Introduced in firmware 4.6.0.140
3731 * @param setup GoSetup object.
3732 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3733 * @return Auxiliary exposure value (microseconds).
3734 */
3735 GoFx(k64f) GoSetup_BackCameraExposure(GoSetup setup, GoRole role);
3736 
3737 /**
3738 * Gets the source used for generating intensity data.
3739 *
3740 * @public @memberof GoSetup
3741 * @version Introduced in firmware 4.6.0.152
3742 * @param setup GoSetup object.
3743 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3744 * @return Source of intensity data.
3745 */
3746 GoFx(GoIntensitySource) GoSetup_IntensitySource(GoSetup setup, GoRole role);
3747 
3748 /**
3749 * Sets the source to be used for generating intensity data.
3750 *
3751 * @public @memberof GoSetup
3752 * @version Introduced in firmware 4.6.0.152
3753 * @param setup GoSetup object.
3754 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3755 * @param source The source to be used.
3756 * @return Operation status.
3757 */
3758 GoFx(kStatus) GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source);
3759 
3760 /**
3761 * Gets the intensity data generation mode.
3762 *
3763 * @public @memberof GoSetup
3764 * @version Introduced in firmware 4.7.10.10
3765 * @param setup GoSetup object.
3766 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3767 * @return Intensity generation mode.
3768 */
3769 GoFx(GoIntensityMode) GoSetup_IntensityMode(GoSetup setup, GoRole role);
3770 
3771 /**
3772 * Sets the intensity data generation mode.
3773 *
3774 * @public @memberof GoSetup
3775 * @version Introduced in firmware 4.7.10.10
3776 * @param setup GoSetup object.
3777 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3778 * @param mode Intensity generation mode.
3779 * @return Operation status.
3780 */
3781 GoFx(kStatus) GoSetup_SetIntensityMode(GoSetup setup, GoRole role, GoIntensityMode mode);
3782 
3783 /**
3784 * Gets the availability of the intensity mode property.
3785 *
3786 * @public @memberof GoSetup
3787 * @version Introduced in firmware 4.7.10.10
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 * @return kTRUE if available and kFALSE otherwise.
3791 */
3792 GoFx(kBool) GoSetup_IntensityModeUsed(GoSetup setup, GoRole role);
3793 
3794 /**
3795 * Gets the intensity source option at the given index.
3796 *
3797 * @public @memberof GoSetup
3798 * @version Introduced in firmware 4.6.0.152
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 * @param index The index with which to retrieve an exposure mode option.
3802 * @return Intensity source set.
3803 * @see GoSetup_IntensitySourceOptionCount
3804 */
3805 GoFx(GoIntensitySource) GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index);
3806 
3807 /**
3808 * Gets the intensity source option count.
3809 *
3810 * @public @memberof GoSetup
3811 * @version Introduced in firmware 4.6.0.152
3812 * @param setup GoSetup object.
3813 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3814 * @return Intensity source option count.
3815 */
3816 GoFx(kSize) GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role);
3817 
3818 /**
3819 * Gets layout grid used state.
3820 *
3821 * @public @memberof GoSetup
3822 * @version Introduced in firmware 4.0.10.27
3823 * @param setup GoSetup object.
3824 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3825 * @return Whether grid is used in n-buddy system.
3826 */
3827 GoFx(kBool) GoSetup_LayoutGridUsed(GoSetup setup, GoRole role);
3828 
3829 /**
3830 * Gets layout grid direction system value being used on device in n-buddy system.
3831 *
3832 * @public @memberof GoSetup
3833 * @version Introduced in firmware 4.0.10.27
3834 * @param setup GoSetup object.
3835 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3836 * @return Whether grid direction is reversed system value.
3837 */
3838 GoFx(kBool) GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role);
3839 
3840 /**
3841 * Gets layout grid direction being configured (may not be applicable or used) on device in n-buddy system.
3842 *
3843 * @public @memberof GoSetup
3844  * @version Introduced in firmware 5.3.22.15
3845 * @param setup GoSetup object.
3846 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3847 * @return Whether grid direction is reversed.
3848 */
3849 GoFx(kBool) GoSetup_LayoutGridDirection(GoSetup setup, GoRole role);
3850 
3851 /**
3852 * Sets grid direction being configured (may not be applicable or used) on device in n-buddy system.
3853 *
3854 * @public @memberof GoSetup
3855  * @version Introduced in firmware 5.3.22.15
3856 * @param setup GoSetup object.
3857 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3858 * @param value Whether grid direction is reversed.
3859 * @return Operation status.
3860 */
3861 GoFx(kStatus) GoSetup_SetLayoutGridDirection(GoSetup setup, GoRole role, kBool value);
3862 
3863 /**
3864 * Gets column index system value being used on device in n-buddy system.
3865 *
3866 * @public @memberof GoSetup
3867 * @version Introduced in firmware 4.0.10.27
3868 * @param setup GoSetup object.
3869 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3870 * @return Layout grid column system value.
3871 */
3872 GoFx(k32s) GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role);
3873 
3874 /**
3875 * Gets column index being configured (may not be applicable or used) on device in n-buddy system.
3876 *
3877 * @public @memberof GoSetup
3878  * @version Introduced in firmware 5.3.22.15
3879 * @param setup GoSetup object.
3880 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3881 * @return column index.
3882 */
3883 GoFx(k32s) GoSetup_LayoutGridColumn(GoSetup setup, GoRole role);
3884 
3885 /**
3886 * Sets column index being configured (may not be applicable or used) on device in n-buddy system.
3887 *
3888 * @public @memberof GoSetup
3889  * @version Introduced in firmware 5.3.22.15
3890 * @param setup GoSetup object.
3891 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3892 * @param value Column index.
3893 * @return Operation status.
3894 */
3895 GoFx(kStatus) GoSetup_SetLayoutGridColumn(GoSetup setup, GoRole role, k32s value);
3896 
3897 /**
3898 * Gets row index system value being used on device in n-buddy system.
3899 *
3900 * @public @memberof GoSetup
3901 * @version Introduced in firmware 4.0.10.27
3902 * @param setup GoSetup object.
3903 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3904 * @return Layout grid row system value.
3905 */
3906 GoFx(k32s) GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role);
3907 
3908 /**
3909 * Gets row index being configured (may not be applicable or used) on device in n-buddy system.
3910 *
3911 * @public @memberof GoSetup
3912  * @version Introduced in firmware 5.3.22.15
3913 * @param setup GoSetup object.
3914 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3915 * @return row index.
3916 */
3917 GoFx(k32s) GoSetup_LayoutGridRow(GoSetup setup, GoRole role);
3918 
3919 /**
3920 * Sets row index being configured (may not be applicable or used) on device in n-buddy system.
3921 *
3922 * @public @memberof GoSetup
3923  * @version Introduced in firmware 5.3.22.15
3924 * @param setup GoSetup object.
3925 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3926 * @param value row index.
3927 * @return Operation status.
3928 */
3929 GoFx(kStatus) GoSetup_SetLayoutGridRow(GoSetup setup, GoRole role, k32s value);
3930 
3931 /**
3932 * Gets Multiplexing bank used state in n-buddy system.
3933 *
3934 * @public @memberof GoSetup
3935 * @version Introduced in firmware 4.0.10.27
3936 * @param setup GoSetup object.
3937 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3938 * @return Whether multiplexing bank is used.
3939 */
3940 GoFx(kBool) GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role);
3941 
3942 /**
3943 * Gets Multiplex bank system value being used on device in n-buddy system.
3944 *
3945 * @public @memberof GoSetup
3946 * @version Introduced in firmware 4.0.10.27
3947 * @param setup GoSetup object.
3948 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3949 * @return Multiplexing bank value system value.
3950 */
3951 GoFx(k32u) GoSetup_LayoutMultiplexingBankSystemValue(GoSetup setup, GoRole role);
3952 
3953 /**
3954 * Gets Multiplex bank value being configured (may not be applicable or used) on device in n-buddy system.
3955 *
3956 * @public @memberof GoSetup
3957  * @version Introduced in firmware 5.3.22.15
3958 * @param setup GoSetup object.
3959 * @param role Determines which device to retrieve the value from. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3960 * @return Multiplexing bank value.
3961 */
3962 GoFx(k32u) GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role);
3963 
3964 /**
3965 * Sets multiplexing bank value being configured (may not be applicable or used) on device in n-buddy system.
3966 *
3967 * @public @memberof GoSetup
3968  * @version Introduced in firmware 5.3.22.15
3969 * @param setup GoSetup object.
3970 * @param role Determines which device to apply changes to. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx). See GoRole for more details.
3971 * @param value Multiplexing bank value.
3972 * @return Operation status.
3973 */
3974 GoFx(kStatus) GoSetup_SetLayoutMultiplexingBank(GoSetup setup, GoRole role, k32u value);
3975 
3976 #include <GoSdk/GoSetup.x.h>
3977 
3978 #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_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_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_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...
GoSetup::GoSetup_PatternSequenceTypeOptionCount
kSize GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role)
Gets the pattern sequence type option count.
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.
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
Represents configurable material acquisition settings.
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_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_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_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_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)
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.
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_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_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:570
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_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_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_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_SetFrontCameraExposure
kStatus GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the front camera exposure value.
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_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.
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.