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