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 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/GoMaterial.h>
16 #include <GoSdk/GoProfileGeneration.h>
17 #include <GoSdk/GoSurfaceGeneration.h>
18 #include <GoSdk/GoPartDetection.h>
19 #include <GoSdk/GoPartMatching.h>
20 #include <GoSdk/GoSections.h>
21 #include <GoSdk/GoTracheid.h>
22 
23 kBeginHeader()
24 
25 /**
26  * @class GoSetup
27  * @extends kObject
28  * @ingroup GoSdk
29  * @brief Represents a device configuration.
30  */
31 typedef kObject GoSetup;
32 
33 /**
34  * Sets the default operation mode of the sensor system.
35  *
36  * @public @memberof GoSetup
37  * @version Introduced in firmware 4.0.10.27
38  * @param setup GoSetup object.
39  * @param mode Operation mode.
40  * @return Operation status.
41  */
42 GoFx(kStatus) GoSetup_SetScanMode(GoSetup setup, GoMode mode);
43 
44 /**
45  * Gets the default operation mode of the sensor system.
46  *
47  * @public @memberof GoSetup
48  * @version Introduced in firmware 4.0.10.27
49  * @param setup GoSetup object.
50  * @return Operation mode.
51  */
52 GoFx(GoMode) GoSetup_ScanMode(GoSetup setup);
53 
54 /**
55  * Gets the scan mode option at the specified index.
56  *
57  * @public @memberof GoSetup
58  * @version Introduced in firmware 4.0.10.27
59  * @param setup GoSetup object.
60  * @param index The index with which to retrieve a mode option.
61  * @return Operation mode.
62  * @see GoSetup_ScanModeOptionCount
63  */
64 GoFx(GoMode) GoSetup_ScanModeOptionAt(GoSetup setup, kSize index);
65 
66 /**
67  * Gets the scan mode option count.
68  *
69  * @public @memberof GoSetup
70  * @version Introduced in firmware 4.0.10.27
71  * @param setup GoSetup object.
72  * @return Scan mode option count.
73  */
74 GoFx(kSize) GoSetup_ScanModeOptionCount(GoSetup setup);
75 
76 /// @cond Gocator_2x00
77 
78 /**
79  * Gets the user specified Uniform Spacing enabled state.
80  *
81  * @public @memberof GoSetup
82  * @version Introduced in firmware 4.0.10.27
83  * @param setup GoSetup object.
84  * @return kTRUE if enabled and kFALSE otherwise.
85  * @see GoSetup_UniformSpacingAvailable
86  */
87 GoFx(kBool) GoSetup_UniformSpacingEnabled(GoSetup setup);
88 
89 /**
90  * Sets the user specified Uniform Spacing enabled state.
91  *
92  * @public @memberof GoSetup
93  * @version Introduced in firmware 4.0.10.27
94  * @param setup GoSetup object.
95  * @param enable kTRUE to enable it and kFALSE to disable it.
96  * @return Operation status.
97  * @see GoSetup_UniformSpacingAvailable
98  */
99 GoFx(kStatus) GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable);
100 
101 /**
102  * Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used at the moment.
103  *
104  * @public @memberof GoSetup
105  * @version Introduced in firmware 4.0.10.27
106  * @param setup GoSetup object.
107  * @return kTRUE if the user specified Uniform Spacing setting is used and kFALSE otherwise.
108  */
109 GoFx(kBool) GoSetup_UniformSpacingAvailable(GoSetup setup);
110 
111 /**
112  * Gets the Uniform Spacing enabled system value.
113  *
114  * @public @memberof GoSetup
115  * @version Introduced in firmware 4.0.10.27
116  * @param setup GoSetup object.
117  * @return kTRUE if enabled and kFALSE otherwise.
118  * @see GoSetup_UniformSpacingAvailable
119  */
120 GoFx(kBool) GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup);
121 
122 /// @endcond
123 
124 /**
125  * Sets the state of the external input triggered encoder Z-pulse feature.
126  *
127  * @public @memberof GoSetup
128  * @version Introduced in firmware 4.1.3.106
129  * @param setup GoSetup object.
130  * @param enable kTRUE to enable it and kFALSE to disable it.
131  * @return Operation status.
132  */
133 GoFx(kStatus) GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable);
134 
135 /**
136  * Gets the state of the external input triggered encoder Z-pulse feature.
137  *
138  * @public @memberof GoSetup
139  * @version Introduced in firmware 4.1.3.106
140  * @param setup GoSetup object.
141  * @return kTRUE if enabled and kFALSE otherwise.
142  */
143 GoFx(kBool) GoSetup_ExternalInputZPulseEnabled(GoSetup setup);
144 
145 /**
146  * Gets the occlusion reduction enabled state.
147  *
148  * @public @memberof GoSetup
149  * @version Introduced in firmware 4.0.10.27
150  * @param setup GoSetup object.
151  * @return kTRUE if enabled and kFALSE otherwise.
152  */
153 GoFx(kBool) GoSetup_OcclusionReductionEnabled(GoSetup setup);
154 
155 /**
156  * Sets the occlusion reduction enabled state.
157  *
158  * @public @memberof GoSetup
159  * @version Introduced in firmware 4.0.10.27
160  * @param setup GoSetup object.
161  * @param enable kTRUE to enable it and kFALSE to disable it.
162  * @return Operation status.
163  */
164 GoFx(kStatus) GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable);
165 
166 /**
167  * Returns a boolean representing whether the user occlusion reduction configuration is used.
168  *
169  * @public @memberof GoSetup
170  * @version Introduced in firmware 4.3.3.124
171  * @param setup GoSetup object.
172  * @return kTRUE if used, or kFALSE if not used.
173  */
174 GoFx(kBool) GoSetup_OcclusionReductionEnabledUsed(GoSetup setup);
175 
176 /**
177  * Gets the occlusion reduction system value.
178  *
179  * @public @memberof GoSetup
180  * @version Introduced in firmware 4.3.3.124
181  * @param setup GoSetup object.
182  * @return kTRUE if enabled, or kFALSE if not.
183  */
184 GoFx(kBool) GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup);
185 
186 /**
187  * Gets the occlusion reduction algorithm.
188  *
189  * @public @memberof GoSetup
190  * @version Introduced in firmware 4.5.3.57
191  * @param setup GoSetup object.
192  * @return The occlusion reduction algorithm.
193  */
194 GoFx(GoOcclusionReductionAlg) GoSetup_OcclusionReductionAlg(GoSetup setup);
195 
196 /**
197  * Sets the occlusion reduction algorithm.
198  *
199  * @public @memberof GoSetup
200  * @version Introduced in firmware 4.5.3.57
201  * @param setup GoSetup object.
202  * @param alg The algorithm to use for occlusion reduction.
203  * @return Operation status.
204  */
205 GoFx(kStatus) GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg);
206 
207 /**
208  * Returns a boolean representing whether the user occlusion reduction algorithm is used.
209  *
210  * @public @memberof GoSetup
211  * @version Introduced in firmware 4.5.3.57
212  * @param setup GoSetup object.
213  * @return kTRUE if used, or kFALSE if not used.
214  */
215 GoFx(kBool) GoSetup_OcclusionReductionAlgUsed(GoSetup setup);
216 
217 //class - trigger
218 
219 /**
220  * Sets the system trigger units.
221  * Ignored if GoSetup_TriggerSource is time or encoder
222  *
223  * @public @memberof GoSetup
224  * @version Introduced in firmware 4.0.10.27
225  * @param setup GoSetup object.
226  * @param unit The system trigger unit.
227  * @return Operation status.
228  */
229 GoFx(kStatus) GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit);
230 
231 /**
232  * Gets the system trigger units.
233  * Ignored if GoSetup_TriggerSource is time or encoder
234  *
235  * @public @memberof GoSetup
236  * @version Introduced in firmware 4.0.10.27
237  * @param setup GoSetup object.
238  * @return The system domain.
239  */
240 GoFx(GoTriggerUnits) GoSetup_TriggerUnit(GoSetup setup);
241 
242 /**
243  * Sets the trigger source for profile triggering.
244  *
245  * @public @memberof GoSetup
246  * @version Introduced in firmware 4.0.10.27
247  * @param setup GoSetup object.
248  * @param source Profile trigger source.
249  * @return Operation status.
250  */
251 GoFx(kStatus) GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source);
252 
253 /**
254  * Gets the trigger source for profile triggering.
255  *
256  * @public @memberof GoSetup
257  * @version Introduced in firmware 4.0.10.27
258  * @param setup GoSetup object.
259  * @return Profile trigger source.
260  */
261 GoFx(GoTrigger) GoSetup_TriggerSource(GoSetup setup);
262 
263 /**
264  * Sets the trigger delay. Depending on GoDomain, units are uS or mm.
265  *
266  * @public @memberof GoSetup
267  * @version Introduced in firmware 4.0.10.27
268  * @param setup GoSetup object.
269  * @param delay Trigger delay (uS or mm).
270  * @return Operation status.
271  */
272 GoFx(kStatus) GoSetup_SetTriggerDelay(GoSetup setup, k64f delay);
273 
274 /**
275  * Gets the trigger delay. Depending on GoDomain, units are uS or mm.
276  *
277  * @public @memberof GoSetup
278  * @version Introduced in firmware 4.0.10.27
279  * @param setup GoSetup object.
280  * @return Trigger delay (uS or mm).
281  */
282 GoFx(k64f) GoSetup_TriggerDelay(GoSetup setup);
283 
284 /**
285  * Reports the minimum trigger delay, based on current settings.
286  * Depending on GoDomain, units are uS or mm.
287  *
288  * @public @memberof GoSetup
289  * @version Introduced in firmware 4.0.10.27
290  * @param setup GoSetup object.
291  * @return Minimum trigger delay (uS or mm).
292  */
293 GoFx(k64f) GoSetup_TriggerDelayLimitMin(GoSetup setup);
294 
295 /**
296  * Reports the maximum trigger delay, based on current settings.
297  * Depending on GoDomain, units are uS or mm.
298  *
299  * @public @memberof GoSetup
300  * @version Introduced in firmware 4.0.10.27
301  * @param setup GoSetup object.
302  * @return Maximum trigger delay (uS or mm).
303  */
304 GoFx(k64f) GoSetup_TriggerDelayLimitMax(GoSetup setup);
305 
306 /**
307  * Sets the trigger gate feature.
308  *
309  * @public @memberof GoSetup
310  * @version Introduced in firmware 4.0.10.27
311  * @param setup GoSetup object.
312  * @param enable Enables trigger gate operation.
313  * @return Operation status.
314  */
315 GoFx(kStatus) GoSetup_EnableTriggerGate(GoSetup setup, kBool enable);
316 
317 /**
318  * Reports whether the trigger gate feature is currently enabled.
319  *
320  * @public @memberof GoSetup
321  * @version Introduced in firmware 4.0.10.27
322  * @param setup GoSetup object.
323  * @return kTRUE if enabled, or kFALSE if disabled.
324  */
325 GoFx(kBool) GoSetup_TriggerGateEnabled(GoSetup setup);
326 
327 /**
328  * Gets the system value representing whether or not the user specified trigger gate enabled setting is being used at the moment.
329  *
330  * @public @memberof GoSetup
331  * @version Introduced in firmware 4.0.10.27
332  * @param setup GoSetup object.
333  * @return kTRUE if the user specified setting is used and kFALSE otherwise.
334  */
335 GoFx(kBool) GoSetup_TriggerGateEnabledUsed(GoSetup setup);
336 
337 /**
338  * Reports the trigger gate enabled system value.
339  *
340  * @public @memberof GoSetup
341  * @version Introduced in firmware 4.0.10.27
342  * @param setup GoSetup object.
343  * @return kTRUE if enabled, or kFALSE if disabled.
344  */
345 GoFx(kBool) GoSetup_TriggerGateEnabledSystemValue(GoSetup setup);
346 
347 /**
348  * Enables or disables operation at full frame rate (ignoring frame rate setting).
349  *
350  * @public @memberof GoSetup
351  * @version Introduced in firmware 4.0.10.27
352  * @param setup GoSetup object.
353  * @param enable Enables full frame rate operation.
354  * @return Operation status.
355  */
356 GoFx(kStatus) GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable);
357 
358 /**
359  * Reports whether or not system is configured to operate at full frame rate.
360  *
361  * @public @memberof GoSetup
362  * @version Introduced in firmware 4.0.10.27
363  * @param setup GoSetup object.
364  * @return True if system operates at full frame rate; false otherwise.
365  */
366 GoFx(kBool) GoSetup_MaxFrameRateEnabled(GoSetup setup);
367 
368 /**
369  * Sets the current frame rate for time-based triggering. The maximum frame
370  * rate option must be disabled to use the value set in this function.
371  *
372  * @public @memberof GoSetup
373  * @version Introduced in firmware 4.0.10.27
374  * @param setup GoSetup object.
375  * @param frameRate Frame Rate value (Hz).
376  * @return Operation status.
377  * @see GoSetup_EnableMaxFrameRate, GoSetup_MaxFrameRateEnabled
378  */
379 GoFx(kStatus) GoSetup_SetFrameRate(GoSetup setup, k64f frameRate);
380 
381 /**
382  * Reports the currently configured frame rate.
383  *
384  * @public @memberof GoSetup
385  * @version Introduced in firmware 4.0.10.27
386  * @param setup GoSetup object.
387  * @return Maximum frame rate (Hz).
388  */
389 GoFx(k64f) GoSetup_FrameRate(GoSetup setup);
390 
391 /**
392  * Constraint for the minimum valid value of the Frame Rate setting.
393  *
394  * @public @memberof GoSetup
395  * @version Introduced in firmware 4.0.10.27
396  * @param setup GoSetup object.
397  * @return Minimum valid Frame Rate setting (Hz).
398  */
399 GoFx(k64f) GoSetup_FrameRateLimitMin(GoSetup setup);
400 
401 /**
402  * Constraint for the maximum valid value of the Frame Rate setting.
403  *
404  * @public @memberof GoSetup
405  * @version Introduced in firmware 4.0.10.27
406  * @param setup GoSetup object.
407  * @return Maximum valid Frame Rate setting (Hz).
408  */
409 GoFx(k64f) GoSetup_FrameRateLimitMax(GoSetup setup);
410 
411 /**
412  * Sets the encoder trigger mode.
413  *
414  * @public @memberof GoSetup
415  * @version Introduced in firmware 4.0.10.27
416  * @param setup GoSetup object.
417  * @param mode Encoder trigger mode.
418  * @return Profile trigger source.
419  */
420 GoFx(kStatus) GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode);
421 
422 /**
423  * Gets the encoder trigger mode.
424  *
425  * @public @memberof GoSetup
426  * @version Introduced in firmware 4.0.10.27
427  * @param setup GoSetup object.
428  * @return Encoder trigger mode.
429  */
430 GoFx(GoEncoderTriggerMode) GoSetup_EncoderTriggerMode(GoSetup setup);
431 
432 /**
433  * Sets the current encoder period for encoder-based triggering.
434  *
435  * @public @memberof GoSetup
436  * @version Introduced in firmware 4.0.10.27
437  * @param setup GoSetup object.
438  * @param period Encoder period (mm).
439  * @return Operation status.
440  */
441 GoFx(kStatus) GoSetup_SetEncoderSpacing(GoSetup setup, k64f period);
442 
443 /**
444  * Gets the current encoder period for encoder-based triggering.
445  *
446  * @public @memberof GoSetup
447  * @version Introduced in firmware 4.0.10.27
448  * @param setup GoSetup object.
449  * @return Encoder period (mm).
450  */
451 GoFx(k64f) GoSetup_EncoderSpacing(GoSetup setup);
452 
453 /**
454  * Constraint for the minimum valid value of the Encoder Period setting.
455  *
456  * @public @memberof GoSetup
457  * @version Introduced in firmware 4.0.10.27
458  * @param setup GoSetup object.
459  * @return Minimum valid Encoder Period setting (mm).
460  */
461 GoFx(k64f) GoSetup_EncoderSpacingLimitMin(GoSetup setup);
462 
463 /**
464  * Constraint for the maximum valid value of the Encoder Period setting.
465  *
466  * @public @memberof GoSetup
467  * @version Introduced in firmware 4.0.10.27
468  * @param setup GoSetup object.
469  * @return Maximum valid Encoder Period setting (mm).
470  */
471 GoFx(k64f) GoSetup_EncoderSpacingLimitMax(GoSetup setup);
472 
473 /**
474  * Enables profile intensity collection.
475  *
476  * @public @memberof GoSetup
477  * @version Introduced in firmware 4.0.10.27
478  * @param setup GoSetup object.
479  * @param enable kTRUE to enable, or kFALSE to disable.
480  * @return Operation status.
481  */
482 GoFx(kStatus) GoSetup_EnableIntensity(GoSetup setup, kBool enable);
483 
484 /**
485  * Reports whether the profile intensity collection is enabled.
486  *
487  * @public @memberof GoSetup
488  * @version Introduced in firmware 4.0.10.27
489  * @param setup GoSetup object.
490  * @return kTRUE if enabled, or kFALSE if disabled.
491  */
492 GoFx(kBool) GoSetup_IntensityEnabled(GoSetup setup);
493 
494 //class - alignment
495 
496 /**
497  * Gets the input trigger enabled state.
498  *
499  * @public @memberof GoSetup
500  * @version Introduced in firmware 4.0.10.27
501  * @param setup GoSetup object.
502  * @return kTRUE if enabled and kFALSE otherwise.
503  */
504 GoFx(kBool) GoSetup_InputTriggerEnabled(GoSetup setup);
505 
506 /**
507  * Returns a boolean representing whether the user input trigger configuration is used.
508  *
509  * @public @memberof GoSetup
510  * @version Introduced in firmware 4.3.3.124
511  * @param setup GoSetup object.
512  * @return kTRUE if used, or kFALSE if not used.
513  */
514 GoFx(kBool) GoSetup_InputTriggerEnabledUsed(GoSetup setup);
515 
516 /**
517  * Gets the input trigger system value.
518  *
519  * @public @memberof GoSetup
520  * @version Introduced in firmware 4.3.3.124
521  * @param setup GoSetup object.
522  * @return kTRUE if enabled, or kFALSE if not.
523  */
524 GoFx(kBool) GoSetup_InputTriggerEnabledSystemValue(GoSetup setup);
525 
526 /**
527  * Sets the input trigger enabled state.
528  *
529  * @public @memberof GoSetup
530  * @version Introduced in firmware 4.0.10.27
531  * @param setup GoSetup object.
532  * @param enable kTRUE to enable it and kFALSE to disable it.
533  */
534 GoFx(kStatus) GoSetup_EnableInputTrigger(GoSetup setup, kBool enable);
535 
536 /**
537  * Indicates whether alignment can be used.
538  *
539  * @public @memberof GoSetup
540  * @version Introduced in firmware 4.5.3.57
541  * @param setup GoSetup object.
542  * @return True if alignment is available for use.
543  */
544 GoFx(kBool) GoSetup_AlignmentUsed(GoSetup setup);
545 
546 /**
547  * Sets the type used for alignment.
548  *
549  * @public @memberof GoSetup
550  * @version Introduced in firmware 4.0.10.27
551  * @param setup GoSetup object.
552  * @param type Alignment type (stationary or moving).
553  * @return Operation status.
554  */
555 GoFx(kStatus) GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type);
556 
557 /**
558  * Gets the type used for alignment calibration.
559  *
560  * @public @memberof GoSetup
561  * @version Introduced in firmware 4.0.10.27
562  * @param setup GoSetup object.
563  * @return Alignment type (stationary or moving).
564  */
565 GoFx(GoAlignmentType) GoSetup_AlignmentType(GoSetup setup);
566 
567 /**
568  * Gets the alignment type option at the given index.
569  *
570  * @public @memberof GoSetup
571  * @version Introduced in firmware 4.0.10.27
572  * @param setup GoSetup object.
573  * @param index The index with which to retrieve an alignment type option.
574  * @return Alignment type option.
575  * @see GoSetup_AlignmentTypeOptionCount
576  */
577 GoFx(GoAlignmentType) GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index);
578 
579 /**
580  * Gets the alignment type option count.
581  *
582  * @public @memberof GoSetup
583  * @version Introduced in firmware 4.0.10.27
584  * @param setup GoSetup object.
585  * @return Alignment type option count.
586  */
587 GoFx(kSize) GoSetup_AlignmentTypeOptionCount(GoSetup setup);
588 
589 /**
590  * Enables encoder calibration after alignment.
591  *
592  * @public @memberof GoSetup
593  * @version Introduced in firmware 4.0.10.27
594  * @param setup GoSetup object.
595  * @param enabled kTRUE to enable encoder calibration after alignment, kFALSE to disable it.
596  * @return Operation status.
597  */
598 GoFx(kStatus) GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled);
599 
600 /**
601  * Gets the value of the post alignment encoder calibration setting.
602  *
603  * @public @memberof GoSetup
604  * @version Introduced in firmware 4.0.10.27
605  * @param setup GoSetup object.
606  * @return kTRUE if post alignment encoder calibration is enabled. kFALSE otherwise.
607  */
608 GoFx(kBool) GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup);
609 
610 /**
611  * Sets the target type used for stationary alignment calibration.
612  *
613  * @public @memberof GoSetup
614  * @version Introduced in firmware 4.0.10.27
615  * @param setup GoSetup object.
616  * @param target Alignment target type.
617  * @return Operation status.
618  */
619 GoFx(kStatus) GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target);
620 
621 /**
622  * Gets the target type used for stationary alignment calibration.
623  *
624  * @public @memberof GoSetup
625  * @version Introduced in firmware 4.0.10.27
626  * @param setup GoSetup object.
627  * @return Alignment target type.
628  */
629 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTarget(GoSetup setup);
630 
631 /**
632  * Gets the stationary alignment target option count.
633  *
634  * @public @memberof GoSetup
635  * @version Introduced in firmware 4.0.10.27
636  * @param setup GoSetup object.
637  * @return The alignment target count.
638  */
639 GoFx(kSize) GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup);
640 
641 /**
642  * Gets the stationary alignment target option at the given index.
643  *
644  * @public @memberof GoSetup
645  * @version Introduced in firmware 4.0.10.27
646  * @param setup GoSetup object.
647  * @param index The index with which to retrieve an alignment target.
648  * @return The alignment target option.
649  * @see GoSetup_AlignmentStationaryTargetOptionCount
650  */
651 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index);
652 
653 /// @cond (Gocator_1x00 || Gocator_2x00)
654 
655 /**
656  * Sets the target type used for moving alignment calibration.
657  *
658  * @public @memberof GoSetup
659  * @version Introduced in firmware 4.0.10.27
660  * @param setup GoSetup object.
661  * @param target Alignment target type.
662  * @return Operation status.
663  */
664 GoFx(kStatus) GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target);
665 
666 /**
667  * Gets the target type used for moving alignment calibration.
668  *
669  * @public @memberof GoSetup
670  * @version Introduced in firmware 4.0.10.27
671  * @param setup GoSetup object.
672  * @return Alignment target type.
673  */
674 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTarget(GoSetup setup);
675 
676 /**
677  * Gets the moving alignment target option count.
678  *
679  * @public @memberof GoSetup
680  * @version Introduced in firmware 4.0.10.27
681  * @param setup GoSetup object.
682  * @return The alignment target count.
683  */
684 GoFx(kSize) GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup);
685 
686 /**
687 * Gets the moving alignment target option at the given index.
688 *
689 * @public @memberof GoSetup
690  * @version Introduced in firmware 4.0.10.27
691 * @param setup GoSetup object.
692 * @param index The index with which to retrieve an alignment target.
693 * @return The alignment target option.
694 * @see GoSetup_AlignmentMovingTargetOptionCount
695 */
696 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index);
697 
698 /**
699  * Sets the diameter of the disk used for travel calibration.
700  *
701  * @public @memberof GoSetup
702  * @version Introduced in firmware 4.0.10.27
703  * @param setup GoSetup object.
704  * @param diameter Disk diameter (mm).
705  * @return Operation status.
706  */
707 GoFx(kStatus) GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter);
708 
709 /**
710  * Gets the diameter of the disk used for travel calibration.
711  *
712  * @public @memberof GoSetup
713  * @version Introduced in firmware 4.0.10.27
714  * @param setup GoSetup object.
715  * @return Disk diameter (mm).
716  */
717 GoFx(k64f) GoSetup_DiskDiameter(GoSetup setup);
718 
719 /**
720  * Sets the height of the disk used for travel calibration.
721  *
722  * @public @memberof GoSetup
723  * @version Introduced in firmware 4.0.10.27
724  * @param setup GoSetup object.
725  * @param height Disk height (mm).
726  * @return Operation status.
727  */
728 GoFx(kStatus) GoSetup_SetDiskHeight(GoSetup setup, k64f height);
729 
730 /**
731  * Gets the height of the disk used for travel calibration.
732  *
733  * @public @memberof GoSetup
734  * @version Introduced in firmware 4.0.10.27
735  * @param setup GoSetup object.
736  * @return Disk height (mm).
737  */
738 GoFx(k64f) GoSetup_DiskHeight(GoSetup setup);
739 
740 /// @endcond
741 
742 
743 /**
744  * Sets the width of the bar used for travel calibration.
745  *
746  * @public @memberof GoSetup
747  * @version Introduced in firmware 4.0.10.27
748  * @param setup GoSetup object.
749  * @param width Bar width (mm).
750  * @return Operation status.
751  */
752 GoFx(kStatus) GoSetup_SetBarWidth(GoSetup setup, k64f width);
753 
754 /**
755  * Gets the width of the bar used for travel calibration.
756  *
757  * @public @memberof GoSetup
758  * @version Introduced in firmware 4.0.10.27
759  * @param setup GoSetup object.
760  * @return Bar width (mm).
761  */
762 GoFx(k64f) GoSetup_BarWidth(GoSetup setup);
763 
764 /**
765  * Sets the height of the bar used for travel calibration.
766  *
767  * @public @memberof GoSetup
768  * @version Introduced in firmware 4.0.10.27
769  * @param setup GoSetup object.
770  * @param height Bar height (mm).
771  * @return Operation status.
772  */
773 GoFx(kStatus) GoSetup_SetBarHeight(GoSetup setup, k64f height);
774 
775 /**
776  * Gets the height of the bar used for travel calibration.
777  *
778  * @public @memberof GoSetup
779  * @version Introduced in firmware 4.0.10.27
780  * @param setup GoSetup object.
781  * @return Bar height (mm).
782  */
783 GoFx(k64f) GoSetup_BarHeight(GoSetup setup);
784 
785 /**
786  * Sets the number of holes that are defined on the calibration bar.
787  *
788  * @public @memberof GoSetup
789  * @version Introduced in firmware 4.0.10.27
790  * @param setup GoSetup object.
791  * @param count Hole count.
792  * @return Operation status.
793  */
794 GoFx(kStatus) GoSetup_SetBarHoleCount(GoSetup setup, kSize count);
795 
796 /**
797  * Gets the number of holes that are defined on the calibration bar.
798  *
799  * @public @memberof GoSetup
800  * @version Introduced in firmware 4.0.10.27
801  * @param setup GoSetup object.
802  * @return Hole count.
803  */
804 GoFx(kSize) GoSetup_BarHoleCount(GoSetup setup);
805 
806 /**
807  * Sets the distance between holes that are defined on the calibration bar.
808  *
809  * @public @memberof GoSetup
810  * @version Introduced in firmware 4.0.10.27
811  * @param setup GoSetup object.
812  * @param distance Hole distance (mm).
813  * @return Operation status.
814  */
815 GoFx(kStatus) GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance);
816 
817 /**
818  * Gets the distance between holes that are defined on the calibration bar.
819  *
820  * @public @memberof GoSetup
821  * @version Introduced in firmware 4.0.10.27
822  * @param setup GoSetup object.
823  * @return Hole distance (mm).
824  */
825 GoFx(k64f) GoSetup_BarHoleDistance(GoSetup setup);
826 
827 /**
828  * Sets the diameter of holes that are defined on the calibration bar.
829  *
830  * @public @memberof GoSetup
831  * @version Introduced in firmware 4.0.10.27
832  * @param setup GoSetup object.
833  * @param diameter Hole diameter (mm).
834  * @return Operation status.
835  */
836 GoFx(kStatus) GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter);
837 
838 /**
839  * Gets the diameter of holes that are defined on the calibration bar.
840  *
841  * @public @memberof GoSetup
842  * @version Introduced in firmware 4.0.10.27
843  * @param setup GoSetup object.
844  * @return Hole diameter (mm).
845  */
846 GoFx(k64f) GoSetup_BarHoleDiameter(GoSetup setup);
847 
848 /**
849  * Sets the height of the plate used for travel calibration.
850  *
851  * @public @memberof GoSetup
852  * @version Introduced in firmware 4.0.10.27
853  * @param setup GoSetup object.
854  * @param height Plate height (mm).
855  * @return Operation status.
856  */
857 GoFx(kStatus) GoSetup_SetPlateHeight(GoSetup setup, k64f height);
858 
859 /**
860  * Gets the height of the plate used for travel calibration.
861  *
862  * @public @memberof GoSetup
863  * @version Introduced in firmware 4.0.10.27
864  * @param setup GoSetup object.
865  * @return Plate height (mm).
866  */
867 GoFx(k64f) GoSetup_PlateHeight(GoSetup setup);
868 
869 /**
870  * Sets the number of holes that are defined on the calibration plate.
871  *
872  * @public @memberof GoSetup
873  * @version Introduced in firmware 4.0.10.27
874  * @param setup GoSetup object.
875  * @param count Hole count.
876  * @return Operation status.
877  */
878 GoFx(kStatus) GoSetup_SetPlateHoleCount(GoSetup setup, kSize count);
879 
880 /**
881  * Gets the number of holes that are defined on the calibration plate.
882  *
883  * @public @memberof GoSetup
884  * @version Introduced in firmware 4.0.10.27
885  * @param setup GoSetup object.
886  * @return Hole count.
887  */
888 GoFx(kSize) GoSetup_PlateHoleCount(GoSetup setup);
889 
890 /**
891  * Sets the diameter of the reference hole defined on the calibration plate.
892  *
893  * @public @memberof GoSetup
894  * @version Introduced in firmware 4.0.10.27
895  * @param setup GoSetup object.
896  * @param diameter Hole diameter (mm).
897  * @return Operation status.
898  */
899 GoFx(kStatus) GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter);
900 
901 /**
902  * Gets the diameter of the reference hole defined on the calibration plate.
903  *
904  * @public @memberof GoSetup
905  * @version Introduced in firmware 4.0.10.27
906  * @param setup GoSetup object.
907  * @return Hole diameter (mm).
908  */
909 GoFx(k64f) GoSetup_PlateRefHoleDiameter(GoSetup setup);
910 
911 /**
912  * Sets the diameter of the secondary hole defined on the calibration plate.
913  *
914  * @public @memberof GoSetup
915  * @version Introduced in firmware 4.0.10.27
916  * @param setup GoSetup object.
917  * @param diameter Hole diameter (mm).
918  * @return Operation status.
919  */
920 GoFx(kStatus) GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter);
921 
922 /**
923  * Gets the diameter of the secondary hole defined on the calibration plate.
924  *
925  * @public @memberof GoSetup
926  * @version Introduced in firmware 4.0.10.27
927  * @param setup GoSetup object.
928  * @return Hole diameter (mm).
929  */
930 GoFx(k64f) GoSetup_PlateSecHoleDiameter(GoSetup setup);
931 
932 /// @cond (Gocator_1x00 || Gocator_2x00)
933 
934 /**
935  * Indicates whether X smoothing can be used for the current scan mode and device family.
936  *
937  * @public @memberof GoSetup
938  * @version Introduced in firmware 4.5.3.57
939  * @param setup GoSetup object.
940  * @return True if x-smoothing is available for use.
941  */
942 GoFx(kBool) GoSetup_XSmoothingUsed(GoSetup setup);
943 
944 /**
945  * Sets the status of x-direction smoothing.
946  *
947  * @public @memberof GoSetup
948  * @version Introduced in firmware 4.0.10.27
949  * @param setup GoSetup object.
950  * @param enabled Enable or disable x-smoothing
951  * @return Operation status.
952  */
953 GoFx(kStatus) GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled);
954 
955 /**
956  * Gets the status of x-direction smoothing.
957  *
958  * @public @memberof GoSetup
959  * @version Introduced in firmware 4.0.10.27
960  * @param setup GoSetup object.
961  * @return True if x-smoothing is enabled.
962  */
963 GoFx(kBool) GoSetup_XSmoothingEnabled(GoSetup setup);
964 
965 /**
966  * Sets the x-direction smoothing window.
967  *
968  * @public @memberof GoSetup
969  * @version Introduced in firmware 4.0.10.27
970  * @param setup GoSetup object.
971  * @param window The x-smoothing window (mm).
972  * @return Operation status.
973  */
974 GoFx(kStatus) GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window);
975 
976 /**
977  * Gets the x-direction smoothing window.
978  *
979  * @public @memberof GoSetup
980  * @version Introduced in firmware 4.0.10.27
981  * @param setup GoSetup object.
982  * @return The x-smoothing window (mm).
983  */
984 GoFx(k64f) GoSetup_XSmoothingWindow(GoSetup setup);
985 
986 /**
987  * Gets the x-direction smoothing window minimum.
988  *
989  * @public @memberof GoSetup
990  * @version Introduced in firmware 4.0.10.27
991  * @param setup GoSetup object.
992  * @return The x-smoothing window min (mm).
993  */
994 GoFx(k64f) GoSetup_XSmoothingWindowLimitMin(GoSetup setup);
995 
996 /**
997  * Gets the x-direction smoothing window maximum.
998  *
999  * @public @memberof GoSetup
1000  * @version Introduced in firmware 4.0.10.27
1001  * @param setup GoSetup object.
1002  * @return The x-smoothing window max (mm).
1003  */
1004 GoFx(k64f) GoSetup_XSmoothingWindowLimitMax(GoSetup setup);
1005 
1006 /**
1007  * Indicates whether X median can be used for the current scan mode and device family.
1008  *
1009  * @public @memberof GoSetup
1010  * @version Introduced in firmware 4.5.3.57
1011  * @param setup GoSetup object.
1012  * @return True if x-median is available for use.
1013  */
1014 GoFx(kBool) GoSetup_XMedianUsed(GoSetup setup);
1015 
1016 /**
1017  * Sets the status of x-direction median.
1018  *
1019  * @public @memberof GoSetup
1020  * @version Introduced in firmware 4.1.3.106
1021  * @param setup GoSetup object.
1022  * @param enabled Enable or disable x-median
1023  * @return Operation status.
1024  */
1025 GoFx(kStatus) GoSetup_EnableXMedian(GoSetup setup, kBool enabled);
1026 
1027 /**
1028  * Gets the status of x-direction median.
1029  *
1030  * @public @memberof GoSetup
1031  * @version Introduced in firmware 4.1.3.106
1032  * @param setup GoSetup object.
1033  * @return True if x-median is enabled.
1034  */
1035 GoFx(kBool) GoSetup_XMedianEnabled(GoSetup setup);
1036 
1037 /**
1038  * Sets the x-direction median window.
1039  *
1040  * @public @memberof GoSetup
1041  * @version Introduced in firmware 4.1.3.106
1042  * @param setup GoSetup object.
1043  * @param window The x-median window (mm).
1044  * @return Operation status.
1045  */
1046 GoFx(kStatus) GoSetup_SetXMedianWindow(GoSetup setup, k64f window);
1047 
1048 /**
1049  * Gets the x-direction median window.
1050  *
1051  * @public @memberof GoSetup
1052  * @version Introduced in firmware 4.1.3.106
1053  * @param setup GoSetup object.
1054  * @return The x-median window (mm).
1055  */
1056 GoFx(k64f) GoSetup_XMedianWindow(GoSetup setup);
1057 
1058 /**
1059  * Gets the x-direction median window minimum.
1060  *
1061  * @public @memberof GoSetup
1062  * @version Introduced in firmware 4.1.3.106
1063  * @param setup GoSetup object.
1064  * @return The x-median window min (mm).
1065  */
1066 GoFx(k64f) GoSetup_XMedianWindowLimitMin(GoSetup setup);
1067 
1068 /**
1069  * Gets the x-direction median window maximum.
1070  *
1071  * @public @memberof GoSetup
1072  * @version Introduced in firmware 4.1.3.106
1073  * @param setup GoSetup object.
1074  * @return The x-median window max (mm).
1075  */
1076 GoFx(k64f) GoSetup_XMedianWindowLimitMax(GoSetup setup);
1077 
1078 /**
1079  * Indicates whether X decimation can be used for the current scan mode and device family.
1080  *
1081  * @public @memberof GoSetup
1082  * @version Introduced in firmware 4.5.3.57
1083  * @param setup GoSetup object.
1084  * @return True if x-decimation is available for use.
1085  */
1086 GoFx(kBool) GoSetup_XDecimationUsed(GoSetup setup);
1087 
1088 /**
1089  * Sets the status of x-direction decimation.
1090  *
1091  * @public @memberof GoSetup
1092  * @version Introduced in firmware 4.1.3.106
1093  * @param setup GoSetup object.
1094  * @param enabled Enable or disable x-decimation
1095  * @return Operation status.
1096  */
1097 GoFx(kStatus) GoSetup_EnableXDecimation(GoSetup setup, kBool enabled);
1098 
1099 /**
1100  * Gets the status of x-direction decimation.
1101  *
1102  * @public @memberof GoSetup
1103  * @version Introduced in firmware 4.1.3.106
1104  * @param setup GoSetup object.
1105  * @return True if x-decimation is enabled.
1106  */
1107 GoFx(kBool) GoSetup_XDecimationEnabled(GoSetup setup);
1108 
1109 /**
1110  * Sets the x-direction decimation window.
1111  *
1112  * @public @memberof GoSetup
1113  * @version Introduced in firmware 4.1.3.106
1114  * @param setup GoSetup object.
1115  * @param window The x-decimation window (mm).
1116  * @return Operation status.
1117  */
1118 GoFx(kStatus) GoSetup_SetXDecimationWindow(GoSetup setup, k64f window);
1119 
1120 /**
1121  * Gets the x-direction decimation window.
1122  *
1123  * @public @memberof GoSetup
1124  * @version Introduced in firmware 4.1.3.106
1125  * @param setup GoSetup object.
1126  * @return The x-decimation window (mm).
1127  */
1128 GoFx(k64f) GoSetup_XDecimationWindow(GoSetup setup);
1129 
1130 /**
1131  * Gets the x-direction decimation window minimum.
1132  *
1133  * @public @memberof GoSetup
1134  * @version Introduced in firmware 4.1.3.106
1135  * @param setup GoSetup object.
1136  * @return The x-decimation window min (mm).
1137  */
1138 GoFx(k64f) GoSetup_XDecimationWindowLimitMin(GoSetup setup);
1139 
1140 /**
1141  * Gets the x-direction decimation window maximum.
1142  *
1143  * @public @memberof GoSetup
1144  * @version Introduced in firmware 4.1.3.106
1145  * @param setup GoSetup object.
1146  * @return The x-decimation window max (mm).
1147  */
1148 GoFx(k64f) GoSetup_XDecimationWindowLimitMax(GoSetup setup);
1149 
1150 /**
1151  * Indicates whether X gap filling can be used for the current scan mode and device family.
1152  *
1153  * @public @memberof GoSetup
1154  * @version Introduced in firmware 4.5.3.57
1155  * @param setup GoSetup object.
1156  * @return True if x-gap filling is available for use.
1157  */
1158 GoFx(kBool) GoSetup_XGapFillingUsed(GoSetup setup);
1159 
1160 /**
1161  * Sets the status of x-direction gap-filling.
1162  *
1163  * @public @memberof GoSetup
1164  * @version Introduced in firmware 4.0.10.27
1165  * @param setup GoSetup object.
1166  * @param enable Enable or disable x-gap-filling
1167  * @return Operation status.
1168  */
1169 GoFx(kStatus) GoSetup_EnableXGapFilling(GoSetup setup, kBool enable);
1170 
1171 /**
1172  * Gets the status of x-direction gap-filling.
1173  *
1174  * @public @memberof GoSetup
1175  * @version Introduced in firmware 4.0.10.27
1176  * @param setup GoSetup object.
1177  * @return True if x-gap-filling is enabled.
1178  */
1179 GoFx(kBool) GoSetup_XGapFillingEnabled(GoSetup setup);
1180 
1181 /**
1182  * Sets the status of x-direction gap-filling.
1183  *
1184  * @public @memberof GoSetup
1185  * @version Introduced in firmware 4.0.10.27
1186  * @param setup GoSetup object.
1187  * @param window Enable or disable x-gap-filling
1188  * @return Operation status.
1189  */
1190 GoFx(kStatus) GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window);
1191 
1192 /**
1193  * Gets the x-direction gap-filling window.
1194  *
1195  * @public @memberof GoSetup
1196  * @version Introduced in firmware 4.0.10.27
1197  * @param setup GoSetup object.
1198  * @return The x-gap-filling window (mm).
1199  */
1200 GoFx(k64f) GoSetup_XGapFillingWindow(GoSetup setup);
1201 
1202 /**
1203  * Gets the x-direction gap-filling window minimum.
1204  *
1205  * @public @memberof GoSetup
1206  * @version Introduced in firmware 4.0.10.27
1207  * @param setup GoSetup object.
1208  * @return The x-gap-filling window min (mm).
1209  */
1210 GoFx(k64f) GoSetup_XGapFillingWindowLimitMin(GoSetup setup);
1211 
1212 /**
1213  * Gets the x-direction gap-filling window maximum.
1214  *
1215  * @public @memberof GoSetup
1216  * @version Introduced in firmware 4.0.10.27
1217  * @param setup GoSetup object.
1218  * @return The x-gap-filling window max (mm).
1219  */
1220 GoFx(k64f) GoSetup_XGapFillingWindowLimitMax(GoSetup setup);
1221 
1222 /**
1223  * Indicates whether X slope can be used for the current scan mode and device family.
1224  *
1225  * @public @memberof GoSetup
1226  * @version Introduced in firmware 4.5.3.57
1227  * @param setup GoSetup object.
1228  * @return True if x-slope is available for use.
1229  */
1230 GoFx(kBool) GoSetup_XSlopeUsed(GoSetup setup);
1231 
1232 /**
1233  * Sets the status of x-direction slope.
1234  *
1235  * @public @memberof GoSetup
1236  * @version Introduced in firmware 4.5.2.0
1237  * @param setup GoSetup object.
1238  * @param enable Enable or disable x-slope
1239  * @return Operation status.
1240  */
1241 GoFx(kStatus) GoSetup_EnableXSlope(GoSetup setup, kBool enable);
1242 
1243 /**
1244  * Gets the status of x-direction slope.
1245  *
1246  * @public @memberof GoSetup
1247  * @version Introduced in firmware 4.5.2.0
1248  * @param setup GoSetup object.
1249  * @return True if x-slope is enabled.
1250  */
1251 GoFx(kBool) GoSetup_XSlopeEnabled(GoSetup setup);
1252 
1253 /**
1254  * Sets the status of x-direction slope.
1255  *
1256  * @public @memberof GoSetup
1257  * @version Introduced in firmware 4.5.2.0
1258  * @param setup GoSetup object.
1259  * @param window Enable or disable x-slope
1260  * @return Operation status.
1261  */
1262 GoFx(kStatus) GoSetup_SetXSlopeWindow(GoSetup setup, k64f window);
1263 
1264 /**
1265  * Gets the x-direction slope window.
1266  *
1267  * @public @memberof GoSetup
1268  * @version Introduced in firmware 4.5.2.0
1269  * @param setup GoSetup object.
1270  * @return The x-slope window (mm).
1271  */
1272 GoFx(k64f) GoSetup_XSlopeWindow(GoSetup setup);
1273 
1274 /**
1275  * Gets the x-direction slope window minimum.
1276  *
1277  * @public @memberof GoSetup
1278  * @version Introduced in firmware 4.5.2.0
1279  * @param setup GoSetup object.
1280  * @return The x-slope window min (mm).
1281  */
1282 GoFx(k64f) GoSetup_XSlopeWindowLimitMin(GoSetup setup);
1283 
1284 /**
1285  * Gets the x-direction slope window maximum.
1286  *
1287  * @public @memberof GoSetup
1288  * @version Introduced in firmware 4.5.2.0
1289  * @param setup GoSetup object.
1290  * @return The x-slope window max (mm).
1291  */
1292 GoFx(k64f) GoSetup_XSlopeWindowLimitMax(GoSetup setup);
1293 
1294 /**
1295  * Indicates whether Y smoothing can be used for the current scan mode and device family.
1296  *
1297  * @public @memberof GoSetup
1298  * @version Introduced in firmware 4.5.3.57
1299  * @param setup GoSetup object.
1300  * @return True if y-smoothing is available for use.
1301  */
1302 GoFx(kBool) GoSetup_YSmoothingUsed(GoSetup setup);
1303 
1304 /**
1305  * Sets the status of y-direction smoothing.
1306  *
1307  * @public @memberof GoSetup
1308  * @version Introduced in firmware 4.0.10.27
1309  * @param setup GoSetup object.
1310  * @param enable Enable or disable y-smoothing
1311  * @return Operation status.
1312  */
1313 GoFx(kStatus) GoSetup_EnableYSmoothing(GoSetup setup, kBool enable);
1314 
1315 /**
1316  * Gets the status of y-direction smoothing.
1317  *
1318  * @public @memberof GoSetup
1319  * @version Introduced in firmware 4.0.10.27
1320  * @param setup GoSetup object.
1321  * @return True if y-smoothing is enabled.
1322  */
1323 GoFx(kBool) GoSetup_YSmoothingEnabled(GoSetup setup);
1324 
1325 /**
1326  * Sets the y-direction smoothing window.
1327  *
1328  * @public @memberof GoSetup
1329  * @version Introduced in firmware 4.0.10.27
1330  * @param setup GoSetup object.
1331  * @param window The y-smoothing window (mm).
1332  * @return Operation status.
1333  */
1334 GoFx(kStatus) GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window);
1335 
1336 /**
1337  * Gets the y-direction smoothing window.
1338  *
1339  * @public @memberof GoSetup
1340  * @version Introduced in firmware 4.0.10.27
1341  * @param setup GoSetup object.
1342  * @return The y-smoothing window (mm).
1343  */
1344 GoFx(k64f) GoSetup_YSmoothingWindow(GoSetup setup);
1345 
1346 /**
1347  * Gets the y-direction smoothing window minimum.
1348  *
1349  * @public @memberof GoSetup
1350  * @version Introduced in firmware 4.0.10.27
1351  * @param setup GoSetup object.
1352  * @return The y-smoothing window min (mm).
1353  */
1354 GoFx(k64f) GoSetup_YSmoothingWindowLimitMin(GoSetup setup);
1355 
1356 /**
1357  * Gets the y-direction smoothing window maximum.
1358  *
1359  * @public @memberof GoSetup
1360  * @version Introduced in firmware 4.0.10.27
1361  * @param setup GoSetup object.
1362  * @return The y-smoothing window max (mm).
1363  */
1364 GoFx(k64f) GoSetup_YSmoothingWindowLimitMax(GoSetup setup);
1365 
1366 /**
1367  * Indicates whether Y median can be used for the current scan mode and device family.
1368  *
1369  * @public @memberof GoSetup
1370  * @version Introduced in firmware 4.5.3.57
1371  * @param setup GoSetup object.
1372  * @return True if y-median is available for use.
1373  */
1374 GoFx(kBool) GoSetup_YMedianUsed(GoSetup setup);
1375 
1376 /**
1377  * Sets the status of y-direction median.
1378  *
1379  * @public @memberof GoSetup
1380  * @version Introduced in firmware 4.1.3.106
1381  * @param setup GoSetup object.
1382  * @param enable Enable or disable y-median
1383  * @return Operation status.
1384  */
1385 GoFx(kStatus) GoSetup_EnableYMedian(GoSetup setup, kBool enable);
1386 
1387 /**
1388  * Gets the status of y-direction median.
1389  *
1390  * @public @memberof GoSetup
1391  * @version Introduced in firmware 4.1.3.106
1392  * @param setup GoSetup object.
1393  * @return True if y-median is enabled.
1394  */
1395 GoFx(kBool) GoSetup_YMedianEnabled(GoSetup setup);
1396 
1397 /**
1398  * Sets the y-direction median window.
1399  *
1400  * @public @memberof GoSetup
1401  * @version Introduced in firmware 4.1.3.106
1402  * @param setup GoSetup object.
1403  * @param window The y-median window (mm).
1404  * @return Operation status.
1405  */
1406 GoFx(kStatus) GoSetup_SetYMedianWindow(GoSetup setup, k64f window);
1407 
1408 /**
1409  * Gets the y-direction median window.
1410  *
1411  * @public @memberof GoSetup
1412  * @version Introduced in firmware 4.1.3.106
1413  * @param setup GoSetup object.
1414  * @return The y-median window (mm).
1415  */
1416 GoFx(k64f) GoSetup_YMedianWindow(GoSetup setup);
1417 
1418 /**
1419  * Gets the y-direction median window minimum.
1420  *
1421  * @public @memberof GoSetup
1422  * @version Introduced in firmware 4.1.3.106
1423  * @param setup GoSetup object.
1424  * @return The y-median window min (mm).
1425  */
1426 GoFx(k64f) GoSetup_YMedianWindowLimitMin(GoSetup setup);
1427 
1428 /**
1429  * Gets the y-direction median window maximum.
1430  *
1431  * @public @memberof GoSetup
1432  * @version Introduced in firmware 4.1.3.106
1433  * @param setup GoSetup object.
1434  * @return The y-median window max (mm).
1435  */
1436 GoFx(k64f) GoSetup_YMedianWindowLimitMax(GoSetup setup);
1437 
1438 /**
1439  * Indicates whether y decimation can be used for the current scan mode and device family.
1440  *
1441  * @public @memberof GoSetup
1442  * @version Introduced in firmware 4.5.3.57
1443  * @param setup GoSetup object.
1444  * @return True if y-decimation is available for use.
1445  */
1446 GoFx(kBool) GoSetup_YDecimationUsed(GoSetup setup);
1447 
1448 /**
1449  * Sets the status of y-direction decimation.
1450  *
1451  * @public @memberof GoSetup
1452  * @version Introduced in firmware 4.1.3.106
1453  * @param setup GoSetup object.
1454  * @param enable Enable or disable y-decimation
1455  * @return Operation status.
1456  */
1457 GoFx(kStatus) GoSetup_EnableYDecimation(GoSetup setup, kBool enable);
1458 
1459 /**
1460  * Gets the status of y-direction decimation.
1461  *
1462  * @public @memberof GoSetup
1463  * @version Introduced in firmware 4.1.3.106
1464  * @param setup GoSetup object.
1465  * @return True if y-decimation is enabled.
1466  */
1467 GoFx(kBool) GoSetup_YDecimationEnabled(GoSetup setup);
1468 
1469 /**
1470  * Sets the y-direction decimation window.
1471  *
1472  * @public @memberof GoSetup
1473  * @version Introduced in firmware 4.1.3.106
1474  * @param setup GoSetup object.
1475  * @param window The y-decimation window (mm).
1476  * @return Operation status.
1477  */
1478 GoFx(kStatus) GoSetup_SetYDecimationWindow(GoSetup setup, k64f window);
1479 
1480 /**
1481  * Gets the y-direction decimation window.
1482  *
1483  * @public @memberof GoSetup
1484  * @version Introduced in firmware 4.1.3.106
1485  * @param setup GoSetup object.
1486  * @return The y-decimation window (mm).
1487  */
1488 GoFx(k64f) GoSetup_YDecimationWindow(GoSetup setup);
1489 
1490 /**
1491  * Gets the y-direction decimation window minimum.
1492  *
1493  * @public @memberof GoSetup
1494  * @version Introduced in firmware 4.1.3.106
1495  * @param setup GoSetup object.
1496  * @return The y-decimation window min (mm).
1497  */
1498 GoFx(k64f) GoSetup_YDecimationWindowLimitMin(GoSetup setup);
1499 
1500 /**
1501  * Gets the y-direction decimation window maximum.
1502  *
1503  * @public @memberof GoSetup
1504  * @version Introduced in firmware 4.1.3.106
1505  * @param setup GoSetup object.
1506  * @return The y-decimation window max (mm).
1507  */
1508 GoFx(k64f) GoSetup_YDecimationWindowLimitMax(GoSetup setup);
1509 
1510 /**
1511  * Indicates whether Y slope can be used for the current scan mode and device family.
1512  *
1513  * @public @memberof GoSetup
1514  * @version Introduced in firmware 4.5.3.57
1515  * @param setup GoSetup object.
1516  * @return True if y-slope is available for use.
1517  */
1518 GoFx(kBool) GoSetup_YSlopeUsed(GoSetup setup);
1519 
1520 /**
1521  * Sets the status of y-direction slope.
1522  *
1523  * @public @memberof GoSetup
1524  * @version Introduced in firmware 4.5.2.0
1525  * @param setup GoSetup object.
1526  * @param enable Enable or disable y-slope
1527  * @return Operation status.
1528  */
1529 GoFx(kStatus) GoSetup_EnableYSlope(GoSetup setup, kBool enable);
1530 
1531 /**
1532  * Gets the status of y-direction slope.
1533  *
1534  * @public @memberof GoSetup
1535  * @version Introduced in firmware 4.5.2.0
1536  * @param setup GoSetup object.
1537  * @return True if y-slope is enabled.
1538  */
1539 GoFx(kBool) GoSetup_YSlopeEnabled(GoSetup setup);
1540 
1541 /**
1542  * Sets the status of y-direction slope.
1543  *
1544  * @public @memberof GoSetup
1545  * @version Introduced in firmware 4.5.2.0
1546  * @param setup GoSetup object.
1547  * @param window Enable or disable y-slope
1548  * @return Operation status.
1549  */
1550 GoFx(kStatus) GoSetup_SetYSlopeWindow(GoSetup setup, k64f window);
1551 
1552 /**
1553  * Gets the y-direction slope window.
1554  *
1555  * @public @memberof GoSetup
1556  * @version Introduced in firmware 4.5.2.0
1557  * @param setup GoSetup object.
1558  * @return The y-slope window (mm).
1559  */
1560 GoFx(k64f) GoSetup_YSlopeWindow(GoSetup setup);
1561 
1562 /**
1563  * Gets the y-direction slope window minimum.
1564  *
1565  * @public @memberof GoSetup
1566  * @version Introduced in firmware 4.5.2.0
1567  * @param setup GoSetup object.
1568  * @return The y-slope window min (mm).
1569  */
1570 GoFx(k64f) GoSetup_YSlopeWindowLimitMin(GoSetup setup);
1571 
1572 /**
1573  * Gets the y-direction slope window maximum.
1574  *
1575  * @public @memberof GoSetup
1576  * @version Introduced in firmware 4.5.2.0
1577  * @param setup GoSetup object.
1578  * @return The y-slope window max (mm).
1579  */
1580 GoFx(k64f) GoSetup_YSlopeWindowLimitMax(GoSetup setup);
1581 
1582 /// @endcond
1583 
1584 /// @cond (Gocator_2x00)
1585 
1586 /**
1587  * Indicates whether Y gap filling can be used for the current scan mode and device family.
1588  *
1589  * @public @memberof GoSetup
1590  * @version Introduced in firmware 4.5.3.57
1591  * @param setup GoSetup object.
1592  * @return True if y-gap filling is available for use.
1593  */
1594 GoFx(kBool) GoSetup_YGapFillingUsed(GoSetup setup);
1595 
1596 /**
1597  * Sets the status of y-direction gap-filling.
1598  *
1599  * @public @memberof GoSetup
1600  * @version Introduced in firmware 4.0.10.27
1601  * @param setup GoSetup object.
1602  * @param enable Enable or disable y-gap-filling
1603  * @return Operation status.
1604  */
1605 GoFx(kStatus) GoSetup_EnableYGapFilling(GoSetup setup, kBool enable);
1606 
1607 /**
1608  * Gets the status of y-direction gap-filling.
1609  *
1610  * @public @memberof GoSetup
1611  * @version Introduced in firmware 4.0.10.27
1612  * @param setup GoSetup object.
1613  * @return True if y-gap-filling is enabled.
1614  */
1615 GoFx(kBool) GoSetup_YGapFillingEnabled(GoSetup setup);
1616 
1617 /**
1618  * Sets the y-direction gap-filling window.
1619  *
1620  * @public @memberof GoSetup
1621  * @version Introduced in firmware 4.0.10.27
1622  * @param setup GoSetup object.
1623  * @param window The y-gap-filling window (mm).
1624  * @return
1625  */
1626 GoFx(kStatus) GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window);
1627 
1628 /**
1629  * Gets the y-direction gap-filling window.
1630  *
1631  * @public @memberof GoSetup
1632  * @version Introduced in firmware 4.0.10.27
1633  * @param setup GoSetup object.
1634  * @return The y-gap-filling window (mm).
1635  */
1636 GoFx(k64f) GoSetup_YGapFillingWindow(GoSetup setup);
1637 
1638 /**
1639  * Gets the y-direction gap-filling window minimum.
1640  *
1641  * @public @memberof GoSetup
1642  * @version Introduced in firmware 4.0.10.27
1643  * @param setup GoSetup object.
1644  * @return The y-gap-filling window min (mm).
1645  */
1646 GoFx(k64f) GoSetup_YGapFillingWindowLimitMin(GoSetup setup);
1647 
1648 /**
1649  * Gets the y-direction gap-filling window maximum.
1650  *
1651  * @public @memberof GoSetup
1652  * @version Introduced in firmware 4.0.10.27
1653  * @param setup GoSetup object.
1654  * @return The y-gap-filling window max (mm).
1655  */
1656 GoFx(k64f) GoSetup_YGapFillingWindowLimitMax(GoSetup setup);
1657 
1658 /// @endcond
1659 
1660 /**
1661  * Gets the maximum valid value for the Exposure setting.
1662  *
1663  * @public @memberof GoSetup
1664  * @version Introduced in firmware 4.0.10.27
1665  * @param setup GoSetup object.
1666  * @param role Determines which device to retrieve the value from.
1667  * @return Maximum valid Exposure value (microseconds).
1668  */
1669 GoFx(k64f) GoSetup_ExposureLimitMax(GoSetup setup, GoRole role);
1670 
1671 /**
1672  * Gets the minimum valid value for the Exposure setting.
1673  *
1674  * @public @memberof GoSetup
1675  * @version Introduced in firmware 4.0.10.27
1676  * @param setup GoSetup object.
1677  * @param role Determines which device to retrieve the value from.
1678  * @return Maximum valid Exposure value (microseconds).
1679  */
1680 GoFx(k64f) GoSetup_ExposureLimitMin(GoSetup setup, GoRole role);
1681 
1682 /**
1683  * Sets the exposure value.
1684  *
1685  * @public @memberof GoSetup
1686  * @version Introduced in firmware 4.0.10.27
1687  * @param setup GoSetup object.
1688  * @param role Determines which sensor to apply changes to.
1689  * @param exposure Intended exposure value.
1690  * @return Operation status.
1691  */
1692 GoFx(kStatus) GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure);
1693 
1694 /**
1695  * Gets the exposure value.
1696  *
1697  * @public @memberof GoSetup
1698  * @version Introduced in firmware 4.0.10.27
1699  * @param setup GoSetup object.
1700  * @param role Determines which device to retrieve the value from.
1701  * @return Exposure value (microseconds).
1702  */
1703 GoFx(k64f) GoSetup_Exposure(GoSetup setup, GoRole role);
1704 
1705 /**
1706  * Gets the exposure mode.
1707  *
1708  * @public @memberof GoSetup
1709  * @version Introduced in firmware 4.0.10.27
1710  * @param setup GoSetup object.
1711  * @param role Determines which device to retrieve the value from.
1712  * @return Exposure mode.
1713  */
1714 GoFx(GoExposureMode) GoSetup_ExposureMode(GoSetup setup, GoRole role);
1715 
1716 /**
1717  * Sets the exposure mode.
1718  *
1719  * @public @memberof GoSetup
1720  * @version Introduced in firmware 4.0.10.27
1721  * @param setup GoSetup object.
1722  * @param role Determines which sensor to apply changes to.
1723  * @param mode The exposure mode to use.
1724  * @return Operation status.
1725  */
1726 GoFx(kStatus) GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode);
1727 
1728 /**
1729  * Gets the exposure mode option at the given index.
1730  *
1731  * @public @memberof GoSetup
1732  * @version Introduced in firmware 4.0.10.27
1733  * @param setup GoSetup object.
1734  * @param role Determines which device to retrieve the value from.
1735  * @param index The index with which to retrieve an exposure mode option.
1736  * @return Exposure mode option.
1737  * @see GoSetup_ExposureModeOptionCount
1738  */
1739 GoFx(GoExposureMode) GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index);
1740 
1741 /**
1742  * Gets the exposure mode option count.
1743  *
1744  * @public @memberof GoSetup
1745  * @version Introduced in firmware 4.0.10.27
1746  * @param setup GoSetup object.
1747  * @param role Determines which device to retrieve the value from.
1748  * @return Exposure mode option count.
1749  */
1750 GoFx(kSize) GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role);
1751 
1752 /**
1753  * Adds an exposure step
1754  *
1755  * @public @memberof GoSetup
1756  * @version Introduced in firmware 4.0.10.27
1757  * @param setup GoSetup object.
1758  * @param role Determines which sensor to apply changes to.
1759  * @param exposure Exposure value (microseconds).
1760  * @return Operation status.
1761  */
1762 GoFx(kStatus) GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure);
1763 
1764 /**
1765  * Removes all exposure steps.
1766  *
1767  * @public @memberof GoSetup
1768  * @version Introduced in firmware 4.0.10.27
1769  * @param setup GoSetup object.
1770  * @param role Determines which sensor to apply changes to.
1771  * @return Operation status.
1772  */
1773 GoFx(kStatus) GoSetup_ClearExposureSteps(GoSetup setup, GoRole role);
1774 
1775 /**
1776  * Get the exposure step value specified by index
1777  *
1778  * @public @memberof GoSetup
1779  * @version Introduced in firmware 4.0.10.27
1780  * @param setup GoSetup object.
1781  * @param role Determines which device to retrieve the value from.
1782  * @param index The index of the exposure step to get.
1783  * @return The exposure step value (microseconds).
1784  * @see GoSetup_ExposureStepCount
1785  */
1786 GoFx(k64f) GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index);
1787 
1788 /**
1789  * Get the number of exposure steps defined
1790  *
1791  * @public @memberof GoSetup
1792  * @version Introduced in firmware 4.0.10.27
1793  * @param setup GoSetup object.
1794  * @param role Determines which device to retrieve the value from.
1795  * @return The count of exposure steps.
1796  */
1797 GoFx(kSize) GoSetup_ExposureStepCount(GoSetup setup, GoRole role);
1798 
1799 /**
1800  * Gets the maximum value for the Dynamic Exposure setting.
1801  *
1802  * @public @memberof GoSetup
1803  * @version Introduced in firmware 4.0.10.27
1804  * @param setup GoSetup object.
1805  * @param role Determines which device to retrieve the value from.
1806  * @return Maximum Dynamic Exposure value (microseconds).
1807  */
1808 GoFx(k64f) GoSetup_DynamicExposureMax(GoSetup setup, GoRole role);
1809 
1810 /**
1811  * Sets the maximum value for the Dynamic Exposure setting.
1812  *
1813  * @public @memberof GoSetup
1814  * @version Introduced in firmware 4.0.10.27
1815  * @param setup GoSetup object.
1816  * @param role Determines which sensor to apply changes to.
1817  * @param exposure Maximum Dynamic Exposure value (microseconds).
1818  * @return Operation status.
1819  */
1820 GoFx(kStatus) GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure);
1821 
1822 /**
1823  * Gets the minimum value for the Dynamic Exposure setting.
1824  *
1825  * @public @memberof GoSetup
1826  * @version Introduced in firmware 4.0.10.27
1827  * @param setup GoSetup object.
1828  * @param role Determines which device to retrieve the value from.
1829  * @return Minimum Dynamic Exposure value (microseconds).
1830  */
1831 GoFx(k64f) GoSetup_DynamicExposureMin(GoSetup setup, GoRole role);
1832 
1833 /**
1834  * Sets the minimum value for the Dynamic Exposure setting.
1835  *
1836  * @public @memberof GoSetup
1837  * @version Introduced in firmware 4.0.10.27
1838  * @param setup GoSetup object.
1839  * @param role Determines which sensor to apply changes to.
1840  * @param exposure Minumum Dynamic Exposure value (microseconds).
1841  * @return Operation status.
1842  */
1843 GoFx(kStatus) GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure);
1844 
1845 /**
1846  * Gets the minimum valid value for the ActiveAreaHeight setting.
1847  *
1848  * @public @memberof GoSetup
1849  * @version Introduced in firmware 4.0.10.27
1850  * @param setup GoSetup object.
1851  * @param role Determines which device to retrieve the value from.
1852  * @return Minimum valid ActiveAreaHeight value (mm).
1853  */
1854 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role);
1855 
1856 /**
1857  * Gets the maximum valid value for the ActiveAreaHeight setting.
1858  *
1859  * @public @memberof GoSetup
1860  * @version Introduced in firmware 4.0.10.27
1861  * @param setup GoSetup object.
1862  * @param role Determines which device to retrieve the value from.
1863  * @return Maximum valid active area height value (mm).
1864  */
1865 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role);
1866 
1867 /**
1868  * Gets the active area height.
1869  *
1870  * @public @memberof GoSetup
1871  * @version Introduced in firmware 4.0.10.27
1872  * @param setup GoSetup object.
1873  * @param role Determines which device to retrieve the value from.
1874  * @return Active area height (mm).
1875  */
1876 GoFx(k64f) GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role);
1877 
1878 /**
1879  * Sets the active area height.
1880  *
1881  * @public @memberof GoSetup
1882  * @version Introduced in firmware 4.0.10.27
1883  * @param setup GoSetup object.
1884  * @param role Determines which sensor to apply changes to.
1885  * @param value Active area height (mm).
1886  * @return Operation status.
1887  */
1888 GoFx(kStatus) GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value);
1889 
1890 /**
1891  * Gets the minimum valid value for the ActiveAreaLength setting.
1892  *
1893  * @public @memberof GoSetup
1894  * @version Introduced in firmware 4.0.10.27
1895  * @param setup GoSetup object.
1896  * @param role Determines which device to retrieve the value from.
1897  * @return Minimum valid ActiveAreaLength value (mm).
1898  */
1899 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role);
1900 
1901 /**
1902  * Gets the maximum valid value for the ActiveAreaLength setting.
1903  *
1904  * @public @memberof GoSetup
1905  * @version Introduced in firmware 4.0.10.27
1906  * @param setup GoSetup object.
1907  * @param role Determines which device to retrieve the value from.
1908  * @return Maximum valid ActiveAreaLength value (mm).
1909  */
1910 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role);
1911 
1912 /**
1913  * Sets the active area Length.
1914  *
1915  * @public @memberof GoSetup
1916  * @version Introduced in firmware 4.0.10.27
1917  * @param setup GoSetup object.
1918  * @param role Determines which sensor to apply changes to.
1919  * @param value Active area Length (mm).
1920  * @return Operation status.
1921  */
1922 GoFx(kStatus) GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value);
1923 
1924 /**
1925  * Gets the active area Length.
1926  *
1927  * @public @memberof GoSetup
1928  * @version Introduced in firmware 4.0.10.27
1929  * @param setup GoSetup object.
1930  * @param role Determines which device to retrieve the value from.
1931  * @return Active area Length (mm).
1932  */
1933 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
1934 
1935 
1936 /**
1937  * Gets the minimum valid value for the ActiveAreaWidth setting.
1938  *
1939  * @public @memberof GoSetup
1940  * @version Introduced in firmware 4.0.10.27
1941  * @param setup GoSetup object.
1942  * @param role Determines which device to retrieve the value from.
1943  * @return Minimum valid ActiveAreaWidth value (mm).
1944  */
1945 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role);
1946 
1947 /**
1948  * Gets the maximum valid value for the ActiveAreaWidth setting.
1949  *
1950  * @public @memberof GoSetup
1951  * @version Introduced in firmware 4.0.10.27
1952  * @param setup GoSetup object.
1953  * @param role Determines which device to retrieve the value from.
1954  * @return Maximum valid ActiveAreaWidth value (mm).
1955  */
1956 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role);
1957 
1958 /**
1959  * Sets the active area width.
1960  *
1961  * @public @memberof GoSetup
1962  * @version Introduced in firmware 4.0.10.27
1963  * @param setup GoSetup object.
1964  * @param role Determines which sensor to apply changes to.
1965  * @param value Active area width (mm).
1966  * @return Operation status.
1967  */
1968 GoFx(kStatus) GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value);
1969 
1970 /**
1971  * Gets the active area width.
1972  *
1973  * @public @memberof GoSetup
1974  * @version Introduced in firmware 4.0.10.27
1975  * @param setup GoSetup object.
1976  * @param role Determines which device to retrieve the value from.
1977  * @return Active area width (mm).
1978  */
1979 GoFx(k64f) GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role);
1980 
1981 /**
1982  * Gets the minimum valid value for the ActiveAreaX setting.
1983  *
1984  * @public @memberof GoSetup
1985  * @version Introduced in firmware 4.0.10.27
1986  * @param setup GoSetup object.
1987  * @param role Determines which device to retrieve the value from.
1988  * @return Minimum valid ActiveAreaX value (mm).
1989  */
1990 GoFx(k64f) GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role);
1991 
1992 /**
1993  * Gets the maximum valid value for the ActiveAreaX setting.
1994  *
1995  * @public @memberof GoSetup
1996  * @version Introduced in firmware 4.0.10.27
1997  * @param setup GoSetup object.
1998  * @param role Determines which device to retrieve the value from.
1999  * @return Maximum valid ActiveAreaX value (mm).
2000  */
2001 GoFx(k64f) GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role);
2002 
2003 /**
2004  * Sets the active area x origin.
2005  *
2006  * @public @memberof GoSetup
2007  * @version Introduced in firmware 4.0.10.27
2008  * @param setup GoSetup object.
2009  * @param role Determines which sensor to apply changes to.
2010  * @param value Active area x origin (mm).
2011  * @return Operation status.
2012  */
2013 GoFx(kStatus) GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value);
2014 
2015 /**
2016  * Gets the active area x origin.
2017  *
2018  * @public @memberof GoSetup
2019  * @version Introduced in firmware 4.0.10.27
2020  * @param setup GoSetup object.
2021  * @param role Determines which device to retrieve the value from.
2022  * @return Active area x origin (mm).
2023  */
2024 GoFx(k64f) GoSetup_ActiveAreaX(GoSetup setup, GoRole role);
2025 
2026 /**
2027  * Gets the minimum valid value for the ActiveAreaY setting.
2028  *
2029  * @public @memberof GoSetup
2030  * @version Introduced in firmware 4.0.10.27
2031  * @param setup GoSetup object.
2032  * @param role Determines which device to retrieve the value from.
2033  * @return Minimum valid ActiveAreaY value (mm).
2034  */
2035 GoFx(k64f) GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role);
2036 
2037 /**
2038  * Gets the maximum valid value for the ActiveAreaY setting.
2039  *
2040  * @public @memberof GoSetup
2041  * @version Introduced in firmware 4.0.10.27
2042  * @param setup GoSetup object.
2043  * @param role Determines which device to retrieve the value from.
2044  * @return Maximum valid ActiveAreaY value (mm).
2045  */
2046 GoFx(k64f) GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role);
2047 
2048 /**
2049  * Sets the active area Y.
2050  *
2051  * @public @memberof GoSetup
2052  * @version Introduced in firmware 4.0.10.27
2053  * @param setup GoSetup object.
2054  * @param role Determines which sensor to apply changes to.
2055  * @param value Active area y origin (mm).
2056  * @return Operation status.
2057  */
2058 GoFx(kStatus) GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value);
2059 
2060 /**
2061  * Gets the active area Y.
2062  *
2063  * @public @memberof GoSetup
2064  * @version Introduced in firmware 4.0.10.27
2065  * @param setup GoSetup object.
2066  * @param role Determines which device to retrieve the value from.
2067  * @return Active area y origin (mm).
2068  */
2069 GoFx(k64f) GoSetup_ActiveAreaY(GoSetup setup, GoRole role);
2070 
2071 /**
2072  * Gets the minimum valid value for the ActiveAreaZ setting.
2073  *
2074  * @public @memberof GoSetup
2075  * @version Introduced in firmware 4.0.10.27
2076  * @param setup GoSetup object.
2077  * @param role Determines which device to retrieve the value from.
2078  * @return Minimum valid ActiveAreaZ value (mm).
2079  */
2080 GoFx(k64f) GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role);
2081 
2082 /**
2083  * Gets the maximum valid value for the ActiveAreaZ setting.
2084  *
2085  * @public @memberof GoSetup
2086  * @version Introduced in firmware 4.0.10.27
2087  * @param setup GoSetup object.
2088  * @param role Determines which device to retrieve the value from.
2089  * @return Maximum valid ActiveAreaZ value (mm).
2090  */
2091 GoFx(k64f) GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role);
2092 
2093 /**
2094  * Sets the active area z origin.
2095  *
2096  * @public @memberof GoSetup
2097  * @version Introduced in firmware 4.0.10.27
2098  * @param setup GoSetup object.
2099  * @param role Determines which sensor to apply changes to.
2100  * @param value Active area z origin (mm).
2101  * @return Operation status.
2102  */
2103 GoFx(kStatus) GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value);
2104 
2105 /**
2106  * Gets the active area z origin.
2107  *
2108  * @public @memberof GoSetup
2109  * @version Introduced in firmware 4.0.10.27
2110  * @param setup GoSetup object.
2111  * @param role Determines which device to retrieve the value from.
2112  * @return Active area z origin (mm).
2113  */
2114 GoFx(k64f) GoSetup_ActiveAreaZ(GoSetup setup, GoRole role);
2115 
2116 /**
2117  * Gets the transformed data region X value.
2118  *
2119  * @public @memberof GoSetup
2120  * @version Introduced in firmware 4.0.10.27
2121  * @param setup GoSetup object.
2122  * @param role The device whose value to retrieve.
2123  * @return The transformed data region X value.
2124  */
2125 GoFx(k64f) GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role);
2126 
2127 /**
2128  * Gets the transformed data region Y value.
2129  *
2130  * @public @memberof GoSetup
2131  * @version Introduced in firmware 4.0.10.27
2132  * @param setup GoSetup object.
2133  * @param role The device whose value to retrieve.
2134  * @return The transformed data region Y value.
2135  */
2136 GoFx(k64f) GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role);
2137 
2138 /**
2139  * Gets the transformed data region Z value.
2140  *
2141  * @public @memberof GoSetup
2142  * @version Introduced in firmware 4.0.10.27
2143  * @param setup GoSetup object.
2144  * @param role The device whose value to retrieve.
2145  * @return The transformed data region Z value.
2146  */
2147 GoFx(k64f) GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role);
2148 
2149 /**
2150  * Gets the transformed data region width value.
2151  *
2152  * @public @memberof GoSetup
2153  * @version Introduced in firmware 4.0.10.27
2154  * @param setup GoSetup object.
2155  * @param role The device whose value to retrieve.
2156  * @return The transformed data region width value.
2157  */
2158 GoFx(k64f) GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role);
2159 
2160 /**
2161  * Gets the transformed data region length value.
2162  *
2163  * @public @memberof GoSetup
2164  * @version Introduced in firmware 4.0.10.27
2165  * @param setup GoSetup object.
2166  * @param role The device whose value to retrieve.
2167  * @return The transformed data region length value.
2168  */
2169 GoFx(k64f) GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role);
2170 
2171 /**
2172  * Gets the transformed data region height value.
2173  *
2174  * @public @memberof GoSetup
2175  * @version Introduced in firmware 4.0.10.27
2176  * @param setup GoSetup object.
2177  * @param role The device whose value to retrieve.
2178  * @return The transformed data region height value.
2179  */
2180 GoFx(k64f) GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role);
2181 
2182 /**
2183  * Gets the count of valid x-resolution options.
2184  *
2185  * @public @memberof GoSetup
2186  * @version Introduced in firmware 4.0.10.27
2187  * @param setup GoSetup object.
2188  * @param role Determines which device to retrieve the value from.
2189  * @return Count of x-resolution options.
2190  */
2191 GoFx(kSize) GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role);
2192 
2193 /**
2194  * Gets the x-resolution option at the specified index.
2195  *
2196  * @public @memberof GoSetup
2197  * @version Introduced in firmware 4.0.10.27
2198  * @param setup GoSetup object.
2199  * @param role Determines which device to retrieve the value from.
2200  * @param index Index of the desired resolution option.
2201  * @return X resolution option.
2202  * @see GoSetup_XSubsamplingOptionCount
2203  */
2204 GoFx(k32u) GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
2205 
2206 /**
2207  * Sets the current x-resolution divider.
2208  *
2209  * @public @memberof GoSetup
2210  * @version Introduced in firmware 4.0.10.27
2211  * @param setup GoSetup object.
2212  * @param role Determines which sensor to apply changes to.
2213  * @param xSubsampling X subsampling divider (e.g. 1 - full res, 2 - half res).
2214  * @return Operation status.
2215  */
2216 GoFx(kStatus) GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling);
2217 
2218 /**
2219  * Gets the current x-resolution divider.
2220  *
2221  * @public @memberof GoSetup
2222  * @version Introduced in firmware 4.0.10.27
2223  * @param setup GoSetup object.
2224  * @param role Determines which device to retrieve the value from.
2225  * @return X resolution divider (e.g. 1 - full res, 2 - half res).
2226  */
2227 GoFx(k32u) GoSetup_XSubsampling(GoSetup setup, GoRole role);
2228 
2229 /**
2230  * Gets the count of valid z-resolution options.
2231  *
2232  * @public @memberof GoSetup
2233  * @version Introduced in firmware 4.0.10.27
2234  * @param setup GoSetup object.
2235  * @param role Determines which device to retrieve the value from.
2236  * @return Count of z-resolution options.
2237  */
2238 GoFx(kSize) GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role);
2239 
2240 /**
2241  * Gets the z-resolution option at the specified index.
2242  *
2243  * @public @memberof GoSetup
2244  * @version Introduced in firmware 4.0.10.27
2245  * @param setup GoSetup object.
2246  * @param role Determines which device to retrieve the value from.
2247  * @param index Index of the desired resolution option.
2248  * @return Z resolution option.
2249  * see GoSetup_ZSubsamplingOptionCount
2250  */
2251 GoFx(k32u) GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
2252 
2253 /**
2254  * Sets the current z-resolution divider.
2255  *
2256  * @public @memberof GoSetup
2257  * @version Introduced in firmware 4.0.10.27
2258  * @param setup GoSetup object.
2259  * @param role Determines which sensor to apply changes to.
2260  * @param zSubsampling Z subsampling divider (e.g. 1 - full res, 2 - half res).
2261  * @return Operation status.
2262  */
2263 GoFx(kStatus) GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling);
2264 
2265 /**
2266  * Gets the current z-resolution divider.
2267  *
2268  * @public @memberof GoSetup
2269  * @version Introduced in firmware 4.0.10.27
2270  * @param setup GoSetup object.
2271  * @param role Determines which device to retrieve the value from.
2272  * @return Z resolution divider (e.g. 1 - full res, 2 - half res).
2273  */
2274 GoFx(k32u) GoSetup_ZSubsampling(GoSetup setup, GoRole role);
2275 
2276 /**
2277  * Gets the camera region-of-interest x origin.
2278  *
2279  * @public @memberof GoSetup
2280  * @version Introduced in firmware 4.0.10.27
2281  * @param setup GoSetup object.
2282  * @param role Determines which device to retrieve the value from.
2283  * @return Region of interest x origin (pixels).
2284  */
2285 GoFx(k32u) GoSetup_FrontCameraX(GoSetup setup, GoRole role);
2286 
2287 /**
2288  * Gets the camera region-of-interest y origin.
2289  *
2290  * @public @memberof GoSetup
2291  * @version Introduced in firmware 4.0.10.27
2292  * @param setup GoSetup object.
2293  * @param role Determines which device to retrieve the value from.
2294  * @return Region of interest y origin (pixels).
2295  */
2296 GoFx(k32u) GoSetup_FrontCameraY(GoSetup setup, GoRole role);
2297 
2298 /**
2299  * Gets the camera region-of-interest width.
2300  *
2301  * @public @memberof GoSetup
2302  * @version Introduced in firmware 4.0.10.27
2303  * @param setup GoSetup object.
2304  * @param role Determines which device to retrieve the value from.
2305  * @return Region of interest width (pixels).
2306  */
2307 GoFx(k32u) GoSetup_FrontCameraWidth(GoSetup setup, GoRole role);
2308 
2309 /**
2310  * Gets the camera region-of-interest height.
2311  *
2312  * @public @memberof GoSetup
2313  * @version Introduced in firmware 4.0.10.27
2314  * @param setup GoSetup object.
2315  * @param role Determines which device to retrieve the value from.
2316  * @return Region of interest height (pixels).
2317  */
2318 GoFx(k32u) GoSetup_FrontCameraHeight(GoSetup setup, GoRole role);
2319 
2320 /**
2321  * Returns a boolean representing whether the back camera element is used.
2322  *
2323  * @public @memberof GoSetup
2324  * @version Introduced in firmware 4.1.3.106
2325  * @param setup GoSetup object.
2326  * @param role Determines which device to retrieve the value from.
2327  * @return kTRUE if used, or kFALSE if not used.
2328  */
2329 GoFx(k32u) GoSetup_BackCameraUsed(GoSetup setup, GoRole role);
2330 
2331 /**
2332  * Gets the camera region-of-interest x origin.
2333  *
2334  * @public @memberof GoSetup
2335  * @version Introduced in firmware 4.0.10.27
2336  * @param setup GoSetup object.
2337  * @param role Determines which device to retrieve the value from.
2338  * @return Region of interest x origin (pixels).
2339  */
2340 GoFx(k32u) GoSetup_BackCameraX(GoSetup setup, GoRole role);
2341 
2342 /**
2343  * Gets the camera region-of-interest y origin.
2344  *
2345  * @public @memberof GoSetup
2346  * @version Introduced in firmware 4.0.10.27
2347  * @param setup GoSetup object.
2348  * @param role Determines which device to retrieve the value from.
2349  * @return Region of interest y origin (pixels).
2350  */
2351 GoFx(k32u) GoSetup_BackCameraY(GoSetup setup, GoRole role);
2352 
2353 /**
2354  * Gets the camera region-of-interest width.
2355  *
2356  * @public @memberof GoSetup
2357  * @version Introduced in firmware 4.0.10.27
2358  * @param setup GoSetup object.
2359  * @param role Determines which device to retrieve the value from.
2360  * @return Region of interest width (pixels).
2361  */
2362 GoFx(k32u) GoSetup_BackCameraWidth(GoSetup setup, GoRole role);
2363 
2364 /**
2365  * Gets the camera region-of-interest height.
2366  *
2367  * @public @memberof GoSetup
2368  * @version Introduced in firmware 4.0.10.27
2369  * @param setup GoSetup object.
2370  * @param role Determines which device to retrieve the value from.
2371  * @return Region of interest height (pixels).
2372  */
2373 GoFx(k32u) GoSetup_BackCameraHeight(GoSetup setup, GoRole role);
2374 
2375 /**
2376  * Enables tracking.
2377  *
2378  * @public @memberof GoSetup
2379  * @version Introduced in firmware 4.0.10.27
2380  * @param setup GoSetup object.
2381  * @param role Determines which sensor to apply changes to.
2382  * @param enable kTRUE to enable, or kFALSE to disable.
2383  * @return Operation status.
2384  */
2385 GoFx(kStatus) GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable);
2386 
2387 /**
2388  * Determines if tracking is enabled.
2389  *
2390  * @public @memberof GoSetup
2391  * @version Introduced in firmware 4.0.10.27
2392  * @param setup GoSetup object.
2393  * @param role Determines which device to retrieve the value from.
2394  * @return kTRUE if enabled, or kFALSE if disabled.
2395  */
2396 GoFx(kBool) GoSetup_TrackingEnabled(GoSetup setup, GoRole role);
2397 
2398 /**
2399  * Returns a boolean value representing whether the Tracking Enabled field is used.
2400  *
2401  * @public @memberof GoSetup
2402  * @version Introduced in firmware 4.1.3.106
2403  * @param setup GoSetup object.
2404  * @param role Determines which device to retrieve the value from.
2405  * @return kTRUE if used, or kFALSE if not used.
2406  */
2407 GoFx(kBool) GoSetup_TrackingUsed(GoSetup setup, GoRole role);
2408 
2409 /**
2410  * Sets the tracking window height.
2411  *
2412  * @public @memberof GoSetup
2413  * @version Introduced in firmware 4.0.10.27
2414  * @param setup GoSetup object.
2415  * @param role Determines which sensor to apply changes to.
2416  * @param height Tracking window height (mm).
2417  * @return Operation status.
2418  */
2419 GoFx(kStatus) GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height);
2420 
2421 /**
2422  * Gets the tracking window height.
2423  *
2424  * @public @memberof GoSetup
2425  * @version Introduced in firmware 4.0.10.27
2426  * @param setup GoSetup object.
2427  * @param role Determines which device to retrieve the value from.
2428  * @return Tracking window height (mm).
2429  */
2430 GoFx(k64f) GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role);
2431 
2432 /**
2433  * Gets the tracking window height minimum limit.
2434  *
2435  * @public @memberof GoSetup
2436  * @version Introduced in firmware 4.0.10.27
2437  * @param setup GoSetup object.
2438  * @param role Determines which device to retrieve the value from.
2439  * @return Tracking window height min(mm).
2440  */
2441 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role);
2442 
2443 /**
2444  * Gets the tracking window height maximum limit.
2445  *
2446  * @public @memberof GoSetup
2447  * @version Introduced in firmware 4.0.10.27
2448  * @param setup GoSetup object.
2449  * @param role Determines which device to retrieve the value from.
2450  * @return Tracking window height max(mm).
2451  */
2452 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role);
2453 
2454 /**
2455  * Sets the tracking window search threshold.
2456  *
2457  * @public @memberof GoSetup
2458  * @version Introduced in firmware 4.0.10.27
2459  * @param setup GoSetup object.
2460  * @param role Determines which sensor to apply changes to.
2461  * @param threshold Tracking window search threshold (%)
2462  * @return Operation status.
2463  */
2464 GoFx(kStatus) GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold);
2465 
2466 /**
2467  * Gets the tracking window search threshold.
2468  *
2469  * @public @memberof GoSetup
2470  * @version Introduced in firmware 4.0.10.27
2471  * @param setup GoSetup object.
2472  * @param role Determines which device to retrieve the value from.
2473  * @return Tracking window search threshold (%).
2474  */
2475 GoFx(k64f) GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role);
2476 
2477 /**
2478  * Returns the state of whether the user specified spacing interval is used.
2479  *
2480  * @public @memberof GoSetup
2481  * @version Introduced in firmware 4.0.10.27
2482  * @param setup GoSetup object.
2483  * @param role Determines which device to retrieve the value from.
2484  * @return kTRUE if the user value is used and kFALSE otherwise.
2485  */
2486 GoFx(kBool) GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role);
2487 
2488 /**
2489  * Gets the spacing interval system value.
2490  *
2491  * @public @memberof GoSetup
2492  * @version Introduced in firmware 4.0.10.27
2493  * @param setup GoSetup object.
2494  * @param role Determines which device to retrieve the value from.
2495  * @return Spacing interval.
2496  */
2497 GoFx(k64f) GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role);
2498 
2499 /**
2500  * Gets the spacing interval.
2501  *
2502  * @public @memberof GoSetup
2503  * @version Introduced in firmware 4.0.10.27
2504  * @param setup GoSetup object.
2505  * @param role Determines which device to retrieve the value from.
2506  * @return Spacing interval.
2507  */
2508 GoFx(k64f) GoSetup_SpacingInterval(GoSetup setup, GoRole role);
2509 
2510 /// @cond (Gocator_3x00)
2511 /**
2512  * Sets the spacing interval.
2513  *
2514  * @public @memberof GoSetup
2515  * @version Introduced in firmware 4.0.10.27
2516  * @param setup GoSetup object.
2517  * @param role Determines which sensor to apply changes to.
2518  * @param value The spacing interval.
2519  * @return Operation status.
2520  */
2521 GoFx(kStatus) GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value);
2522 /// @endcond
2523 
2524 /**
2525  * Gets the spacing interval value limit minimum.
2526  *
2527  * @public @memberof GoSetup
2528  * @version Introduced in firmware 4.0.10.27
2529  * @param setup GoSetup object.
2530  * @param role Determines which device to retrieve the value from.
2531  * @return Spacing interval value limit minimum.
2532  */
2533 GoFx(k64f) GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role);
2534 
2535 /**
2536  * Gets the spacing interval value limit maximum
2537  *
2538  * @public @memberof GoSetup
2539  * @version Introduced in firmware 4.0.10.27
2540  * @param setup GoSetup object.
2541  * @param role Determines which device to retrieve the value from.
2542  * @return Spacing interval value limit maximum.
2543  */
2544 GoFx(k64f) GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role);
2545 
2546 /**
2547  * Gets the spacing interval type.
2548  *
2549  * @public @memberof GoSetup
2550  * @version Introduced in firmware 4.0.10.27
2551  * @param setup GoSetup object.
2552  * @param role Determines which device to retrieve the value from.
2553  * @return The spacing interval type.
2554  */
2555 GoFx(GoSpacingIntervalType) GoSetup_SpacingIntervalType(GoSetup setup, GoRole role);
2556 
2557 /**
2558  * Sets the spacing interval type.
2559  *
2560  * @public @memberof GoSetup
2561  * @version Introduced in firmware 4.0.10.27
2562  * @param setup GoSetup object.
2563  * @param role Determines which sensor to apply changes to.
2564  * @param type The spacing interval type.
2565  * @return Operation status.
2566  */
2567 GoFx(kStatus) GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type);
2568 
2569 /**
2570  * Gets the system value representing whether or not the user specified spacing interval type setting is being used at the moment.
2571  *
2572  * @public @memberof GoSetup
2573  * @version Introduced in firmware 4.0.10.27
2574  * @param setup GoSetup object.
2575  * @param role The device role from which to retrieve the setting.
2576  * @return kTRUE if the user specified spacing interval type setting is used and kFALSE otherwise.
2577  */
2578 GoFx(kBool) GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role);
2579 
2580 /**
2581  * Gets the X spacing count.
2582  *
2583  * @public @memberof GoSetup
2584  * @version Introduced in firmware 4.0.10.27
2585  * @param setup GoSetup object.
2586  * @param role Determines which device to retrieve the value from.
2587  * @return X spacing count.
2588  */
2589 GoFx(k32u) GoSetup_XSpacingCount(GoSetup setup, GoRole role);
2590 
2591 /**
2592  * Gets the Y spacing count.
2593  *
2594  * @public @memberof GoSetup
2595  * @version Introduced in firmware 4.0.10.27
2596  * @param setup GoSetup object.
2597  * @param role Determines which device to retrieve the value from.
2598  * @return Y spacing count.
2599  */
2600 GoFx(k32u) GoSetup_YSpacingCount(GoSetup setup, GoRole role);
2601 
2602 /**
2603  * Gets the intensity step index.
2604  *
2605  * @public @memberof GoSetup
2606  * @version Introduced in firmware 4.0.10.27
2607  * @param setup GoSetup object.
2608  * @param role Determines which device to retrieve the value from.
2609  * @return The intensity step index.
2610  */
2611 GoFx(kSize) GoSetup_IntensityStepIndex(GoSetup setup, GoRole role);
2612 
2613 /**
2614  * Sets the intensity step index.
2615  *
2616  * @public @memberof GoSetup
2617  * @version Introduced in firmware 4.0.10.27
2618  * @param setup GoSetup object.
2619  * @param role Determines which sensor to apply changes to.
2620  * @param index The exposure step index to use for intensity acquisition.
2621  * @return Operation status.
2622  * @see GoSetup_SetExposureMode, GoSetup_ExposureStepCount
2623  */
2624 GoFx(kStatus) GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index);
2625 
2626 /**
2627  * Gets the pattern sequence type option count.
2628  *
2629  * @public @memberof GoSetup
2630  * @version Introduced in firmware 4.2.4.7
2631  * @param setup GoSetup object.
2632  * @param role Determines which device to retrieve the value from.
2633  * @return Pattern sequence type option count.
2634  */
2635 GoFx(kSize) GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role);
2636 
2637 /**
2638  * Gets the pattern sequence type option at the given index.
2639  *
2640  * @public @memberof GoSetup
2641  * @version Introduced in firmware 4.2.4.7
2642  * @param setup GoSetup object.
2643  * @param role Determines which device to retrieve the value from.
2644  * @param index The index with which to retrieve a sequence type option.
2645  * @return A sequence type option value.
2646  * @see GoSetup_PatternSequenceOptionCount
2647  */
2648 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index);
2649 
2650 /**
2651  * Gets the pattern sequence type.
2652  *
2653  * @public @memberof GoSetup
2654  * @version Introduced in firmware 4.2.4.7
2655  * @param setup GoSetup object.
2656  * @param role Determines which device to retrieve the value from.
2657  * @return The pattern sequence type.
2658  */
2659 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceType(GoSetup setup, GoRole role);
2660 
2661 /**
2662  * Sets the pattern sequence type.
2663  *
2664  * @public @memberof GoSetup
2665  * @version Introduced in firmware 4.2.4.7
2666  * @param setup GoSetup object.
2667  * @param role Determines which sensor to apply changes to.
2668  * @param type The pattern sequence type to set.
2669  * @return Operation status.
2670  */
2671 GoFx(kStatus) GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type);
2672 
2673 /**
2674  * Returns a boolean value representing whether the pattern sequence type is used.
2675  *
2676  * @public @memberof GoSetup
2677  * @version Introduced in firmware 4.2.4.7
2678  * @param setup GoSetup object.
2679  * @param role Determines which device to retrieve the value from.
2680  * @return kTRUE if used and kFALSE otherwise.
2681  */
2682 GoFx(kBool) GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role);
2683 
2684 /**
2685  * Gets the current pattern sequence count.
2686  *
2687  * @public @memberof GoSetup
2688  * @version Introduced in firmware 4.2.4.7
2689  * @param setup GoSetup object.
2690  * @param role Determines which device to retrieve the value from.
2691  * @return The current pattern sequence count.
2692  */
2693 GoFx(kSize) GoSetup_PatternSequenceCount(GoSetup setup, GoRole role);
2694 
2695 
2696 /**
2697  * Gets the layout configuration module.
2698  *
2699  * @public @memberof GoSetup
2700  * @version Introduced in firmware 4.0.10.27
2701  * @param setup GoSetup object.
2702  * @return Layout configuration module.
2703  */
2704 GoFx(GoLayout) GoSetup_Layout(GoSetup setup);
2705 
2706 /**
2707  * Gets the profile generation module, used for profile generation configuration.
2708  *
2709  * @public @memberof GoSetup
2710  * @version Introduced in firmware 4.2.4.7
2711  * @param setup GoSetup object.
2712  * @return Profile generation configuration module.
2713  */
2714 GoFx(GoProfileGeneration) GoSetup_ProfileGeneration(GoSetup setup);
2715 
2716 /**
2717  * Gets the surface generation module, used for surface generation configuration.
2718  *
2719  * @public @memberof GoSetup
2720  * @version Introduced in firmware 4.0.10.27
2721  * @param setup GoSetup object.
2722  * @return Surface generation configuration module.
2723  */
2724 GoFx(GoSurfaceGeneration) GoSetup_SurfaceGeneration(GoSetup setup);
2725 
2726 /**
2727  * Gets the part detection module, used for part detection configuration.
2728  *
2729  * @public @memberof GoSetup
2730  * @version Introduced in firmware 4.0.10.27
2731  * @param setup GoSetup object.
2732  * @return Part detection configuration module.
2733  */
2734 GoFx(GoPartDetection) GoSetup_PartDetection(GoSetup setup);
2735 
2736 /**
2737  * Gets the part matching module, used for part matching configuration.
2738  *
2739  * @public @memberof GoSetup
2740  * @version Introduced in firmware 4.2.4.7
2741  * @param setup GoSetup object.
2742  * @return Part matching configuration module.
2743  */
2744 GoFx(GoPartMatching) GoSetup_PartMatching(GoSetup setup);
2745 
2746 /**
2747  * Gets the material acquisition module, used for material acquisition configuration.
2748  *
2749  * @public @memberof GoSetup
2750  * @version Introduced in firmware 4.1.3.106
2751  * @param setup GoSetup object.
2752  * @param role The device role whose material settings object to return.
2753  * @return Material acquisition configuration module.
2754  */
2755 GoFx(GoMaterial) GoSetup_Material(GoSetup setup, GoRole role);
2756 
2757 /**
2758  * Gets the Section configuration module, used for surface sections.
2759  *
2760  * @public @memberof GoSetup
2761  * @version Introduced in firmware 4.4.4.14
2762  * @param setup GoSetup object.
2763  * @return Section configuration module.
2764  */
2765 GoFx(GoSections) GoSetup_Sections(GoSetup setup);
2766 
2767 /**
2768  * Gets the tracheid configuration module.
2769  *
2770  * @public @memberof GoSetup
2771  * @version Introduced in firmware 4.5.3.57
2772  * @param setup GoSetup object.
2773  * @param role Determines which device to retrieve the value from.
2774  * @return Tracheid configuration module.
2775  */
2776 GoFx(GoTracheid) GoSetup_Tracheid(GoSetup setup, GoRole role);
2777 
2778 
2779 kEndHeader()
2780 #include <GoSdk/GoSetup.x.h>
2781 
2782 #endif
GoSetup::GoSetup_InputTriggerEnabledSystemValue
kBool GoSetup_InputTriggerEnabledSystemValue(GoSetup setup)
Gets the input trigger 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_SetXDecimationWindow
kStatus GoSetup_SetXDecimationWindow(GoSetup setup, k64f window)
Sets the x-direction decimation window.
GoSetup::GoSetup_ActiveAreaZLimitMin
k64f GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaZ setting.
GoSetup::GoSetup_UniformSpacingEnabledSystemValue
kBool GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup)
Gets the Uniform Spacing enabled system value.
GoSetup::GoSetup_ActiveAreaWidth
k64f GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role)
Gets the active area width.
GoSetup::GoSetup_XGapFillingUsed
kBool GoSetup_XGapFillingUsed(GoSetup setup)
Indicates whether X gap filling can be used for the current scan mode and device family.
GoSetup::GoSetup_TriggerGateEnabled
kBool GoSetup_TriggerGateEnabled(GoSetup setup)
Reports whether the trigger gate feature is currently enabled.
GoSetup::GoSetup_XGapFillingWindowLimitMax
k64f GoSetup_XGapFillingWindowLimitMax(GoSetup setup)
Gets the x-direction gap-filling window maximum.
GoSetup::GoSetup_AlignmentMovingTargetOptionAt
GoAlignmentTarget GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index)
Gets the moving alignment target option at the given index.
GoSetup::GoSetup_ActiveAreaXLimitMax
k64f GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaX setting.
GoSetup::GoSetup_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.
GoSetup::GoSetup_UniformSpacingAvailable
kBool GoSetup_UniformSpacingAvailable(GoSetup setup)
Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used a...
GoSetup::GoSetup_Exposure
k64f GoSetup_Exposure(GoSetup setup, GoRole role)
Gets the exposure value.
GoSetup::GoSetup_XMedianWindow
k64f GoSetup_XMedianWindow(GoSetup setup)
Gets the x-direction median window.
GoSetup::GoSetup_XGapFillingWindow
k64f GoSetup_XGapFillingWindow(GoSetup setup)
Gets the x-direction gap-filling window.
GoSetup::GoSetup_YGapFillingEnabled
kBool GoSetup_YGapFillingEnabled(GoSetup setup)
Gets the status of y-direction gap-filling.
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_ZSubsamplingOptionAt
k32u GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the z-resolution option at the specified index.
GoPartDetection.h
Declares the GoPartDetection class.
GoSetup::GoSetup_EnableMaxFrameRate
kStatus GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable)
Enables or disables operation at full frame rate (ignoring frame rate setting).
GoSetup::GoSetup_TrackingAreaHeight
k64f GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role)
Gets the tracking window height.
GoSetup::GoSetup_ActiveAreaYLimitMin
k64f GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_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_SetActiveAreaWidth
kStatus GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value)
Sets the active area width.
GoSections.h
Declares the GoSections class.
GoSetup::GoSetup_BackCameraX
k32u GoSetup_BackCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
GoSetup::GoSetup_XSubsamplingOptionCount
kSize GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid x-resolution options.
GoSetup::GoSetup_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_YSmoothingUsed
kBool GoSetup_YSmoothingUsed(GoSetup setup)
Indicates whether Y smoothing can be used for the current scan mode and device family.
GoSetup::GoSetup_TransformedDataRegionLength
k64f GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role)
Gets the transformed data region length value.
GoSetup::GoSetup_UniformSpacingEnabled
kBool GoSetup_UniformSpacingEnabled(GoSetup setup)
Gets the user specified Uniform Spacing enabled state.
GoSetup::GoSetup_IntensityEnabled
kBool GoSetup_IntensityEnabled(GoSetup setup)
Reports whether the profile intensity collection is enabled.
GoSetup::GoSetup_SetZSubsampling
kStatus GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling)
Sets the current z-resolution divider.
GoSetup::GoSetup_XDecimationEnabled
kBool GoSetup_XDecimationEnabled(GoSetup setup)
Gets the status of x-direction decimation.
GoSetup::GoSetup_AlignmentTypeOptionCount
kSize GoSetup_AlignmentTypeOptionCount(GoSetup setup)
Gets the alignment type option count.
GoSetup::GoSetup_EnableTriggerGate
kStatus GoSetup_EnableTriggerGate(GoSetup setup, kBool enable)
Sets the trigger gate feature.
GoSetup::GoSetup_YSmoothingWindow
k64f GoSetup_YSmoothingWindow(GoSetup setup)
Gets the y-direction smoothing window.
GoSetup::GoSetup_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.
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_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_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_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.
GoSetup::GoSetup_SetYGapFillingWindow
kStatus GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window)
Sets the y-direction gap-filling window.
GoSetup::GoSetup_SetPlateRefHoleDiameter
kStatus GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_BackCameraHeight
k32u GoSetup_BackCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
GoSetup::GoSetup_FrameRate
k64f GoSetup_FrameRate(GoSetup setup)
Reports the currently configured frame rate.
GoSetup::GoSetup_BackCameraUsed
k32u GoSetup_BackCameraUsed(GoSetup setup, GoRole role)
Returns a boolean representing whether the back camera element is used.
GoSetup::GoSetup_EnableUniformSpacing
kStatus GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable)
Sets the user specified Uniform Spacing enabled state.
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.
GoTrigger
Represents a trigger.
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_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_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_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)
Gets the material acquisition module, used for material acquisition configuration.
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_AlignmentMovingTarget
GoAlignmentTarget GoSetup_AlignmentMovingTarget(GoSetup setup)
Gets the target type used for moving alignment calibration.
GoSetup::GoSetup_YGapFillingWindow
k64f GoSetup_YGapFillingWindow(GoSetup setup)
Gets the y-direction gap-filling window.
GoSetup::GoSetup_XSmoothingWindow
k64f GoSetup_XSmoothingWindow(GoSetup setup)
Gets the x-direction smoothing window.
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_ScanModeOptionCount
kSize GoSetup_ScanModeOptionCount(GoSetup setup)
Gets the scan mode option count.
GoSetup::GoSetup_TriggerGateEnabledSystemValue
kBool GoSetup_TriggerGateEnabledSystemValue(GoSetup setup)
Reports the trigger gate enabled system value.
GoSurfaceGeneration
Represents a surface generation configuration.
GoSetup::GoSetup_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_YMedianWindow
k64f GoSetup_YMedianWindow(GoSetup setup)
Gets the y-direction median window.
GoSetup::GoSetup_YDecimationWindow
k64f GoSetup_YDecimationWindow(GoSetup setup)
Gets the y-direction decimation window.
GoSetup::GoSetup_BarHoleDistance
k64f GoSetup_BarHoleDistance(GoSetup setup)
Gets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_YGapFillingWindowLimitMax
k64f GoSetup_YGapFillingWindowLimitMax(GoSetup setup)
Gets the y-direction gap-filling window maximum.
GoSetup::GoSetup_InputTriggerEnabledUsed
kBool GoSetup_InputTriggerEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user input trigger configuration is used.
GoSetup::GoSetup_XDecimationUsed
kBool GoSetup_XDecimationUsed(GoSetup setup)
Indicates whether X decimation can be used for the current scan mode and device family.
GoSetup::GoSetup_BarWidth
k64f GoSetup_BarWidth(GoSetup setup)
Gets the width of the bar used for travel calibration.
GoSetup::GoSetup_InputTriggerEnabled
kBool GoSetup_InputTriggerEnabled(GoSetup setup)
Gets the input trigger enabled state.
GoSetup::GoSetup_XMedianWindowLimitMax
k64f GoSetup_XMedianWindowLimitMax(GoSetup setup)
Gets the x-direction median window maximum.
GoSetup::GoSetup_SpacingIntervalLimitMin
k64f GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role)
Gets the spacing interval value limit minimum.
GoSetup::GoSetup_EnableIntensity
kStatus GoSetup_EnableIntensity(GoSetup setup, kBool enable)
Enables profile intensity collection.
GoPartDetection
Represents the part detection parameters of the surface mode configuration.
GoSetup::GoSetup_SetTriggerSource
kStatus GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source)
Sets the trigger source for profile triggering.
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 default operation mode of the sensor system.
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_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_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_YDecimationEnabled
kBool GoSetup_YDecimationEnabled(GoSetup setup)
Gets the status of y-direction decimation.
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_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.
GoSetup::GoSetup_SetActiveAreaZ
kStatus GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value)
Sets the active area z origin.
GoAlignmentTarget
Represents a alignment target type.
GoExposureMode
Represents all possible exposure modes.
GoSetup::GoSetup_TriggerSource
GoTrigger GoSetup_TriggerSource(GoSetup setup)
Gets the trigger source for profile triggering.
GoSetup::GoSetup_YSmoothingWindowLimitMax
k64f GoSetup_YSmoothingWindowLimitMax(GoSetup setup)
Gets the y-direction smoothing window maximum.
GoSetup::GoSetup_SetPatternSequenceType
kStatus GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type)
Sets the pattern sequence type.
GoSetup::GoSetup_ClearExposureSteps
kStatus GoSetup_ClearExposureSteps(GoSetup setup, GoRole role)
Removes all exposure steps.
GoSetup::GoSetup_SetTriggerDelay
kStatus GoSetup_SetTriggerDelay(GoSetup setup, k64f delay)
Sets the trigger delay.
GoSurfaceGeneration.h
Declares the GoSurfaceGeneration class.
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_TriggerDelayLimitMax
k64f GoSetup_TriggerDelayLimitMax(GoSetup setup)
Reports the maximum trigger delay, based on current settings.
GoSetup::GoSetup_XSmoothingEnabled
kBool GoSetup_XSmoothingEnabled(GoSetup setup)
Gets the status of x-direction smoothing.
GoSetup::GoSetup_PatternSequenceTypeUsed
kBool GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the pattern sequence type is used.
GoSetup::GoSetup_ExposureModeOptionAt
GoExposureMode GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the exposure mode option at the given index.
GoSetup::GoSetup_SetBarWidth
kStatus GoSetup_SetBarWidth(GoSetup setup, k64f width)
Sets the width of the bar used for travel calibration.
GoSetup::GoSetup_SetOcclusionReductionAlg
kStatus GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg)
Sets the occlusion reduction algorithm.
GoSetup::GoSetup_BackCameraWidth
k32u GoSetup_BackCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
GoSetup::GoSetup_PlateRefHoleDiameter
k64f GoSetup_PlateRefHoleDiameter(GoSetup setup)
Gets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_DynamicExposureMax
k64f GoSetup_DynamicExposureMax(GoSetup setup, GoRole role)
Gets the maximum value for the Dynamic Exposure setting.
GoSpacingIntervalType
Represents spacing interval types.
GoSetup::GoSetup_ExposureStepCount
kSize GoSetup_ExposureStepCount(GoSetup setup, GoRole role)
Get the number of exposure steps defined.
GoSetup::GoSetup_EnableInputTrigger
kStatus GoSetup_EnableInputTrigger(GoSetup setup, kBool enable)
Sets the input trigger enabled state.
GoSetup::GoSetup_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.
GoSetup::GoSetup_EnableYGapFilling
kStatus GoSetup_EnableYGapFilling(GoSetup setup, kBool enable)
Sets the status of y-direction gap-filling.
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_ExposureModeOptionCount
kSize GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role)
Gets the exposure mode option count.
GoSetup::GoSetup_ActiveAreaHeight
k64f GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role)
Gets the active area height.
GoSetup::GoSetup_EnableOcclusionReduction
kStatus GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable)
Sets the occlusion reduction enabled state.
GoSetup::GoSetup_TransformedDataRegionY
k64f GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role)
Gets the transformed data region Y value.
GoOcclusionReductionAlg
Represents an occlusion reduction algorithm.
GoSetup::GoSetup_ExposureMode
GoExposureMode GoSetup_ExposureMode(GoSetup setup, GoRole role)
Gets the exposure mode.
GoSetup::GoSetup_SetYSmoothingWindow
kStatus GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window)
Sets the y-direction smoothing window.
GoPartMatching
Represents the part matching parameters of the surface mode configuration.
GoSetup::GoSetup_TransformedDataRegionHeight
k64f GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role)
Gets the transformed data region height value.
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_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_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_YGapFillingUsed
kBool GoSetup_YGapFillingUsed(GoSetup setup)
Indicates whether Y gap filling can be used for the current scan mode and device family.
GoSetup::GoSetup_SetDynamicExposureMin
kStatus GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure)
Sets the minimum value for the Dynamic Exposure setting.
GoSetup::GoSetup_SetActiveAreaHeight
kStatus GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value)
Sets the active area height.
GoSetup::GoSetup_EnableYSlope
kStatus GoSetup_EnableYSlope(GoSetup setup, kBool enable)
Sets the status of y-direction slope.
GoSetup::GoSetup_ProfileGeneration
GoProfileGeneration GoSetup_ProfileGeneration(GoSetup setup)
Gets the profile generation module, used for profile generation configuration.
GoSetup::GoSetup_XSlopeWindow
k64f GoSetup_XSlopeWindow(GoSetup setup)
Gets the x-direction slope window.
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_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 default operation mode of the sensor system.
GoSetup::GoSetup_XDecimationWindowLimitMax
k64f GoSetup_XDecimationWindowLimitMax(GoSetup setup)
Gets the x-direction decimation window maximum.
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_SetTriggerUnit
kStatus GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit)
Sets the system trigger units.
GoSetup::GoSetup_YGapFillingWindowLimitMin
k64f GoSetup_YGapFillingWindowLimitMin(GoSetup setup)
Gets the y-direction gap-filling window minimum.
GoSetup::GoSetup_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.
GoPartMatching.h
Declares the GoPartMatching class.
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_TrackingEnabled
kBool GoSetup_TrackingEnabled(GoSetup setup, GoRole role)
Determines if tracking is enabled.
GoSetup::GoSetup_AlignmentEncoderCalibrateEnabled
kBool GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup)
Gets the value of the post alignment encoder calibration setting.
GoSetup::GoSetup_YSmoothingWindowLimitMin
k64f GoSetup_YSmoothingWindowLimitMin(GoSetup setup)
Gets the y-direction smoothing window minimum.
GoSections
Represents the collection of sections and limits for defining them.
GoSetup::GoSetup_SetXSubsampling
kStatus GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling)
Sets the current x-resolution divider.
GoLayout.h
Declares the GoLayout class.
GoSetup::GoSetup_SetYDecimationWindow
kStatus GoSetup_SetYDecimationWindow(GoSetup setup, k64f window)
Sets the y-direction decimation window.
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_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.