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