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