Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups 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) 2011-2012 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_API_SETUP_H
11 #define GO_API_SETUP_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoLayout.h>
16 #include <GoSdk/GoPartDetection.h>
17 kBeginHeader()
18 
19 /**
20  * @class GoSetup
21  * @extends kObject
22  * @ingroup GoSdk
23  * @brief Represents a ...
24  */
25 typedef kObject GoSetup;
26 
27 GoFx(kStatus) GoSetup_EnableTemperatureSafety( GoSetup setup, kBool enable);
28 GoFx(kBool) GoSetup_TemperatureSafetyEnabled(GoSetup setup);
29 GoFx(kBool) GoSetup_TemperatureSafetyValueUsed(GoSetup setup);
30 
31 /**
32  * Sets the default operation mode of the sensor system.
33  *
34  * @public @memberof GoSetup
35  * @param setup GoSetup object.
36  * @param mode Operation mode.
37  * @return Operation status.
38  */
39 GoFx(kStatus) GoSetup_SetScanMode(GoSetup setup, GoMode mode);
40 
41 /**
42  * Gets the default operation mode of the sensor system.
43  *
44  * @public @memberof GoSetup
45  * @param setup GoSetup object.
46  * @return Operation mode.
47  */
48 GoFx(GoMode) GoSetup_ScanMode(GoSetup setup);
49 GoFx(GoMode) GoSetup_ScanModeOptionAt(GoSetup setup, k32u index);
50 GoFx(kSize) GoSetup_ScanModeOptionCount(GoSetup setup);
51 
52 /// @cond Gocator_2x00
53 
54 GoFx(kBool) GoSetup_UniformSpacingEnabled(GoSetup setup);
55 GoFx(kStatus) GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable);
56 GoFx(kBool) GoSetup_UniformSpacingAvailable(GoSetup setup);
57 
58 /// @endcond
59 
60 GoFx(kBool) GoSetup_OcclusionReductionEnabled(GoSetup setup);
61 GoFx(kStatus) GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable);
62 
63 GoFx(kStatus) GoSetup_SetMaterial(GoSetup setup, GoMaterialType material);
64 GoFx(GoMaterialType) GoSetup_Material(GoSetup setup);
65 GoFx(GoMaterialType) GoSetup_MaterialOptionAt(GoSetup setup, k32u index);
66 GoFx(kSize) GoSetup_MaterialOptionCount(GoSetup setup);
67 
68 //class - spot detection
69 GoFx(k32u) GoSetup_SpotDetectionThreshold(GoSetup setup);
70 GoFx(kStatus) GoSetup_SetSpotDetectionThreshold(GoSetup setup, k32u value);
71 GoFx(k32u) GoSetup_SpotDetectionMaxWidth(GoSetup setup);
72 GoFx(kStatus) GoSetup_SetSpotDetectionMaxWidth(GoSetup setup, k32u value);
73 GoFx(GoSpotDetectionType) GoSetup_SpotDetectionType(GoSetup setup);
74 GoFx(kStatus) GoSetup_SetSpotDetectionType(GoSetup setup, GoSpotDetectionType value);
75 
76 GoFx(GoSpotSelectionType) GoSetup_SpotSelectionType(GoSetup setup);
77 GoFx(kStatus) GoSetup_SetSpotSelectionType(GoSetup setup, GoSpotSelectionType value);
78 
79 /**
80  * Sets the default state of the sensor system upon boot.
81  *
82  * @public @memberof GoSetup
83  * @param setup GoSetup object.
84  * @param state Default state.
85  * @return Operation status.
86  */
87 GoFx(kStatus) GoSetup_SetDefaultState(GoSetup setup, GoState state);
88 
89 /**
90  * Gets the default state of the sensor system upon boot.
91  *
92  * @public @memberof GoSetup
93  * @param setup GoSetup object
94  * @return Default state.
95  */
96 GoFx(GoState) GoSetup_DefaultState(GoSetup setup);
97 
98 
99 //class - trigger
100 
101 /**
102  * Sets the system trigger units.
103  * Ignored if GoSetup_TriggerSource is time or encoder
104  *
105  * @public @memberof GoSetup
106  * @param setup GoSetup object.
107  * @param unit The system trigger unit.
108  * @return Operation status.
109  */
110 GoFx(kStatus) GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit);
111 
112 /**
113  * Gets the system trigger units.
114  * Ignored if GoSetup_TriggerSource is time or encoder
115  *
116  * @public @memberof GoSetup
117  * @param setup GoSetup object.
118  * @return The system domain.
119  */
120 GoFx(GoTriggerUnits) GoSetup_TriggerUnit(GoSetup setup);
121 
122 /**
123  * Sets the trigger source for profile triggering.
124  *
125  * @public @memberof GoSetup
126  * @param setup GoSetup object.
127  * @param source Profile trigger source.
128  * @return Operation status.
129  */
130 GoFx(kStatus) GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source);
131 
132 /**
133  * Gets the trigger source for profile triggering.
134  *
135  * @public @memberof GoSetup
136  * @param setup GoSetup object.
137  * @return Profile trigger source.
138  */
139 GoFx(GoTrigger) GoSetup_TriggerSource(GoSetup setup);
140 
141 /**
142  * Sets the trigger delay. Depending on GoDomain, units are uS or mm.
143  *
144  * @public @memberof GoSetup
145  * @param setup GoSetup object.
146  * @param delay Trigger delay (uS or mm).
147  * @return Operation status.
148  */
149 GoFx(kStatus) GoSetup_SetTriggerDelay(GoSetup setup, k64f delay);
150 
151 /**
152  * Gets the trigger delay. Depending on GoDomain, units are uS or mm.
153  *
154  * @public @memberof GoSetup
155  * @param setup GoSetup object.
156  * @return Trigger delay (uS or mm).
157  */
158 GoFx(k64f) GoSetup_TriggerDelay(GoSetup setup);
159 
160 /**
161  * Reports the minimum trigger delay, based on current settings.
162  * Depending on GoDomain, units are uS or mm.
163  *
164  * @public @memberof GoSetup
165  * @param setup GoSetup object.
166  * @return Minimum trigger delay (uS or mm).
167  */
168 GoFx(k64f) GoSetup_TriggerDelayLimitMin(GoSetup setup);
169 
170 /**
171  * Reports the maximum trigger delay, based on current settings.
172  * Depending on GoDomain, units are uS or mm.
173  *
174  * @public @memberof GoSetup
175  * @param setup GoSetup object.
176  * @return Maximum trigger delay (uS or mm).
177  */
178 GoFx(k64f) GoSetup_TriggerDelayLimitMax(GoSetup setup);
179 
180 /**
181  * Sets the trigger gate feature.
182  *
183  * @public @memberof GoSetup
184  * @param setup GoSetup object.
185  * @param enable Enables trigger gate operation.
186  * @return Operation status.
187  */
188 GoFx(kStatus) GoSetup_EnableTriggerGate(GoSetup setup, kBool enable);
189 
190 /**
191  * Reports whether the trigger gate feature is currently enabled.
192  *
193  * @public @memberof GoSetup
194  * @param setup GoSetup object.
195  * @return kTRUE if enabled, or kFALSE if disabled.
196  */
197 GoFx(kBool) GoSetup_TriggerGateEnabled(GoSetup setup);
198 
199 /**
200  * Enables or disables operation at full frame rate (ignoring frame rate setting).
201  *
202  * @public @memberof GoSetup
203  * @param setup GoSetup object.
204  * @param enable Enables full frame rate operation.
205  * @return Operation status.
206  */
207 GoFx(kStatus) GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable);
208 
209 /**
210  * Reports whether or not system is configured to operate at full frame rate.
211  *
212  * @public @memberof GoSetup
213  * @param setup GoSetup object.
214  * @return True if system operates at full frame rate; false otherwise.
215  */
216 GoFx(kBool) GoSetup_MaxFrameRateEnabled(GoSetup setup);
217 
218 /**
219  * Sets the current frame rate for time-based triggering. Note, calling this function also
220  * implicitly disables the FullFrameRate option.
221  *
222  * @public @memberof GoSetup
223  * @param setup GoSetup object.
224  * @param frameRate Frame Rate value (hz).
225  * @return Operation status.
226  */
227 GoFx(kStatus) GoSetup_SetFrameRate(GoSetup setup, k64f frameRate);
228 
229 /**
230  * Reports the currently configured frame rate.
231  *
232  * @public @memberof GoSetup
233  * @param setup GoSetup object.
234  * @return Maximum frame rate (Hz).
235  */
236 GoFx(k64f) GoSetup_FrameRate(GoSetup setup);
237 
238 /**
239  * Constraint for the minimum valid value of the Frame Rate setting.
240  *
241  * @public @memberof GoSetup
242  * @param setup GoSetup object.
243  * @return Minimum valid Frame Rate setting (hz).
244  */
245 GoFx(k64f) GoSetup_FrameRateLimitMin(GoSetup setup);
246 
247 /**
248  * Constraint for the maximum valid value of the Frame Rate setting.
249  *
250  * @public @memberof GoSetup
251  * @param setup GoSetup object.
252  * @return Maximum valid Frame Rate setting (hz).
253  */
254 GoFx(k64f) GoSetup_FrameRateLimitMax(GoSetup setup);
255 
256 /**
257  * Sets the encoder trigger mode.
258  *
259  * @public @memberof GoSetup
260  * @param setup GoSetup object.
261  * @param mode Encoder trigger mode.
262  * @return Profile trigger source.
263  */
264 GoFx(kStatus) GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode);
265 
266 /**
267  * Gets the encoder trigger mode.
268  *
269  * @public @memberof GoSetup
270  * @param setup GoSetup object.
271  * @return Encoder trigger mode.
272  */
273 GoFx(GoEncoderTriggerMode) GoSetup_EncoderTriggerMode(GoSetup setup);
274 
275 /**
276  * Sets the current encoder period for encoder-based triggering.
277  *
278  * @public @memberof GoSetup
279  * @param setup GoSetup object.
280  * @param period Encoder period (mm).
281  * @return Operation status.
282  */
283 GoFx(kStatus) GoSetup_SetEncoderSpacing(GoSetup setup, k64f period);
284 
285 /**
286  * Gets the current encoder period for encoder-based triggering.
287  *
288  * @public @memberof GoSetup
289  * @param setup GoSetup object.
290  * @return Encoder period (mm).
291  */
292 GoFx(k64f) GoSetup_EncoderSpacing(GoSetup setup);
293 
294 /**
295  * Constraint for the minimum valid value of the EncoderPeriod setting.
296  *
297  * @public @memberof GoSetup
298  * @param setup GoSetup object.
299  * @return Minimum valid EncoderPeriod setting (mm).
300  */
301 GoFx(k64f) GoSetup_EncoderSpacingLimitMin(GoSetup setup);
302 
303 /**
304  * Constraint for the maximum valid value of the EncoderPeriod setting.
305  *
306  * @public @memberof GoSetup
307  * @param setup GoSetup object.
308  * @return Maximum valid EncoderPeriod setting (mm).
309  */
310 GoFx(k64f) GoSetup_EncoderSpacingLimitMax(GoSetup setup);
311 
312 /**
313  * Enables profile intensity collection.
314  *
315  * @public @memberof GoSetup
316  * @param setup GoSetup object.
317  * @param enable kTRUE to enable, or kFALSE to disable.
318  * @return Operation status.
319  */
320 GoFx(kStatus) GoSetup_EnableIntensity(GoSetup setup, kBool enable);
321 
322 /**
323  * Reports whether the profile intensity collection is enabled.
324  *
325  * @public @memberof GoSetup
326  * @param setup GoSetup object.
327  * @return kTRUE if enabled, or kFALSE if disabled.
328  */
329 GoFx(kBool) GoSetup_IntensityEnabled(GoSetup setup);
330 
331 //class - alignment
332 GoFx(kBool) GoSetup_InputTriggerEnabled(GoSetup setup);
333 GoFx(kStatus) GoSetup_EnableInputTrigger(GoSetup setup, kBool enabled);
334 
335 /**
336  * Sets the type used for alignment.
337  *
338  * @public @memberof GoSetup
339  * @param setup GoSetup object.
340  * @param type Alignment type (stationary or moving).
341  * @return Operation status.
342  */
343 GoFx(kStatus) GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType Type);
344 
345 /**
346  * Gets the type used for alignment calibration.
347  *
348  * @public @memberof GoSetup
349  * @param setup GoSetup object.
350  * @return Alignment type (stationary or moving).
351  */
352 GoFx(GoAlignmentType) GoSetup_AlignmentType(GoSetup setup);
353 
354 GoFx(GoAlignmentType) GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index);
355 GoFx(kSize) GoSetup_AlignmentTypeOptionCount(GoSetup setup);
356 
357 /**
358  * Enables encoder calibration after alignment.
359  *
360  * @public @memberof GoSetup
361  * @param setup GoSetup object.
362  * @param enabled kTrue to enable encoder calibration after alignment, kFalse to disable it.
363  * @return Operation status.
364  */
365 GoFx(kStatus) GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled);
366 
367 /**
368  * Gets the value of the post alignment encoder calibration setting.
369  *
370  * @public @memberof GoSetup
371  * @param setup GoSetup object.
372  * @return kTrue if post alignment encoder calibration is enabled. kFalse otherwise.
373  */
374 GoFx(kBool) GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup);
375 
376 
377 /**
378  * Sets the target type used for alignment calibration.
379  *
380  * @public @memberof GoSetup
381  * @param setup GoSetup object.
382  * @param target Alignment target type (none, disk, or bar).
383  * @return Operation status.
384  */
385 GoFx(kStatus) GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target);
386 
387 /**
388  * Gets the target type used for alignment calibration.
389  *
390  * @public @memberof GoSetup
391  * @param setup GoSetup object.
392  * @return Alignment target type (none, disk, or bar).
393  */
394 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTarget(GoSetup setup);
395 
396 GoFx(kSize) GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup);
397 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index);
398 
399 /// @cond (Gocator_1x00 || Gocator_2x00)
400 
401 GoFx(kStatus) GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target);
402 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTarget(GoSetup setup);
403 GoFx(kSize) GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup);
404 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index);
405 
406 /**
407  * Sets the diameter of the disk used for travel calibration.
408  *
409  * @public @memberof GoSetup
410  * @param setup GoSetup object.
411  * @param diameter Disk diameter (mm).
412  * @return Operation status.
413  */
414 GoFx(kStatus) GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter);
415 
416 /**
417  * Gets the diameter of the disk used for travel calibration.
418  *
419  * @public @memberof GoSetup
420  * @param setup GoSetup object.
421  * @return Disk diameter (mm).
422  */
423 GoFx(k64f) GoSetup_DiskDiameter(GoSetup setup);
424 
425 /**
426  * Sets the height of the disk used for travel calibration.
427  *
428  * @public @memberof GoSetup
429  * @param setup GoSetup object.
430  * @param height Disk height (mm).
431  * @return Operation status.
432  */
433 GoFx(kStatus) GoSetup_SetDiskHeight(GoSetup setup, k64f height);
434 
435 /**
436  * Gets the height of the disk used for travel calibration.
437  *
438  * @public @memberof GoSetup
439  * @param setup GoSetup object.
440  * @return Disk height (mm).
441  */
442 GoFx(k64f) GoSetup_DiskHeight(GoSetup setup);
443 
444 /// @endcond
445 
446 
447 /**
448  * Sets the width of the bar used for travel calibration.
449  *
450  * @public @memberof GoSetup
451  * @param setup GoSetup object.
452  * @param width Bar width (mm).
453  * @return Operation status.
454  */
455 GoFx(kStatus) GoSetup_SetBarWidth(GoSetup setup, k64f width);
456 
457 /**
458  * Gets the width of the bar used for travel calibration.
459  *
460  * @public @memberof GoSetup
461  * @param setup GoSetup object.
462  * @return Bar width (mm).
463  */
464 GoFx(k64f) GoSetup_BarWidth(GoSetup setup);
465 
466 /**
467  * Sets the height of the bar used for travel calibration.
468  *
469  * @public @memberof GoSetup
470  * @param setup GoSetup object.
471  * @param height Bar height (mm).
472  * @return Operation status.
473  */
474 GoFx(kStatus) GoSetup_SetBarHeight(GoSetup setup, k64f height);
475 
476 /**
477  * Gets the height of the bar used for travel calibration.
478  *
479  * @public @memberof GoSetup
480  * @param setup GoSetup object.
481  * @return Bar height (mm).
482  */
483 GoFx(k64f) GoSetup_BarHeight(GoSetup setup);
484 
485 /**
486  * Sets the number of holes that are defined on the calibration bar.
487  *
488  * @public @memberof GoSetup
489  * @param setup GoSetup object.
490  * @param count Hole count.
491  * @return Operation status.
492  */
493 GoFx(kStatus) GoSetup_SetBarHoleCount(GoSetup setup, kSize count);
494 
495 /**
496  * Gets the number of holes that are defined on the calibration bar.
497  *
498  * @public @memberof GoSetup
499  * @param setup GoSetup object.
500  * @return Hole count.
501  */
502 GoFx(kSize) GoSetup_BarHoleCount(GoSetup setup);
503 
504 /**
505  * Sets the distance between holes that are defined on the calibration bar.
506  *
507  * @public @memberof GoSetup
508  * @param setup GoSetup object.
509  * @param distance Hole distance (mm).
510  * @return Operation status.
511  */
512 GoFx(kStatus) GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance);
513 
514 /**
515  * Gets the distance between holes that are defined on the calibration bar.
516  *
517  * @public @memberof GoSetup
518  * @param setup GoSetup object.
519  * @return Hole distance (mm).
520  */
521 GoFx(k64f) GoSetup_BarHoleDistance(GoSetup setup);
522 
523 /**
524  * Sets the diameter of holes that are defined on the calibration bar.
525  *
526  * @public @memberof GoSetup
527  * @param setup GoSetup object.
528  * @param diameter Hole diameter (mm).
529  * @return Operation status.
530  */
531 GoFx(kStatus) GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter);
532 
533 /**
534  * Gets the diameter of holes that are defined on the calibration bar.
535  *
536  * @public @memberof GoSetup
537  * @param setup GoSetup object.
538  * @return Hole diameter (mm).
539  */
540 GoFx(k64f) GoSetup_BarHoleDiameter(GoSetup setup);
541 
542 /**
543  * Sets the height of the plate used for travel calibration.
544  *
545  * @public @memberof GoSetup
546  * @param setup GoSetup object.
547  * @param height Plate height (mm).
548  * @return Operation status.
549  */
550 GoFx(kStatus) GoSetup_SetPlateHeight(GoSetup setup, k64f height);
551 
552 /**
553  * Gets the height of the plate used for travel calibration.
554  *
555  * @public @memberof GoSetup
556  * @param setup GoSetup object.
557  * @return Plate height (mm).
558  */
559 GoFx(k64f) GoSetup_PlateHeight(GoSetup setup);
560 
561 /**
562  * Sets the number of holes that are defined on the calibration plate.
563  *
564  * @public @memberof GoSetup
565  * @param setup GoSetup object.
566  * @param count Hole count.
567  * @return Operation status.
568  */
569 GoFx(kStatus) GoSetup_SetPlateHoleCount(GoSetup setup, kSize count);
570 
571 /**
572  * Gets the number of holes that are defined on the calibration plate.
573  *
574  * @public @memberof GoSetup
575  * @param setup GoSetup object.
576  * @return Hole count.
577  */
578 GoFx(kSize) GoSetup_PlateHoleCount(GoSetup setup);
579 
580 /**
581  * Sets the diameter of the reference hole defined on the calibration plate.
582  *
583  * @public @memberof GoSetup
584  * @param setup GoSetup object.
585  * @param diameter Hole diameter (mm).
586  * @return Operation status.
587  */
588 GoFx(kStatus) GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter);
589 
590 /**
591  * Gets the diameter of the reference hole defined on the calibration plate.
592  *
593  * @public @memberof GoSetup
594  * @param setup GoSetup object.
595  * @return Hole diameter (mm).
596  */
597 GoFx(k64f) GoSetup_PlateRefHoleDiameter(GoSetup setup);
598 
599 
600 /**
601  * Sets the diameter of the secondary hole defined on the calibration plate.
602  *
603  * @public @memberof GoSetup
604  * @param setup GoSetup object.
605  * @param diameter Hole diameter (mm).
606  * @return Operation status.
607  */
608 GoFx(kStatus) GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter);
609 
610 /**
611  * Gets the diameter of the secondary hole defined on the calibration plate.
612  *
613  * @public @memberof GoSetup
614  * @param setup GoSetup object.
615  * @return Hole diameter (mm).
616  */
617 GoFx(k64f) GoSetup_PlateSecHoleDiameter(GoSetup setup);
618 
619 
620 //class - filters
621 
622 /**
623  * Sets the status of x-direction smoothing.
624  *
625  * @public @memberof GoSetup
626  * @param setup GoSetup object.
627  * @param enabled Enable or disable x-smoothing
628  * @return Operation status.
629  */
630 GoFx(kStatus) GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled);
631 
632 /**
633  * Gets the status of x-direction smoothing.
634  *
635  * @public @memberof GoSetup
636  * @param setup GoSetup object.
637  * @return True if x-smoothing is enabled.
638  */
639 GoFx(kBool) GoSetup_XSmoothingEnabled(GoSetup setup);
640 
641 /**
642  * Sets the x-direction smoothing window.
643  *
644  * @public @memberof GoSetup
645  * @param setup GoSetup object.
646  * @param window The x-smoothing window (mm).
647  * @return Operation status.
648  */
649 GoFx(kStatus) GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window);
650 
651 /**
652  * Gets the x-direction smoothing window.
653  *
654  * @public @memberof GoSetup
655  * @param setup GoSetup object.
656  * @return The x-smoothing window (mm).
657  */
658 GoFx(k64f) GoSetup_XSmoothingWindow(GoSetup setup);
659 
660 /**
661  * Gets the x-direction smoothing window minimum.
662  *
663  * @public @memberof GoSetup
664  * @param setup GoSetup object.
665  * @return The x-smoothing window min (mm).
666  */
667 GoFx(k64f) GoSetup_XSmoothingWindowLimitMin(GoSetup setup);
668 
669 /**
670  * Gets the x-direction smoothing window maximum.
671  *
672  * @public @memberof GoSetup
673  * @param setup GoSetup object.
674  * @return The x-smoothing window max (mm).
675  */
676 GoFx(k64f) GoSetup_XSmoothingWindowLimitMax(GoSetup setup);
677 
678 /**
679  * Sets the status of y-direction smoothing.
680  *
681  * @public @memberof GoSetup
682  * @param setup GoSetup object.
683  * @param enable Enable or disable y-smoothing
684  * @return Operation status.
685  */
686 GoFx(kStatus) GoSetup_EnableYSmoothing(GoSetup setup, kBool enable);
687 
688 /**
689  * Gets the status of y-direction smoothing.
690  *
691  * @public @memberof GoSetup
692  * @param setup GoSetup object.
693  * @return True if y-smoothing is enabled.
694  */
695 GoFx(kBool) GoSetup_YSmoothingEnabled(GoSetup setup);
696 
697 /**
698  * Sets the y-direction smoothing window.
699  *
700  * @public @memberof GoSetup
701  * @param setup GoSetup object.
702  * @param window The y-smoothing window (mm).
703  * @return Operation status.
704  */
705 GoFx(kStatus) GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window);
706 
707 /**
708  * Gets the y-direction smoothing window.
709  *
710  * @public @memberof GoSetup
711  * @param setup GoSetup object.
712  * @return The y-smoothing window (mm).
713  */
714 GoFx(k64f) GoSetup_YSmoothingWindow(GoSetup setup);
715 
716 /**
717  * Gets the y-direction smoothing window minimum.
718  *
719  * @public @memberof GoSetup
720  * @param setup GoSetup object.
721  * @return The y-smoothing window min (mm).
722  */
723 GoFx(k64f) GoSetup_YSmoothingWindowLimitMin(GoSetup setup);
724 
725 /**
726  * Gets the y-direction smoothing window maximum.
727  *
728  * @public @memberof GoSetup
729  * @param setup GoSetup object.
730  * @return The y-smoothing window max (mm).
731  */
732 GoFx(k64f) GoSetup_YSmoothingWindowLimitMax(GoSetup setup);
733 
734 /**
735  * Sets the status of x-direction gap-filling.
736  *
737  * @public @memberof GoSetup
738  * @param setup GoSetup object.
739  * @param enable Enable or disable x-gap-filling
740  * @return Operation status.
741  */
742 GoFx(kStatus) GoSetup_EnableXGapFilling(GoSetup setup, kBool enable);
743 
744 /**
745  * Gets the status of x-direction gap-filling.
746  *
747  * @public @memberof GoSetup
748  * @param setup GoSetup object.
749  * @return True if x-gap-filling is enabled.
750  */
751 GoFx(kBool) GoSetup_XGapFillingEnabled(GoSetup setup);
752 
753 /**
754  * Sets the status of x-direction gap-filling.
755  *
756  * @public @memberof GoSetup
757  * @param setup GoSetup object.
758  * @param window Enable or disable x-gap-filling
759  * @return Operation status.
760  */
761 GoFx(kStatus) GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window);
762 
763 /**
764  * Gets the x-direction gap-filling window.
765  *
766  * @public @memberof GoSetup
767  * @param setup GoSetup object.
768  * @return The x-gap-filling window (mm).
769  */
770 GoFx(k64f) GoSetup_XGapFillingWindow(GoSetup setup);
771 
772 /**
773  * Gets the x-direction gap-filling window minimum.
774  *
775  * @public @memberof GoSetup
776  * @param setup GoSetup object.
777  * @return The x-gap-filling window min (mm).
778  */
779 GoFx(k64f) GoSetup_XGapFillingWindowLimitMin(GoSetup setup);
780 
781 /**
782  * Gets the x-direction gap-filling window maximum.
783  *
784  * @public @memberof GoSetup
785  * @param setup GoSetup object.
786  * @return The x-gap-filling window max (mm).
787  */
788 GoFx(k64f) GoSetup_XGapFillingWindowLimitMax(GoSetup setup);
789 
790 /**
791  * Sets the status of y-direction gap-filling.
792  *
793  * @public @memberof GoSetup
794  * @param setup GoSetup object.
795  * @param enable Enable or disable y-gap-filling
796  * @return Operation status.
797  */
798 GoFx(kStatus) GoSetup_EnableYGapFilling(GoSetup setup, kBool enable);
799 
800 /**
801  * Gets the status of y-direction gap-filling.
802  *
803  * @public @memberof GoSetup
804  * @param setup GoSetup object.
805  * @return True if y-gap-filling is enabled.
806  */
807 GoFx(kBool) GoSetup_YGapFillingEnabled(GoSetup setup);
808 
809 /**
810  * Sets the y-direction gap-filling window.
811  *
812  * @public @memberof GoSetup
813  * @param setup GoSetup object.
814  * @param window The y-gap-filling window (mm).
815  * @return
816  */
817 GoFx(kStatus) GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window);
818 
819 /**
820  * Gets the y-direction gap-filling window.
821  *
822  * @public @memberof GoSetup
823  * @param setup GoSetup object.
824  * @return The y-gap-filling window (mm).
825  */
826 GoFx(k64f) GoSetup_YGapFillingWindow(GoSetup setup);
827 
828 /**
829  * Gets the y-direction gap-filling window minimum.
830  *
831  * @public @memberof GoSetup
832  * @param setup GoSetup object.
833  * @return The y-gap-filling window min (mm).
834  */
835 GoFx(k64f) GoSetup_YGapFillingWindowLimitMin(GoSetup setup);
836 
837 /**
838  * Gets the y-direction gap-filling window maximum.
839  *
840  * @public @memberof GoSetup
841  * @param setup GoSetup object.
842  * @return The y-gap-filling window max (mm).
843  */
844 GoFx(k64f) GoSetup_YGapFillingWindowLimitMax(GoSetup setup);
845 
846 /**
847  * Gets the maximum valid value for the Exposure setting.
848  *
849  * @public @memberof GoSetup
850  * @param setup GoSetup object.
851  * @param role Determines which sensor to apply changes to.
852  * @return Maximum valid Exposure value (microseconds).
853  */
854 GoFx(k64f) GoSetup_ExposureLimitMax(GoSetup setup, GoRole role);
855 
856 /**
857  * Gets the minimum valid value for the Exposure setting.
858  *
859  * @public @memberof GoSetup
860  * @param setup GoSetup object.
861  * @param role Determines which sensor to apply changes to.
862  * @return Maximum valid Exposure value (microseconds).
863  */
864 GoFx(k64f) GoSetup_ExposureLimitMin(GoSetup setup, GoRole role);
865 
866 /**
867  * Sets the exposure value.
868  *
869  * @public @memberof GoSetup
870  * @param setup GoSetup object.
871  * @param role Determines which sensor to apply changes to.
872  * @param exposure Intended exposure value.
873  * @return Operation status.
874  */
875 GoFx(kStatus) GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure);
876 
877 /**
878  * Gets the exposure value.
879  *
880  * @public @memberof GoSetup
881  * @param setup GoSetup object.
882  * @param role Determines which sensor to apply changes to.
883  * @return Exposure value (microseconds).
884  */
885 GoFx(k64f) GoSetup_Exposure(GoSetup setup, GoRole role);
886 
887 /**
888  * Gets the exposure mode.
889  *
890  * @public @memberof GoSetup
891  * @param setup GoSetup object.
892  * @param role Determines which sensor to apply changes to.
893  * @return Exposure mode.
894  */
895 GoFx(GoExposureMode) GoSetup_ExposureMode(GoSetup setup, GoRole role);
896 
897 /**
898  * Sets the exposure mode.
899  *
900  * @public @memberof GoSetup
901  * @param setup GoSetup object.
902  * @param role Determines which sensor to apply changes to.
903  * @param mode The exposure mode to use.
904  * @return Operation status.
905  */
906 GoFx(kStatus) GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode);
907 
908 GoFx(GoExposureMode) GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, k32u index);
909 GoFx(kSize) GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role);
910 
911 /**
912  * Gets the exposure delay.
913  *
914  * @public @memberof GoSetup
915  * @param setup GoSetup object.
916  * @param role Determines which sensor to apply changes to.
917  * @return Exposure delay (microseconds).
918  */
919 GoFx(k32u) GoSetup_ExposureDelay(GoSetup setup, GoRole role);
920 
921 /**
922  * Sets the exposure delay.
923  *
924  * @public @memberof GoSetup
925  * @param setup GoSetup object.
926  * @param role Determines which sensor to apply changes to.
927  * @param delay Exposure delay (microseconds).
928  * @return Operation status.
929  */
930 GoFx(kStatus) GoSetup_SetExposureDelay(GoSetup setup, GoRole role, k32u delay);
931 
932 /**
933  * Adds an exposure step
934  *
935  * @public @memberof GoSetup
936  * @param setup GoSetup object.
937  * @param role Determines which sensor to apply changes to.
938  * @param exposure Expsosure value (microseconds).
939  * @return Operation status.
940  */
941 GoFx(kStatus) GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure);
942 
943 /**
944  * Removes all exposure steps.
945  *
946  * @public @memberof GoSetup
947  * @param setup GoSetup object.
948  * @param role Determines which sensor to apply changes to.
949  * @return Operation status.
950  */
951 GoFx(kStatus) GoSetup_ClearExposureSteps(GoSetup setup, GoRole role);
952 
953 /**
954  * Get the exposure step value specified by index
955  *
956  * @public @memberof GoSetup
957  * @param setup GoSetup object.
958  * @param role Determines which sensor to apply changes to.
959  * @param index The index of the exposure step to get.
960  * @return The exposure step value (microseconds).
961  */
962 GoFx(k64f) GoSetup_ExposureStepAt(GoSetup setup, GoRole role, k32u index);
963 
964 /**
965  * Get the number of exposure steps defined
966  *
967  * @public @memberof GoSetup
968  * @param setup GoSetup object.
969  * @param role Determines which sensor to apply changes to.
970  * @return The count of exposure steps.
971  */
972 GoFx(kSize) GoSetup_ExposureStepCount(GoSetup setup, GoRole role);
973 
974 /**
975  * Gets the maximum value for the Dynamic Exposure setting.
976  *
977  * @public @memberof GoSetup
978  * @param setup GoSetup object.
979  * @param role Determines which sensor to apply changes to.
980  * @return Maximum Dynamic Exposure value (microseconds).
981  */
982 GoFx(k64f) GoSetup_DynamicExposureMax(GoSetup setup, GoRole role);
983 
984 /**
985  * Sets the maximum value for the Dynamic Exposure setting.
986  *
987  * @public @memberof GoSetup
988  * @param setup GoSetup object.
989  * @param role Determines which sensor to apply changes to.
990  * @param exposure Maximum Dynamic Exposure value (microseconds).
991  * @return Operation status.
992  */
993 GoFx(kStatus) GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure);
994 
995 /**
996  * Gets the minimum value for the Dynamic Exposure setting.
997  *
998  * @public @memberof GoSetup
999  * @param setup GoSetup object.
1000  * @param role Determines which sensor to apply changes to.
1001  * @return Minimum Dynamic Exposure value (microseconds).
1002  */
1003 GoFx(k64f) GoSetup_DynamicExposureMin(GoSetup setup, GoRole role);
1004 
1005 /**
1006  * Sets the minimum value for the Dynamic Exposure setting.
1007  *
1008  * @public @memberof GoSetup
1009  * @param setup GoSetup object.
1010  * @param role Determines which sensor to apply changes to.
1011  * @param exposure Minumum Dynamic Exposure value (microseconds).
1012  * @return Operation status.
1013  */
1014 GoFx(kStatus) GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure);
1015 
1016 /**
1017  * Gets the minimum valid value for the ActiveAreaHeight setting.
1018  *
1019  * @public @memberof GoSetup
1020  * @param setup GoSetup object.
1021  * @param role Determines which sensor to apply changes to.
1022  * @return Minimum valid ActiveAreaHeight value (mm).
1023  */
1024 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role);
1025 
1026 /**
1027  * Gets the maximum valid value for the ActiveAreaHeight setting.
1028  *
1029  * @public @memberof GoSetup
1030  * @param setup GoSetup object.
1031  * @param role Determines which sensor to apply changes to.
1032  * @return Maximum valid ActiveAreaHeight value (mm).
1033  */
1034 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role);
1035 
1036 /**
1037  * Gets the active area height.
1038  *
1039  * @public @memberof GoSetup
1040  * @param setup GoSetup object.
1041  * @param role Determines which sensor to retrieve the value from.
1042  * @param height Active area height (mm).
1043  * @return Operation status.
1044  */
1045 GoFx(k64f) GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role);
1046 
1047 /**
1048  * Sets the active area height.
1049  *
1050  * @public @memberof GoSetup
1051  * @param setup GoSetup object.
1052  * @param role Determines which sensor to apply changes to.
1053  * @param height Active area height (mm).
1054  * @return Operation status.
1055  */
1056 GoFx(kStatus) GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f height);
1057 
1058 /**
1059  * Gets the active area Length.
1060  *
1061  * @public @memberof GoSetup
1062  * @param setup GoSetup object.
1063  * @param role Determines which sensor to apply changes to.
1064  * @return Active area Length (mm).
1065  */
1066 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
1067 
1068 
1069 /**
1070  * Gets the minimum valid value for the ActiveAreaLength setting.
1071  *
1072  * @public @memberof GoSetup
1073  * @param setup GoSetup object.
1074  * @param role Determines which sensor to apply changes to.
1075  * @return Minimum valid ActiveAreaLength value (mm).
1076  */
1077 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role);
1078 
1079 /**
1080  * Gets the maximum valid value for the ActiveAreaLength setting.
1081  *
1082  * @public @memberof GoSetup
1083  * @param setup GoSetup object.
1084  * @param role Determines which sensor to apply changes to.
1085  * @return Maximum valid ActiveAreaLength value (mm).
1086  */
1087 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role);
1088 
1089 /**
1090  * Sets the active area Length.
1091  *
1092  * @public @memberof GoSetup
1093  * @param setup GoSetup object.
1094  * @param role Determines which sensor to apply changes to.
1095  * @param Length Active area Length (mm).
1096  * @return Operation status.
1097  */
1098 GoFx(k64f) GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f Length);
1099 
1100 /**
1101  * Gets the active area Length.
1102  *
1103  * @public @memberof GoSetup
1104  * @param setup GoSetup object.
1105  * @param role Determines which sensor to apply changes to.
1106  * @return Active area Length (mm).
1107  */
1108 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
1109 
1110 
1111 /**
1112  * Gets the minimum valid value for the ActiveAreaWidth setting.
1113  *
1114  * @public @memberof GoSetup
1115  * @param setup GoSetup object.
1116  * @param role Determines which sensor to apply changes to.
1117  * @return Minimum valid ActiveAreaWidth value (mm).
1118  */
1119 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role);
1120 
1121 /**
1122  * Gets the maximum valid value for the ActiveAreaWidth setting.
1123  *
1124  * @public @memberof GoSetup
1125  * @param setup GoSetup object.
1126  * @param role Determines which sensor to apply changes to.
1127  * @return Maximum valid ActiveAreaWidth value (mm).
1128  */
1129 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role);
1130 
1131 /**
1132  * Sets the active area width.
1133  *
1134  * @public @memberof GoSetup
1135  * @param setup GoSetup object.
1136  * @param role Determines which sensor to apply changes to.
1137  * @param width Active area width (mm).
1138  * @return Operation status.
1139  */
1140 GoFx(k64f) GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f width);
1141 
1142 /**
1143  * Gets the active area width.
1144  *
1145  * @public @memberof GoSetup
1146  * @param setup GoSetup object.
1147  * @param role Determines which sensor to apply changes to.
1148  * @return Active area width (mm).
1149  */
1150 GoFx(k64f) GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role);
1151 
1152 /**
1153  * Gets the minimum valid value for the ActiveAreaX setting.
1154  *
1155  * @public @memberof GoSetup
1156  * @param setup GoSetup object.
1157  * @param role Determines which sensor to apply changes to.
1158  * @return Minimum valid ActiveAreaX value (mm).
1159  */
1160 GoFx(k64f) GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role);
1161 
1162 /**
1163  * Gets the maximum valid value for the ActiveAreaX setting.
1164  *
1165  * @public @memberof GoSetup
1166  * @param setup GoSetup object.
1167  * @param role Determines which sensor to apply changes to.
1168  * @return Maximum valid ActiveAreaX value (mm).
1169  */
1170 GoFx(k64f) GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role);
1171 
1172 /**
1173  * Sets the active area x origin.
1174  *
1175  * @public @memberof GoSetup
1176  * @param setup GoSetup object.
1177  * @param role Determines which sensor to apply changes to.
1178  * @param x Active area x origin (mm).
1179  * @return Operation status.
1180  */
1181 GoFx(k64f) GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f x);
1182 
1183 /**
1184  * Gets the active area x origin.
1185  *
1186  * @public @memberof GoSetup
1187  * @param setup GoSetup object.
1188  * @param role Determines which sensor to apply changes to.
1189  * @return Active area x origin (mm).
1190  */
1191 GoFx(k64f) GoSetup_ActiveAreaX(GoSetup setup, GoRole role);
1192 
1193 /**
1194  * Gets the minimum valid value for the ActiveAreaY setting.
1195  *
1196  * @public @memberof GoSetup
1197  * @param setup GoSetup object.
1198  * @param role Determines which sensor to apply changes to.
1199  * @return Minimum valid ActiveAreaY value (mm).
1200  */
1201 GoFx(k64f) GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role);
1202 
1203 /**
1204  * Gets the maximum valid value for the ActiveAreaY setting.
1205  *
1206  * @public @memberof GoSetup
1207  * @param setup GoSetup object.
1208  * @param role Determines which sensor to apply changes to.
1209  * @return Maximum valid ActiveAreaY value (mm).
1210  */
1211 GoFx(k64f) GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role);
1212 
1213 /**
1214  * Sets the active area Y.
1215  *
1216  * @public @memberof GoSetup
1217  * @param setup GoSetup object.
1218  * @param role Determines which sensor to apply changes to.
1219  * @param Y Active area Y (mm).
1220  * @return Operation status.
1221  */
1222 GoFx(k64f) GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f Y);
1223 
1224 /**
1225  * Gets the active area Y.
1226  *
1227  * @public @memberof GoSetup
1228  * @param setup GoSetup object.
1229  * @param role Determines which sensor to apply changes to.
1230  * @return Active area Y (mm).
1231  */
1232 GoFx(k64f) GoSetup_ActiveAreaY(GoSetup setup, GoRole role);
1233 
1234 /**
1235  * Gets the minimum valid value for the ActiveAreaZ setting.
1236  *
1237  * @public @memberof GoSetup
1238  * @param setup GoSetup object.
1239  * @param role Determines which sensor to apply changes to.
1240  * @return Minimum valid ActiveAreaZ value (mm).
1241  */
1242 GoFx(k64f) GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role);
1243 
1244 /**
1245  * Gets the maximum valid value for the ActiveAreaZ setting.
1246  *
1247  * @public @memberof GoSetup
1248  * @param setup GoSetup object.
1249  * @param role Determines which sensor to apply changes to.
1250  * @return Maximum valid ActiveAreaZ value (mm).
1251  */
1252 GoFx(k64f) GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role);
1253 
1254 /**
1255  * Sets the active area z origin.
1256  *
1257  * @public @memberof GoSetup
1258  * @param setup GoSetup object.
1259  * @param role Determines which sensor to apply changes to.
1260  * @param z Active area z origin (mm).
1261  * @return Operation status.
1262  */
1263 GoFx(k64f) GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f z);
1264 
1265 /**
1266  * Gets the active area z origin.
1267  *
1268  * @public @memberof GoSetup
1269  * @param setup GoSetup object.
1270  * @param role Determines which sensor to apply changes to.
1271  * @return Active area z origin (mm).
1272  */
1273 GoFx(k64f) GoSetup_ActiveAreaZ(GoSetup setup, GoRole role);//
1274 
1275 //class - layout
1276 
1277 GoFx(k64f) GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role);
1278 GoFx(k64f) GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role);
1279 GoFx(k64f) GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role);
1280 GoFx(k64f) GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role);
1281 GoFx(k64f) GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role);
1282 GoFx(k64f) GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role);
1283 
1284 /**
1285  * Sets the transform x-offset.
1286  *
1287  * @public @memberof GoSetup
1288  * @param setup GoSetup object.
1289  * @param orientation Offset value (mm).
1290  * @return Operation status.
1291  */
1292 GoFx(kStatus) GoSetup_SetOrientation(GoSetup setup, GoOrientation orientation);
1293 
1294 /**
1295  * Gets the transform orientation identifier.
1296  *
1297  * @public @memberof GoSetup
1298  * @param setup GoSetup object.
1299  * @param role Determines which sensor to apply changes to.
1300  * @return Orientation identifier.
1301  */
1302 GoFx(GoOrientation) GoSetup_Orientation(GoSetup setup);
1303 
1304 
1305 GoFx(kBool) GoSetup_MultiplexBuddyEnabled(GoSetup setup);
1306 GoFx(kStatus) GoSetup_EnableMultiplexBuddy(GoSetup setup, kBool enabled);
1307 GoFx(kBool) GoSetup_MultiplexSingleEnabled(GoSetup setup);
1308 GoFx(kStatus) GoSetup_EnableMultiplexSingle(GoSetup setup, kBool enabled);
1309 GoFx(k64f) GoSetup_MultiplexSingleDelay(GoSetup setup);
1310 GoFx(kStatus) GoSetup_SetMultiplexSingleDelay(GoSetup setup, k64f value);
1311 GoFx(k64f) GoSetup_MultiplexSinglePeriod(GoSetup setup);
1312 GoFx(kStatus) GoSetup_SetMultiplexSinglePeriod(GoSetup setup, k64f value);
1313 
1314 /**
1315  * Gets the count of valid x-resolution options.
1316  *
1317  * @public @memberof GoSetup
1318  * @param setup GoSetup object.
1319  * @param role Determines which sensor to apply changes to.
1320  * @return Count of x-resolution options.
1321  */
1322 GoFx(kSize) GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role);
1323 
1324 /**
1325  * Gets the x-resolution option at the specified index.
1326  *
1327  * @public @memberof GoSetup
1328  * @param setup GoSetup object.
1329  * @param role Determines which sensor to apply changes to.
1330  * @param index Index of the desired resolution option.
1331  * @return X resolution option.
1332  */
1333 GoFx(k32u) GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, k32u index);
1334 
1335 /**
1336  * Sets the current x-resolution divider.
1337  *
1338  * @public @memberof GoSetup
1339  * @param setup GoSetup object.
1340  * @param role Determines which sensor to apply changes to.
1341  * @param xResolution X resolution divider (e.g. 1 - full res, 2 - half res).
1342  * @return Operation status.
1343  */
1344 GoFx(kStatus) GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling);
1345 
1346 /**
1347  * Gets the current x-resolution divider.
1348  *
1349  * @public @memberof GoSetup
1350  * @param setup GoSetup object.
1351  * @param role Determines which sensor to apply changes to.
1352  * @return x resolution divider (e.g. 1 - full res, 2 - half res).
1353  */
1354 GoFx(k32u) GoSetup_XSubsampling(GoSetup setup, GoRole role);
1355 
1356 /**
1357  * Gets the count of valid z-resolution options.
1358  *
1359  * @public @memberof GoSetup
1360  * @param setup GoSetup object.
1361  * @param role Determines which sensor to apply changes to.
1362  * @return Count of z-resolution options.
1363  */
1364 GoFx(kSize) GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role);
1365 
1366 /**
1367  * Gets the z-resolution option at the specified index.
1368  *
1369  * @public @memberof GoSetup
1370  * @param setup GoSetup object.
1371  * @param role Determines which sensor to apply changes to.
1372  * @param index Index of the desired resolution option.
1373  * @return Z resolution option.
1374  */
1375 GoFx(k32u) GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, k32u index);
1376 
1377 /**
1378  * Sets the current z-resolution divider.
1379  *
1380  * @public @memberof GoSetup
1381  * @param setup GoSetup object.
1382  * @param role Determines which sensor to apply changes to.
1383  * @param zResolution Z resolution divider (e.g. 1 - full res, 2 - half res).
1384  * @return Operation status.
1385  */
1386 GoFx(kStatus) GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling);
1387 
1388 /**
1389  * Gets the current z-resolution divider.
1390  *
1391  * @public @memberof GoSetup
1392  * @param setup GoSetup object.
1393  * @param role Determines which sensor to apply changes to.
1394  * @return Z resolution divider (e.g. 1 - full res, 2 - half res).
1395  */
1396 GoFx(k32u) GoSetup_ZSubsampling(GoSetup setup, GoRole role);
1397 
1398 /**
1399  * Gets the camera region-of-interest x origin.
1400  *
1401  * @public @memberof GoSetup
1402  * @param setup GoSetup object.
1403  * @param role Determines which sensor to apply changes to.
1404  * @return Region of interest x origin (pixels).
1405  */
1406 GoFx(k32u) GoSetup_FrontCameraX(GoSetup setup, GoRole role);
1407 
1408 /**
1409  * Gets the camera region-of-interest y origin.
1410  *
1411  * @public @memberof GoSetup
1412  * @param setup GoSetup object.
1413  * @param role Determines which sensor to apply changes to.
1414  * @return Region of interest y origin (pixels).
1415  */
1416 GoFx(k32u) GoSetup_FrontCameraY(GoSetup setup, GoRole role);
1417 
1418 /**
1419  * Gets the camera region-of-interest width.
1420  *
1421  * @public @memberof GoSetup
1422  * @param setup GoSetup object.
1423  * @param role Determines which sensor to apply changes to.
1424  * @return Region of interest width (pixels).
1425  */
1426 GoFx(k32u) GoSetup_FrontCameraWidth(GoSetup setup, GoRole role);
1427 
1428 /**
1429  * Gets the camera region-of-interest height.
1430  *
1431  * @public @memberof GoSetup
1432  * @param setup GoSetup object.
1433  * @param role Determines which sensor to apply changes to.
1434  * @return Region of interest height (pixels).
1435  */
1436 GoFx(k32u) GoSetup_FrontCameraHeight(GoSetup setup, GoRole role);
1437 
1438 
1439 /// @cond Gocator_3x00
1440 
1441 /**
1442  * Gets the camera region-of-interest x origin.
1443  *
1444  * @public @memberof GoSetup
1445  * @param setup GoSetup object.
1446  * @param role Determines which sensor to apply changes to.
1447  * @return Region of interest x origin (pixels).
1448  */
1449 GoFx(k32u) GoSetup_BackCameraX(GoSetup setup, GoRole role);
1450 
1451 /**
1452  * Gets the camera region-of-interest y origin.
1453  *
1454  * @public @memberof GoSetup
1455  * @param setup GoSetup object.
1456  * @param role Determines which sensor to apply changes to.
1457  * @return Region of interest y origin (pixels).
1458  */
1459 GoFx(k32u) GoSetup_BackCameraY(GoSetup setup, GoRole role);
1460 
1461 /**
1462  * Gets the camera region-of-interest width.
1463  *
1464  * @public @memberof GoSetup
1465  * @param setup GoSetup object.
1466  * @param role Determines which sensor to apply changes to.
1467  * @return Region of interest width (pixels).
1468  */
1469 GoFx(k32u) GoSetup_BackCameraWidth(GoSetup setup, GoRole role);
1470 
1471 /**
1472  * Gets the camera region-of-interest height.
1473  *
1474  * @public @memberof GoSetup
1475  * @param setup GoSetup object.
1476  * @param role Determines which sensor to apply changes to.
1477  * @return Region of interest height (pixels).
1478  */
1479 GoFx(k32u) GoSetup_BackCameraHeight(GoSetup setup, GoRole role);
1480 
1481 /// @endcond
1482 
1483 
1484 /**
1485  * Enables tracking.
1486  *
1487  * @public @memberof GoSetup
1488  * @param setup GoSetup object.
1489  * @param role Determines which sensor to apply changes to.
1490  * @param enable kTRUE to enable, or kFALSE to disable.
1491  * @return Operation status.
1492  */
1493 GoFx(kStatus) GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable);
1494 
1495 /**
1496  * Determines if tracking is enabled.
1497  *
1498  * @public @memberof GoSetup
1499  * @param setup GoSetup object.
1500  * @param role Determines which sensor to apply changes to.
1501  * @return kTRUE if enabled, or kFALSE if disabled.
1502  */
1503 GoFx(kBool) GoSetup_TrackingEnabled(GoSetup setup, GoRole role);
1504 
1505 /**
1506  * Sets the tracking window height.
1507  *
1508  * @public @memberof GoSetup
1509  * @param setup GoSetup object.
1510  * @param role Determines which sensor to apply changes to.
1511  * @param height Tracking window height (mm).
1512  * @return Operation status.
1513  */
1514 GoFx(kStatus) GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height);
1515 
1516 /**
1517  * Gets the tracking window height.
1518  *
1519  * @public @memberof GoSetup
1520  * @param setup GoSetup object.
1521  * @param role Determines which sensor to apply changes to.
1522  * @return Tracking window height (mm).
1523  */
1524 GoFx(k64f) GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role);
1525 
1526 /**
1527  * Gets the tracking window height minimum limit.
1528  *
1529  * @public @memberof GoSetup
1530  * @param setup GoSetup object.
1531  * @param role Determines which sensor to apply changes to.
1532  * @return Tracking window height min(mm).
1533  */
1534 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role);
1535 
1536 /**
1537  * Gets the tracking window height maximum limit.
1538  *
1539  * @public @memberof GoSetup
1540  * @param setup GoSetup object.
1541  * @param role Determines which sensor to apply changes to.
1542  * @return Tracking window height max(mm).
1543  */
1544 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role);
1545 
1546 /**
1547  * Sets the tracking window search threshold.
1548  *
1549  * @public @memberof GoSetup
1550  * @param setup GoSetup object.
1551  * @param role Determines which sensor to apply changes to.
1552  * @param threshold Tracking window search threshold (%)
1553  * @return Operation status.
1554  */
1555 GoFx(kStatus) GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold);
1556 
1557 /**
1558  * Gets the tracking window search threshold.
1559  *
1560  * @public @memberof GoSetup
1561  * @param setup GoSetup object.
1562  * @param role Determines which sensor to apply changes to.
1563  * @return Tracking window search threshold (%).
1564  */
1565 GoFx(k64f) GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role);
1566 
1567 GoFx(k64f) GoSetup_SpacingInterval(GoSetup setup, GoRole role);
1568 GoFx(k64f) GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role);
1569 GoFx(k64f) GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role);
1570 GoFx(kStatus) GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f resolution);
1571 GoFx(GoSpacingIntervalType) GoSetup_SpacingIntervalType(GoSetup setup, GoRole role);
1572 GoFx(kStatus) GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type);
1573 GoFx(k32u) GoSetup_XSpacingCount(GoSetup setup, GoRole role);
1574 GoFx(k32u) GoSetup_YSpacingCount(GoSetup setup, GoRole role);
1575 
1576 
1577 GoFx(k32u) GoSetup_IntensityStepIndex(GoSetup setup, GoRole role);
1578 GoFx(kStatus) GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index);
1579 
1580 /**
1581  * Gets the layout configuration module.
1582  *
1583  * @public @memberof GoSetup
1584  * @param setup GoSetup object.
1585  * @return Layout configuration module.
1586  */
1587 GoFx(GoLayout) GoSetup_Layout(GoSetup setup);
1588 
1589 /**
1590  * Gets the surface generation module, used for surface generation configuration.
1591  *
1592  * @public @memberof GoSetup
1593  * @param setup GoSetup object.
1594  * @return Surface generation configuration module.
1595  */
1596 GoFx(GoSurfaceGeneration) GoSetup_SurfaceGeneration(GoSetup setup);
1597 
1598 /**
1599  * Gets the part detection module, used for part detection configuration.
1600  *
1601  * @public @memberof GoSetup
1602  * @param setup GoSetup object.
1603  * @return Part detection configuration module.
1604  */
1605 GoFx(GoPartDetection) GoSetup_PartDetection(GoSetup setup);
1606 
1607 
1608 kEndHeader()
1609 #include <GoSdk/GoSetup.x.h>
1610 
1611 #endif
k64f GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaZ setting.
kBool GoSetup_MaxFrameRateEnabled(GoSetup setup)
Reports whether or not system is configured to operate at full frame rate.
k64f GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role)
Gets the active area height.
k64f GoSetup_YSmoothingWindowLimitMax(GoSetup setup)
Gets the y-direction smoothing window maximum.
k64f GoSetup_XGapFillingWindow(GoSetup setup)
Gets the x-direction gap-filling window.
GoEncoderTriggerMode GoSetup_EncoderTriggerMode(GoSetup setup)
Gets the encoder trigger mode.
GoAlignmentType GoSetup_AlignmentType(GoSetup setup)
Gets the type used for alignment calibration.
kStatus GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType Type)
Sets the type used for alignment.
k64f GoSetup_ActiveAreaX(GoSetup setup, GoRole role)
Gets the active area x origin.
kStatus GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the reference hole defined on the calibration plate.
kStatus GoSetup_SetBarHeight(GoSetup setup, k64f height)
Sets the height of the bar used for travel calibration.
Declares the GoPartDetection class.
k64f GoSetup_YSmoothingWindow(GoSetup setup)
Gets the y-direction smoothing window.
k64f GoSetup_TriggerDelayLimitMax(GoSetup setup)
Reports the maximum trigger delay, based on current settings.
kBool GoSetup_XSmoothingEnabled(GoSetup setup)
Gets the status of x-direction smoothing.
k32u GoSetup_ZSubsampling(GoSetup setup, GoRole role)
Gets the current z-resolution divider.
k64f GoSetup_PlateHeight(GoSetup setup)
Gets the height of the plate used for travel calibration.
kStatus GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window)
Sets the x-direction smoothing window.
kStatus GoSetup_SetBarWidth(GoSetup setup, k64f width)
Sets the width of the bar used for travel calibration.
k64f GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaX setting.
GoMode GoSetup_ScanMode(GoSetup setup)
Gets the default operation mode of the sensor system.
GoTrigger GoSetup_TriggerSource(GoSetup setup)
Gets the trigger source for profile triggering.
k64f GoSetup_YGapFillingWindowLimitMin(GoSetup setup)
Gets the y-direction gap-filling window minimum.
kBool GoSetup_IntensityEnabled(GoSetup setup)
Reports whether the profile intensity collection is enabled.
k64f GoSetup_ActiveAreaZ(GoSetup setup, GoRole role)
Gets the active area z origin.
GoLayout GoSetup_Layout(GoSetup setup)
Gets the layout configuration module.
kStatus GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode)
Sets the encoder trigger mode.
k64f GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaWidth setting.
kBool GoSetup_YGapFillingEnabled(GoSetup setup)
Gets the status of y-direction gap-filling.
k32u GoSetup_XSubsampling(GoSetup setup, GoRole role)
Gets the current x-resolution divider.
GoPartDetection GoSetup_PartDetection(GoSetup setup)
Gets the part detection module, used for part detection configuration.
kStatus GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the disk used for travel calibration.
k64f GoSetup_DynamicExposureMax(GoSetup setup, GoRole role)
Gets the maximum value for the Dynamic Exposure setting.
k32u GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, k32u index)
Gets the z-resolution option at the specified index.
kBool GoSetup_YSmoothingEnabled(GoSetup setup)
Gets the status of y-direction smoothing.
kStatus GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target)
Sets the target type used for alignment calibration.
kSize GoSetup_ExposureStepCount(GoSetup setup, GoRole role)
Get the number of exposure steps defined.
k64f GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaX setting.
kSize GoSetup_BarHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration bar.
k64f GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaWidth setting.
k64f GoSetup_EncoderSpacingLimitMax(GoSetup setup)
Constraint for the maximum valid value of the EncoderPeriod setting.
k64f GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaZ setting.
k64f GoSetup_BarWidth(GoSetup setup)
Gets the width of the bar used for travel calibration.
k64f GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaLength setting.
kSize GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid x-resolution options.
GoState GoSetup_DefaultState(GoSetup setup)
Gets the default state of the sensor system upon boot.
k32u GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, k32u index)
Gets the x-resolution option at the specified index.
kStatus GoSetup_EnableYSmoothing(GoSetup setup, kBool enable)
Sets the status of y-direction smoothing.
kStatus GoSetup_EnableIntensity(GoSetup setup, kBool enable)
Enables profile intensity collection.
kStatus GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled)
Sets the status of x-direction smoothing.
k64f GoSetup_Exposure(GoSetup setup, GoRole role)
Gets the exposure value.
kStatus GoSetup_SetExposureDelay(GoSetup setup, GoRole role, k32u delay)
Sets the exposure delay.
k64f GoSetup_XSmoothingWindowLimitMax(GoSetup setup)
Gets the x-direction smoothing window maximum.
k64f GoSetup_ExposureStepAt(GoSetup setup, GoRole role, k32u index)
Get the exposure step value specified by index.
kStatus GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source)
Sets the trigger source for profile triggering.
kStatus GoSetup_EnableTriggerGate(GoSetup setup, kBool enable)
Sets the trigger gate feature.
kStatus GoSetup_SetPlateHeight(GoSetup setup, k64f height)
Sets the height of the plate used for travel calibration.
GoSurfaceGeneration GoSetup_SurfaceGeneration(GoSetup setup)
Gets the surface generation module, used for surface generation configuration.
k32u GoSetup_ExposureDelay(GoSetup setup, GoRole role)
Gets the exposure delay.
k64f GoSetup_YGapFillingWindowLimitMax(GoSetup setup)
Gets the y-direction gap-filling window maximum.
kStatus GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold)
Sets the tracking window search threshold.
kStatus GoSetup_SetFrameRate(GoSetup setup, k64f frameRate)
Sets the current frame rate for time-based triggering.
Represents a ...
Definition: GoLayout.h:15
GoExposureMode GoSetup_ExposureMode(GoSetup setup, GoRole role)
Gets the exposure mode.
GoOrientation GoSetup_Orientation(GoSetup setup)
Gets the transform orientation identifier.
kSize GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid z-resolution options.
kStatus GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure)
Sets the maximum value for the Dynamic Exposure setting.
k64f GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f Y)
Sets the active area Y.
Represents a ...
Definition: GoSurfaceGeneration.h:17
k64f GoSetup_XGapFillingWindowLimitMax(GoSetup setup)
Gets the x-direction gap-filling window maximum.
k64f GoSetup_DiskDiameter(GoSetup setup)
Gets the diameter of the disk used for travel calibration.
Essential API declarations.
kStatus GoSetup_SetBarHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration bar.
kStatus GoSetup_ClearExposureSteps(GoSetup setup, GoRole role)
Removes all exposure steps.
k64f GoSetup_DiskHeight(GoSetup setup)
Gets the height of the disk used for travel calibration.
kStatus GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window)
Sets the y-direction gap-filling window.
k64f GoSetup_ActiveAreaLength(GoSetup setup, GoRole role)
Gets the active area Length.
GoAlignmentTarget GoSetup_AlignmentStationaryTarget(GoSetup setup)
Gets the target type used for alignment calibration.
k64f GoSetup_FrameRateLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Frame Rate setting.
k64f GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f x)
Sets the active area x origin.
Represents the part detection parameters of the surface mode configuration.
Definition: GoPartDetection.h:16
kStatus GoSetup_SetOrientation(GoSetup setup, GoOrientation orientation)
Sets the transform x-offset.
kStatus GoSetup_SetPlateHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration plate.
k64f GoSetup_BarHoleDistance(GoSetup setup)
Gets the distance between holes that are defined on the calibration bar.
k64f GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f z)
Sets the active area z origin.
kStatus GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the exposure value.
kStatus GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling)
Sets the current z-resolution divider.
kStatus GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f height)
Sets the active area height.
kSize GoSetup_PlateHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration plate.
k32u GoSetup_FrontCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
k32u GoSetup_FrontCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
kStatus GoSetup_SetScanMode(GoSetup setup, GoMode mode)
Sets the default operation mode of the sensor system.
k64f GoSetup_BarHoleDiameter(GoSetup setup)
Gets the diameter of holes that are defined on the calibration bar.
k64f GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the tracking window height minimum limit.
k64f GoSetup_PlateSecHoleDiameter(GoSetup setup)
Gets the diameter of the secondary hole defined on the calibration plate.
k64f GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role)
Gets the tracking window search threshold.
kStatus GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height)
Sets the tracking window height.
k64f GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role)
Gets the tracking window height.
k64f GoSetup_XSmoothingWindowLimitMin(GoSetup setup)
Gets the x-direction smoothing window minimum.
k64f GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaHeight setting.
kStatus GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable)
Enables or disables operation at full frame rate (ignoring frame rate setting).
kStatus GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window)
Sets the y-direction smoothing window.
k64f GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaHeight setting.
kStatus GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit)
Sets the system trigger units.
kStatus GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable)
Enables tracking.
Declares the GoSurfaceGeneration class.
k32u GoSetup_FrontCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
k64f GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaY setting.
kStatus GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled)
Enables encoder calibration after alignment.
k64f GoSetup_DynamicExposureMin(GoSetup setup, GoRole role)
Gets the minimum value for the Dynamic Exposure setting.
kBool GoSetup_XGapFillingEnabled(GoSetup setup)
Gets the status of x-direction gap-filling.
k64f GoSetup_BarHeight(GoSetup setup)
Gets the height of the bar used for travel calibration.
k64f GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f Length)
Sets the active area Length.
k64f GoSetup_ExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the Exposure setting.
kStatus GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure)
Sets the minimum value for the Dynamic Exposure setting.
k64f GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaY setting.
k64f GoSetup_PlateRefHoleDiameter(GoSetup setup)
Gets the diameter of the reference hole defined on the calibration plate.
k64f GoSetup_YSmoothingWindowLimitMin(GoSetup setup)
Gets the y-direction smoothing window minimum.
kStatus GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance)
Sets the distance between holes that are defined on the calibration bar.
kStatus GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode)
Sets the exposure mode.
k64f GoSetup_EncoderSpacingLimitMin(GoSetup setup)
Constraint for the minimum valid value of the EncoderPeriod setting.
kBool GoSetup_TrackingEnabled(GoSetup setup, GoRole role)
Determines if tracking is enabled.
k32u GoSetup_FrontCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
kStatus GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the secondary hole defined on the calibration plate.
k64f GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f width)
Sets the active area width.
kBool GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup)
Gets the value of the post alignment encoder calibration setting.
GoTriggerUnits GoSetup_TriggerUnit(GoSetup setup)
Gets the system trigger units.
kStatus GoSetup_SetDiskHeight(GoSetup setup, k64f height)
Sets the height of the disk used for travel calibration.
kStatus GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window)
Sets the status of x-direction gap-filling.
k64f GoSetup_ActiveAreaY(GoSetup setup, GoRole role)
Gets the active area Y.
kStatus GoSetup_SetTriggerDelay(GoSetup setup, k64f delay)
Sets the trigger delay.
k64f GoSetup_TriggerDelay(GoSetup setup)
Gets the trigger delay.
kStatus GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling)
Sets the current x-resolution divider.
kStatus GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of holes that are defined on the calibration bar.
k64f GoSetup_TriggerDelayLimitMin(GoSetup setup)
Reports the minimum trigger delay, based on current settings.
kStatus GoSetup_SetDefaultState(GoSetup setup, GoState state)
Sets the default state of the sensor system upon boot.
kStatus GoSetup_EnableYGapFilling(GoSetup setup, kBool enable)
Sets the status of y-direction gap-filling.
kStatus GoSetup_EnableXGapFilling(GoSetup setup, kBool enable)
Sets the status of x-direction gap-filling.
kStatus GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure)
Adds an exposure step.
kStatus GoSetup_SetEncoderSpacing(GoSetup setup, k64f period)
Sets the current encoder period for encoder-based triggering.
k64f GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaLength setting.
Represents a ...
Definition: GoSetup.h:17
k64f GoSetup_ExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the Exposure setting.
k64f GoSetup_XGapFillingWindowLimitMin(GoSetup setup)
Gets the x-direction gap-filling window minimum.
k64f GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the tracking window height maximum limit.
Declares the GoLayout class.
k64f GoSetup_XSmoothingWindow(GoSetup setup)
Gets the x-direction smoothing window.
k64f GoSetup_YGapFillingWindow(GoSetup setup)
Gets the y-direction gap-filling window.
k64f GoSetup_FrameRateLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Frame Rate setting.
k64f GoSetup_FrameRate(GoSetup setup)
Reports the currently configured frame rate.
k64f GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role)
Gets the active area width.
kBool GoSetup_TriggerGateEnabled(GoSetup setup)
Reports whether the trigger gate feature is currently enabled.
Represents the current state of a sensor object.
k64f GoSetup_EncoderSpacing(GoSetup setup)
Gets the current encoder period for encoder-based triggering.