Gocator API

- Home
- Categories
- Types
- Files

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