Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoMeasurements.h
Go to the documentation of this file.
1 /**
2 * @file GoMeasurements.h
3 * @brief Declares the GoMeasurement classes.
4 *
5 * @internal
6 * Copyright (C) 2016-2018 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_MEASUREMENTS_H
11 #define GO_SDK_MEASUREMENTS_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoMeasurement.h>
15 #include <GoSdk/Tools/GoExtMeasurement.h>
16 #include <GoSdk/Tools/GoExtParam.h>
17
18 kBeginHeader()
19
20 /// @cond Gocator_1x00
21
22 /**
23 * @class GoRangePositionZ
24 * @extends GoMeasurement
25 * @ingroup GoSdk
26 * @brief Represents a position Z measurement of a Range Position tool.
27 */
28 typedef GoMeasurement GoRangePositionZ;
29
30 /**
31 * @class GoRangeThicknessThickness
32 * @extends GoMeasurement
33 * @ingroup GoSdk
34 * @brief Represents a the thickness measurement of a Range Thickness tool.
35 */
36 typedef GoMeasurement GoRangeThicknessThickness;
37
38 /// @endcond
39
40
41 /**
42 * @class GoProfileAreaArea
43 * @extends GoMeasurement
44 * @ingroup GoSdk-ProfileTools
45 * @brief Represents an area measurement for a Profile Area tool.
46 */
47 typedef GoMeasurement GoProfileAreaArea;
48
49 /**
50 * @class GoProfileAreaCentroidX
51 * @extends GoMeasurement
52 * @ingroup GoSdk-ProfileTools
53 * @brief Represents a centroid X measurement for a Profile Area Tool.
54 */
55 typedef GoMeasurement GoProfileAreaCentroidX;
56
57 /**
58 * @class GoProfileAreaCentroidZ
59 * @extends GoMeasurement
60 * @ingroup GoSdk-ProfileTools
61 * @brief Represents a centroid Z measurement for a Profile Area Tool.
62 */
63 typedef GoMeasurement GoProfileAreaCentroidZ;
64
65 /**
66 * @class GoProfileBoxX
67 * @extends GoMeasurement
68 * @ingroup GoSdk-ProfileTools
69 * @brief Represents an X measurement for a Profile Bounding Box tool.
70 */
71 typedef GoMeasurement GoProfileBoxX;
72
73 /**
74 * @class GoProfileBoxZ
75 * @extends GoMeasurement
76 * @ingroup GoSdk-ProfileTools
77 * @brief Represents a Z measurement for a Profile Bounding Box tool.
78 */
79 typedef GoMeasurement GoProfileBoxZ;
80
81 /**
82 * @class GoProfileBoxWidth
83 * @extends GoMeasurement
84 * @ingroup GoSdk-ProfileTools
85 * @brief Represents a width measurement for a Profile Bounding Box tool.
86 */
87 typedef GoMeasurement GoProfileBoxWidth;
88
89 /**
90 * @class GoProfileBoxHeight
91 * @extends GoMeasurement
92 * @ingroup GoSdk-ProfileTools
93 * @brief Represents a height measurement for a Profile Bounding Box tool.
94 */
95 typedef GoMeasurement GoProfileBoxHeight;
96
97 /**
98 * @class GoProfileBoxGlobalX
99 * @extends GoMeasurement
100 * @ingroup GoSdk-ProfileTools
101 * @brief Represents a global X measurement for a Profile Bounding Box tool.
102 */
103 typedef GoMeasurement GoProfileBoxGlobalX;
104
105 /**
106 * @class GoProfileBoxGlobalY
107 * @extends GoMeasurement
108 * @ingroup GoSdk-ProfileTools
109 * @brief Represents a global Y measurement for a Profile Bounding Box tool.
110 */
111 typedef GoMeasurement GoProfileBoxGlobalY;
112
113 /**
114 * @class GoProfileBoxGlobalAngle
115 * @extends GoMeasurement
116 * @ingroup GoSdk-ProfileTools
117 * @brief Represents a global angle measurement for a Profile Bounding Box tool.
118 */
119 typedef GoMeasurement GoProfileBoxGlobalAngle;
120
121 /**
122 * @class GoProfileBridgeValueBridgeValue
123 * @extends GoMeasurement
124 * @ingroup GoSdk-ProfileTools
125 * @brief Represents a bridge value measurement for a Profile Bridge Value tool.
126 */
127 typedef GoMeasurement GoProfileBridgeValueBridgeValue;
128
129 /**
130 * @class GoProfileBridgeValueAngle
131 * @extends GoMeasurement
132 * @ingroup GoSdk-ProfileTools
133 * @brief Represents an angle measurement for a Profile Bridge Value tool.
134 */
135 typedef GoMeasurement GoProfileBridgeValueAngle;
136
137 /**
138 * @class GoProfileBridgeValueWindow
139 * @extends GoMeasurement
140 * @ingroup GoSdk-ProfileTools
141 * @brief Represents an window measurement for a Profile Bridge Value tool.
142 */
143 typedef GoMeasurement GoProfileBridgeValueWindow;
144
145 /**
146 * @class GoProfileBridgeValueStdDev
147 * @extends GoMeasurement
148 * @ingroup GoSdk-ProfileTools
149 * @brief Represents an standard deviation measurement for a Profile Bridge Value tool.
150 */
151 typedef GoMeasurement GoProfileBridgeValueStdDev;
152
153
154 /**
155 * @class GoProfileCircleX
156 * @extends GoMeasurement
157 * @ingroup GoSdk-ProfileTools
158 * @brief Represents an X value measurement for a Profile Circle Tool.
159 */
160 typedef GoMeasurement GoProfileCircleX;
161
162 /**
163 * @class GoProfileCircleZ
164 * @extends GoMeasurement
165 * @ingroup GoSdk-ProfileTools
166 * @brief Represents a Z value measurement for a Profile Circle Tool.
167 */
168 typedef GoMeasurement GoProfileCircleZ;
169
170 /**
171 * @class GoProfileCircleRadius
172 * @extends GoMeasurement
173 * @ingroup GoSdk-ProfileTools
174 * @brief Represents a radius value measurement for a Profile Circle Tool.
175 */
176 typedef GoMeasurement GoProfileCircleRadius;
177
178 /**
179 * @class GoProfileCircleStdDev
180 * @extends GoMeasurement
181 * @ingroup GoSdk-ProfileTools
182 * @brief Represents a standard deviation measurement for a Profile Circle Tool.
183 */
184 typedef GoMeasurement GoProfileCircleStdDev;
185
186 /**
187 * @class GoProfileCircleMinError
188 * @extends GoMeasurement
189 * @ingroup GoSdk-ProfileTools
190 * @brief Represents a min error measurement for a Profile Circle Tool.
191 */
192 typedef GoMeasurement GoProfileCircleMinError;
193
194 /**
195 * @class GoProfileCircleMinErrorX
196 * @extends GoMeasurement
197 * @ingroup GoSdk-ProfileTools
198 * @brief Represents a min error X measurement for a Profile Circle Tool.
199 */
200 typedef GoMeasurement GoProfileCircleMinErrorX;
201
202 /**
203 * @class GoProfileCircleMinErrorZ
204 * @extends GoMeasurement
205 * @ingroup GoSdk-ProfileTools
206 * @brief Represents a min error Z measurement for a Profile Circle Tool.
207 */
208 typedef GoMeasurement GoProfileCircleMinErrorZ;
209
210 /**
211 * @class GoProfileCircleMaxError
212 * @extends GoMeasurement
213 * @ingroup GoSdk-ProfileTools
214 * @brief Represents a max error measurement for a Profile Circle Tool.
215 */
216 typedef GoMeasurement GoProfileCircleMaxError;
217
218 /**
219 * @class GoProfileCircleMaxErrorX
220 * @extends GoMeasurement
221 * @ingroup GoSdk-ProfileTools
222 * @brief Represents a max error X measurement for a Profile Circle Tool.
223 */
224 typedef GoMeasurement GoProfileCircleMaxErrorX;
225
226 /**
227 * @class GoProfileCircleMaxErrorZ
228 * @extends GoMeasurement
229 * @ingroup GoSdk-ProfileTools
230 * @brief Represents a max error Z measurement for a Profile Circle Tool.
231 */
232 typedef GoMeasurement GoProfileCircleMaxErrorZ;
233
234
235 /**
236 * @class GoProfileDimWidth
237 * @extends GoMeasurement
238 * @ingroup GoSdk-ProfileTools
239 * @brief Represents a width value measurement for a Profile Dimension Tool.
240 */
241 typedef GoMeasurement GoProfileDimWidth;
242
243 /**
244 * Returns a boolean value representing whether an absolute measurement value will be returned.
245 *
246 * @public @memberof GoProfileDimWidth
247 * @version Introduced in firmware 4.0.10.27
248 * @param measurement GoProfileDimWidth object.
249 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
250 */
251 GoFx(kBool) GoProfileDimWidth_AbsoluteEnabled(GoProfileDimWidth measurement);
252
253 /**
254 * Enables or disables an absolute value result for the given measurement.
255 *
256 * @public @memberof GoProfileDimWidth
257 * @version Introduced in firmware 4.0.10.27
258 * @param measurement GoProfileDimWidth object.
259 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
260 * @return Operation status.
261 */
262 GoFx(kStatus) GoProfileDimWidth_EnableAbsolute(GoProfileDimWidth measurement, kBool absolute);
263
264 /**
265 * @class GoProfileDimHeight
266 * @extends GoMeasurement
267 * @ingroup GoSdk-ProfileTools
268 * @brief Represents a height value measurement for a Profile Dimension Tool.
269 */
270 typedef GoMeasurement GoProfileDimHeight;
271
272 /**
273 * Returns a boolean value representing whether an absolute measurement value will be returned.
274 *
275 * @public @memberof GoProfileDimHeight
276 * @version Introduced in firmware 4.0.10.27
277 * @param measurement GoProfileDimHeight object.
278 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
279 */
280 GoFx(kBool) GoProfileDimHeight_AbsoluteEnabled(GoProfileDimHeight measurement);
281
282 /**
283 * Enables or disables an absolute value result for the given measurement.
284 *
285 * @public @memberof GoProfileDimHeight
286 * @version Introduced in firmware 4.0.10.27
287 * @param measurement GoProfileDimHeight object.
288 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
289 * @return Operation status.
290 */
291 GoFx(kStatus) GoProfileDimHeight_EnableAbsolute(GoProfileDimHeight measurement, kBool absolute);
292
293 /**
294 * @class GoProfileDimDistance
295 * @extends GoMeasurement
296 * @ingroup GoSdk-ProfileTools
297 * @brief Represents a distance value measurement for a Profile Dimension Tool.
298 */
299 typedef GoMeasurement GoProfileDimDistance;
300
301 /**
302 * @class GoProfileDimCenterX
303 * @extends GoMeasurement
304 * @ingroup GoSdk-ProfileTools
305 * @brief Represents a center X value measurement for a Profile Dimension Tool.
306 */
307 typedef GoMeasurement GoProfileDimCenterX;
308
309 /**
310 * @class GoProfileDimCenterZ
311 * @extends GoMeasurement
312 * @ingroup GoSdk-ProfileTools
313 * @brief Represents a center Z value measurement for a Profile Dimension Tool.
314 */
315 typedef GoMeasurement GoProfileDimCenterZ;
316
317 /**
318 * @class GoProfileIntersectX
319 * @extends GoMeasurement
320 * @ingroup GoSdk-ProfileTools
321 * @brief Represents an intersect X measurement for a Profile Intersect Tool.
322 */
323 typedef GoMeasurement GoProfileIntersectX;
324
325 /**
326 * @class GoProfileIntersectZ
327 * @extends GoMeasurement
328 * @ingroup GoSdk-ProfileTools
329 * @brief Represents an intersect Z measurement for a Profile Intersect Tool.
330 */
331 typedef GoMeasurement GoProfileIntersectZ;
332
333 /**
334 * @class GoProfileIntersectAngle
335 * @extends GoMeasurement
336 * @ingroup GoSdk-ProfileTools
337 * @brief Represents an intersect angle measurement for a Profile Intersect Tool.
338 */
339 typedef GoMeasurement GoProfileIntersectAngle;
340
341 /**
342 * Returns a boolean value representing whether a absolute measurement value
343 * in the range of 0 to 180 degrees instead of -90 to 90 will be returned.
344 *
345 * @public @memberof GoProfileIntersectAngle
346 * @version Introduced in firmware 4.4.4.14
347 * @param measurement GoProfileIntersectAngle object.
348 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
349 */
350 GoFx(kBool) GoProfileIntersectAngle_Range0to180Enabled(GoProfileIntersectAngle measurement);
351
352 /**
353 * Enables or disables a result in the range of 0 to 180 instead of -90 to 90 degrees for the given measurement.
354 *
355 * @public @memberof GoProfileIntersectAngle
356 * @version Introduced in firmware 4.4.4.14
357 * @param measurement GoProfileIntersectAngle object.
358 * @param enable kTRUE to use a range of 0 to 180 and kFALSE to use a range of -90 to 90 degrees.
359 * @return Operation status.
360 */
361 GoFx(kStatus) GoProfileIntersectAngle_EnableRange0to180(GoProfileIntersectAngle measurement, kBool enable);
362
363 /**
364 * @class GoProfileGrooveX
365 * @extends GoMeasurement
366 * @ingroup GoSdk-ProfileTools
367 * @brief Represents an X value measurement for a Profile Groove Tool.
368 */
369 typedef GoMeasurement GoProfileGrooveX;
370
371 /**
372 * Gets the current groove location.
373 *
374 * @public @memberof GoProfileGrooveX
375 * @version Introduced in firmware 4.0.10.27
376 * @param measurement GoProfileGrooveX object.
377 * @return The profile groove location.
378 */
379 GoFx(GoProfileGrooveLocation) GoProfileGrooveX_Location(GoProfileGrooveX measurement);
380
381 /**
382 * Sets the groove location.
383 *
384 * @public @memberof GoProfileGrooveX
385 * @version Introduced in firmware 4.0.10.27
386 * @param measurement GoProfileGrooveX object.
387 * @param value The groove location value to be set.
388 * @return Operation status.
389 */
390 GoFx(kStatus) GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value);
391
392
393 /**
394 * Gets the current groove selection type.
395 *
396 * @public @memberof GoProfileGrooveX
397 * @version Introduced in firmware 4.0.10.27
398 * @param measurement GoProfileGrooveX object.
399 * @return The profile groove selection type.
400 */
401 GoFx(GoProfileGrooveSelectType) GoProfileGrooveX_SelectType(GoProfileGrooveX measurement);
402
403 /**
404 * Sets the groove selection type.
405 *
406 * @public @memberof GoProfileGrooveX
407 * @version Introduced in firmware 4.0.10.27
408 * @param measurement GoProfileGrooveX object.
409 * @param selectType The profile groove type.
410 * @return Operation status.
411 */
412 GoFx(kStatus) GoProfileGrooveX_SetSelectType(GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType);
413
414 /**
415 * Gets the current selected groove index.
416 *
417 * @public @memberof GoProfileGrooveX
418 * @version Introduced in firmware 4.0.10.27
419 * @param measurement GoProfileGrooveX object.
420 * @return The current groove index.
421 */
422 GoFx(k32u) GoProfileGrooveX_SelectIndex(GoProfileGrooveX measurement);
423
424 /**
425 * Sets the selected groove index.
426 *
427 * @public @memberof GoProfileGrooveX
428 * @version Introduced in firmware 4.0.10.27
429 * @param measurement GoProfileGrooveX object.
430 * @param selectN The selected groove index.
431 * @return Operation status.
432 */
433 GoFx(kStatus) GoProfileGrooveX_SetSelectIndex(GoProfileGrooveX measurement, k32u selectN);
434
435
436
437 /**
438 * @class GoProfileGrooveZ
439 * @extends GoMeasurement
440 * @ingroup GoSdk-ProfileTools
441 * @brief Represents a Z value measurement for a Profile Groove tool.
442 */
443 typedef GoMeasurement GoProfileGrooveZ;
444
445 /**
446 * Gets the current groove location type.
447 *
448 * @public @memberof GoProfileGrooveZ
449 * @version Introduced in firmware 4.0.10.27
450 * @param measurement GoProfileGrooveZ object.
451 * @return The profile groove location type.
452 */
453 GoFx(GoProfileGrooveLocation) GoProfileGrooveZ_Location(GoProfileGrooveZ measurement);
454
455 /**
456 * Sets the groove location type.
457 *
458 * @public @memberof GoProfileGrooveZ
459 * @version Introduced in firmware 4.0.10.27
460 * @param measurement GoProfileGrooveZ object.
461 * @param location The profile groove location type.
462 * @return Operation status.
463 */
464 GoFx(kStatus) GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location);
465
466 /**
467 * Gets the current groove selection type.
468 *
469 * @public @memberof GoProfileGrooveZ
470 * @version Introduced in firmware 4.0.10.27
471 * @param measurement GoProfileGrooveZ object.
472 * @return The profile groove selection type.
473 */
474 GoFx(GoProfileGrooveSelectType) GoProfileGrooveZ_SelectType(GoProfileGrooveZ measurement);
475
476 /**
477 * Sets the groove selection type.
478 *
479 * @public @memberof GoProfileGrooveZ
480 * @version Introduced in firmware 4.0.10.27
481 * @param measurement GoProfileGrooveZ object.
482 * @param selectType The profile groove selection type.
483 * @return Operation status.
484 */
485 GoFx(kStatus) GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType);
486
487 /**
488 * Gets the current selected groove index.
489 *
490 * @public @memberof GoProfileGrooveZ
491 * @version Introduced in firmware 4.0.10.27
492 * @param measurement GoProfileGrooveZ object.
493 * @return The current groove index.
494 */
495 GoFx(k32u) GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement);
496
497 /**
498 * Sets the selected groove index.
499 *
500 * @public @memberof GoProfileGrooveZ
501 * @version Introduced in firmware 4.0.10.27
502 * @param measurement GoProfileGrooveZ object.
503 * @param selectN The selected groove index.
504 * @return Operation status.
505 */
506 GoFx(kStatus) GoProfileGrooveZ_SetSelectIndex(GoProfileGrooveZ measurement, k32u selectN);
507
508
509 /**
510 * @class GoProfileGrooveWidth
511 * @extends GoMeasurement
512 * @ingroup GoSdk-ProfileTools
513 * @brief Represents a width measurement for a Profile Groove Tool.
514 */
515 typedef GoMeasurement GoProfileGrooveWidth;
516
517 /**
518 * Gets the current groove selection type.
519 *
520 * @public @memberof GoProfileGrooveWidth
521 * @version Introduced in firmware 4.0.10.27
522 * @param measurement GoProfileGrooveWidth object.
523 * @return The profile groove selection type.
524 */
525 GoFx(GoProfileGrooveSelectType) GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement);
526
527 /**
528 * Sets the groove selection type.
529 *
530 * @public @memberof GoProfileGrooveWidth
531 * @version Introduced in firmware 4.0.10.27
532 * @param measurement GoProfileGrooveWidth object.
533 * @param selectType The profile groove type.
534 * @return Operation status.
535 */
536 GoFx(kStatus) GoProfileGrooveWidth_SetSelectType(GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType);
537
538 /**
539 * Gets the current selected groove index.
540 *
541 * @public @memberof GoProfileGrooveWidth
542 * @version Introduced in firmware 4.0.10.27
543 * @param measurement GoProfileGrooveWidth object.
544 * @return The current groove index.
545 */
546 GoFx(k32u) GoProfileGrooveWidth_SelectIndex(GoProfileGrooveWidth measurement);
547
548 /**
549 * Sets the selected groove index.
550 *
551 * @public @memberof GoProfileGrooveWidth
552 * @version Introduced in firmware 4.0.10.27
553 * @param measurement GoProfileGrooveWidth object.
554 * @param selectN The selected groove index.
555 * @return Operation status.
556 */
557 GoFx(kStatus) GoProfileGrooveWidth_SetSelectIndex(GoProfileGrooveWidth measurement, k32u selectN);
558
559
560 /**
561 * @class GoProfileGrooveDepth
562 * @extends GoMeasurement
563 * @ingroup GoSdk-ProfileTools
564 * @brief Represents a depth measurement for a Profile Groove Tool.
565 */
566 typedef GoMeasurement GoProfileGrooveDepth;
567
568 /**
569 * Gets the current groove selection type.
570 *
571 * @public @memberof GoProfileGrooveDepth
572 * @version Introduced in firmware 4.0.10.27
573 * @param measurement GoProfileGrooveDepth object.
574 * @return The profile groove selection type.
575 */
576 GoFx(GoProfileGrooveSelectType) GoProfileGrooveDepth_SelectType(GoProfileGrooveDepth measurement);
577
578 /**
579 * Sets the groove selection type.
580 *
581 * @public @memberof GoProfileGrooveDepth
582 * @version Introduced in firmware 4.0.10.27
583 * @param measurement GoProfileGrooveDepth object.
584 * @param selectType The profile groove type.
585 * @return Operation status.
586 */
587 GoFx(kStatus) GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType);
588
589 /**
590 * Gets the current selected groove index.
591 *
592 * @public @memberof GoProfileGrooveDepth
593 * @version Introduced in firmware 4.0.10.27
594 * @param measurement GoProfileGrooveDepth object.
595 * @return The current groove index.
596 */
597 GoFx(k32u) GoProfileGrooveDepth_SelectIndex(GoProfileGrooveDepth measurement);
598
599 /**
600 * Sets the selected groove index.
601 *
602 * @public @memberof GoProfileGrooveDepth
603 * @version Introduced in firmware 4.0.10.27
604 * @param measurement GoProfileGrooveDepth object.
605 * @param selectN The selected groove index.
606 * @return Operation status.
607 */
608 GoFx(kStatus) GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN);
609
610
611 /**
612 * @class GoProfileLineStdDev
613 * @extends GoMeasurement
614 * @ingroup GoSdk-ProfileTools
615 * @brief Represents a standard deviation measurement for a Profile Line Tool.
616 */
617 typedef GoMeasurement GoProfileLineStdDev;
618
619 /**
620 * @class GoProfileLineMinError
621 * @extends GoMeasurement
622 * @ingroup GoSdk-ProfileTools
623 * @brief Represents a minimum error measurement for a Profile Line Tool.
624 */
625 typedef GoMeasurement GoProfileLineMinError;
626
627 /**
628 * @class GoProfileLineMaxError
629 * @extends GoMeasurement
630 * @ingroup GoSdk-ProfileTools
631 * @brief Represents a maximum error measurement for a Profile Line Tool.
632 */
633 typedef GoMeasurement GoProfileLineMaxError;
634
635 /**
636 * @class GoProfileLinePercentile
637 * @extends GoMeasurement
638 * @ingroup GoSdk-ProfileTools
639 * @brief Represents a percentile measurement for a Profile Line Tool.
640 */
641 typedef GoMeasurement GoProfileLinePercentile;
642
643 /**
644 * @class GoProfileLineOffset
645 * @extends GoMeasurement
646 * @ingroup GoSdk-ProfileTools
647 * @brief Represents an offset measurement for a Profile Line Tool.
648 */
649 typedef GoMeasurement GoProfileLineOffset;
650
651 /**
652 * @class GoProfileLineAngle
653 * @extends GoMeasurement
654 * @ingroup GoSdk-ProfileTools
655 * @brief Represents an Angle measurement for a Profile Line Tool.
656 */
657 typedef GoMeasurement GoProfileLineAngle;
658
659 /**
660 * @class GoProfileLineMinErrorX
661 * @extends GoMeasurement
662 * @ingroup GoSdk-ProfileTools
663 * @brief Represents an Minimum X Error measurement for a Profile Line Tool.
664 */
665 typedef GoMeasurement GoProfileLineMinErrorX;
666
667 /**
668 * @class GoProfileLineMinErrorZ
669 * @extends GoMeasurement
670 * @ingroup GoSdk-ProfileTools
671 * @brief Represents a Minimum Z Error measurement for a Profile Line Tool.
672 */
673 typedef GoMeasurement GoProfileLineMinErrorZ;
674
675 /**
676 * @class GoProfileLineMaxErrorX
677 * @extends GoMeasurement
678 * @ingroup GoSdk-ProfileTools
679 * @brief Represents a Maximum X Error measurement for a Profile Line Tool.
680 */
681 typedef GoMeasurement GoProfileLineMaxErrorX;
682
683 /**
684 * @class GoProfileLineMaxErrorZ
685 * @extends GoMeasurement
686 * @ingroup GoSdk-ProfileTools
687 * @brief Represents a Maximum Z Error measurement for a Profile Line Tool.
688 */
689 typedef GoMeasurement GoProfileLineMaxErrorZ;
690
691 /**
692 * Gets the percent threshold.
693 *
694 * @public @memberof GoProfileLinePercentile
695 * @version Introduced in firmware 4.0.10.27
696 * @param measurement GoProfileLinePercentile object.
697 * @return The percent threshold.
698 */
699 GoFx(k64f) GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement);
700
701 /**
702 * Sets the percent threshold.
703 *
704 * @public @memberof GoProfileLinePercentile
705 * @version Introduced in firmware 4.0.10.27
706 * @param measurement GoProfileLinePercentile object.
707 * @param percent The percent threshold to set.
708 * @return Operation status.
709 */
710 GoFx(kStatus) GoProfileLinePercentile_SetPercent(GoProfileLinePercentile measurement, k64f percent);
711
712 /**
713 * @class GoProfilePanelGap
714 * @extends GoMeasurement
715 * @ingroup GoSdk-ProfileTools
716 * @brief Represents a gap measurement for a Profile Panel Tool.
717 */
718 typedef GoMeasurement GoProfilePanelGap;
719
720 /**
721 * Gets the gap axis.
722 *
723 * @public @memberof GoProfilePanelGap
724 * @version Introduced in firmware 4.0.10.27
725 * @param measurement GoProfilePanelGap object.
726 * @return The gap axis.
727 */
728 GoFx(GoProfileGapAxis) GoProfilePanelGap_Axis(GoProfilePanelGap measurement);
729
730 /**
731 * Sets the gap axis.
732 *
733 * @public @memberof GoProfilePanelGap
734 * @version Introduced in firmware 4.0.10.27
735 * @param measurement GoProfilePanelGap object.
736 * @param axis The gap axis value to set.
737 * @return Operation status.
738 */
739 GoFx(kStatus) GoProfilePanelGap_SetAxis(GoProfilePanelGap measurement, GoProfileGapAxis axis);
740
741 /**
742 * @class GoProfilePanelFlush
743 * @extends GoMeasurement
744 * @ingroup GoSdk-ProfileTools
745 * @brief Represents a flush measurement for a Profile Panel Tool.
746 */
747 typedef GoMeasurement GoProfilePanelFlush;
748
749 /**
750 * Gets absolute value state.
751 *
752 * @public @memberof GoProfilePanelFlush
753 * @version Introduced in firmware 4.0.10.27
754 * @param measurement GoProfilePanelFlush object.
755 * @return kTRUE if absolute value is enabled and kFALSE otherwise.
756 */
757 GoFx(kBool) GoProfilePanelFlush_AbsoluteEnabled(GoProfilePanelFlush measurement);
758
759 /**
760 * Enables or disables the absolute value state.
761 *
762 * @public @memberof GoProfilePanelFlush
763 * @version Introduced in firmware 4.0.10.27
764 * @param measurement GoProfilePanelFlush object.
765 * @param absolute kTRUE to enable and kFALSE to disable.
766 * @return Operation status.
767 */
768 GoFx(kStatus) GoProfilePanelFlush_EnableAbsolute(GoProfilePanelFlush measurement, kBool absolute);
769
770 /**
771 * @class GoProfilePanelLeftGapX
772 * @extends GoMeasurement
773 * @ingroup GoSdk-ProfileTools
774 * @brief Represents a Left Gap X measurement for a Profile Panel tool.
775 */
776 typedef GoMeasurement GoProfilePanelLeftGapX;
777
778 /**
779 * @class GoProfilePanelLeftGapZ
780 * @extends GoMeasurement
781 * @ingroup GoSdk-ProfileTools
782 * @brief Represents a Left Gap Z measurement for a Profile Panel tool.
783 */
784 typedef GoMeasurement GoProfilePanelLeftGapZ;
785
786 /**
787 * @class GoProfilePanelLeftFlushX
788 * @extends GoMeasurement
789 * @ingroup GoSdk-ProfileTools
790 * @brief Represents a Left Flush X measurement for a Profile Panel tool.
791 */
792 typedef GoMeasurement GoProfilePanelLeftFlushX;
793
794 /**
795 * @class GoProfilePanelLeftFlushZ
796 * @extends GoMeasurement
797 * @ingroup GoSdk-ProfileTools
798 * @brief Represents a Left Flush Z measurement for a Profile Panel tool.
799 */
800 typedef GoMeasurement GoProfilePanelLeftFlushZ;
801
802 /**
803 * @class GoProfilePanelLeftSurfaceAngle
804 * @extends GoMeasurement
805 * @ingroup GoSdk-ProfileTools
806 * @brief Represents a Left Surface Angle measurement for a Profile Panel tool.
807 */
808 typedef GoMeasurement GoProfilePanelLeftSurfaceAngle;
809
810 /**
811 * @class GoProfilePanelRightGapX
812 * @extends GoMeasurement
813 * @ingroup GoSdk-ProfileTools
814 * @brief Represents a Right Gap X measurement for a Profile Panel tool.
815 */
816 typedef GoMeasurement GoProfilePanelRightGapX;
817
818 /**
819 * @class GoProfilePanelRightGapZ
820 * @extends GoMeasurement
821 * @ingroup GoSdk-ProfileTools
822 * @brief Represents a Right Gap Z measurement for a Profile Panel tool.
823 */
824 typedef GoMeasurement GoProfilePanelRightGapZ;
825
826 /**
827 * @class GoProfilePanelRightFlushX
828 * @extends GoMeasurement
829 * @ingroup GoSdk-ProfileTools
830 * @brief Represents a Right Flush X measurement for a Profile Panel tool.
831 */
832 typedef GoMeasurement GoProfilePanelRightFlushX;
833
834 /**
835 * @class GoProfilePanelRightFlushZ
836 * @extends GoMeasurement
837 * @ingroup GoSdk-ProfileTools
838 * @brief Represents a Right Flush Z measurement for a Profile Panel tool.
839 */
840 typedef GoMeasurement GoProfilePanelRightFlushZ;
841
842 /**
843 * @class GoProfilePanelRightSurfaceAngle
844 * @extends GoMeasurement
845 * @ingroup GoSdk-ProfileTools
846 * @brief Represents a Right Surface Angle measurement for a Profile Panel tool.
847 */
848 typedef GoMeasurement GoProfilePanelRightSurfaceAngle;
849
850 /**
851 * @class GoProfileRoundCornerX
852 * @extends GoMeasurement
853 * @ingroup GoSdk-ProfileTools
854 * @brief Represents an X measurement for a Profile Round Corner tool.
855 */
856 typedef GoMeasurement GoProfileRoundCornerX;
857
858 /**
859 * @class GoProfileRoundCornerZ
860 * @extends GoMeasurement
861 * @ingroup GoSdk-ProfileTools
862 * @brief Represents an Z measurement for a Profile Round Corner tool.
863 */
864 typedef GoMeasurement GoProfileRoundCornerZ;
865
866 /**
867 * @class GoProfileRoundCornerAngle
868 * @extends GoMeasurement
869 * @ingroup GoSdk-ProfileTools
870 * @brief Represents an Angle measurement for a Profile Round Corner tool.
871 */
872 typedef GoMeasurement GoProfileRoundCornerAngle;
873
874 /**
875 * @class GoProfilePositionX
876 * @extends GoMeasurement
877 * @ingroup GoSdk-ProfileTools
878 * @brief Represents an X measurement for a Profile Position tool.
879 */
880 typedef GoMeasurement GoProfilePositionX;
881
882 /**
883 * @class GoProfilePositionZ
884 * @extends GoMeasurement
885 * @ingroup GoSdk-ProfileTools
886 * @brief Represents an Z measurement for a Profile Position tool.
887 */
888 typedef GoMeasurement GoProfilePositionZ;
889
890
891 /**
892 * @class GoProfileStripX
893 * @extends GoMeasurement
894 * @ingroup GoSdk-ProfileTools
895 * @brief Represents an X measurement for a Profile Strip Tool.
896 */
897 typedef GoMeasurement GoProfileStripX;
898
899 /**
900 * Gets the groove location configuration value.
901 *
902 * @public @memberof GoProfileStripX
903 * @version Introduced in firmware 4.0.10.27
904 * @param measurement GoProfileStripX object.
905 * @return The profile groove location.
906 */
907 GoFx(GoProfileGrooveLocation) GoProfileStripX_Location(GoProfileStripX measurement);
908
909 /**
910 * Sets the groove location configuration value.
911 *
912 * @public @memberof GoProfileStripX
913 * @version Introduced in firmware 4.0.10.27
914 * @param measurement GoProfileStripX object.
915 * @param location The groove location value to set.
916 * @return Operation status.
917 */
918 GoFx(kStatus) GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location);
919
920 /**
921 * Gets the select type.
922 *
923 * @public @memberof GoProfileStripX
924 * @version Introduced in firmware 4.0.10.27
925 * @param measurement GoProfileStripX object.
926 * @return The select type.
927 */
928 GoFx(GoProfileGrooveSelectType) GoProfileStripX_SelectType(GoProfileStripX measurement);
929
930 /**
931 * Sets the select type.
932 *
933 * @public @memberof GoProfileStripX
934 * @version Introduced in firmware 4.0.10.27
935 * @param measurement GoProfileStripX object.
936 * @param selectType The select type to set.
937 * @return Operation status.
938 */
939 GoFx(kStatus) GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType);
940
941 /**
942 * Gets the select index.
943 *
944 * @public @memberof GoProfileStripX
945 * @version Introduced in firmware 4.0.10.27
946 * @param measurement GoProfileStripX object.
947 * @return The select index.
948 */
949 GoFx(k32u) GoProfileStripX_SelectIndex(GoProfileStripX measurement);
950
951 /**
952 * Sets the select index.
953 *
954 * @public @memberof GoProfileStripX
955 * @version Introduced in firmware 4.0.10.27
956 * @param measurement GoProfileStripX object.
957 * @param selectIndex The select index value to set.
958 * @return Operation status.
959 */
960 GoFx(kStatus) GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex);
961
962
963 /**
964 * @class GoProfileStripZ
965 * @extends GoMeasurement
966 * @ingroup GoSdk-ProfileTools
967 * @brief Represents a Z measurement for a Profile Strip Tool.
968 */
969 typedef GoMeasurement GoProfileStripZ;
970
971 /**
972 * Gets the groove location configuration value.
973 *
974 * @public @memberof GoProfileStripZ
975 * @version Introduced in firmware 4.0.10.27
976 * @param measurement GoProfileStripZ object.
977 * @return The profile groove location.
978 */
979 GoFx(GoProfileGrooveLocation) GoProfileStripZ_Location(GoProfileStripZ measurement);
980
981 /**
982 * Sets the groove location configuration value.
983 *
984 * @public @memberof GoProfileStripZ
985 * @version Introduced in firmware 4.0.10.27
986 * @param measurement GoProfileStripZ object.
987 * @param location The profile groove location to set.
988 * @return Operation status.
989 */
990 GoFx(kStatus) GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location);
991
992 /**
993 * Gets the select type.
994 *
995 * @public @memberof GoProfileStripZ
996 * @version Introduced in firmware 4.0.10.27
997 * @param measurement GoProfileStripZ object.
998 * @return The select type.
999 */
1000 GoFx(GoProfileGrooveSelectType) GoProfileStripZ_SelectType(GoProfileStripZ measurement);
1001
1002 /**
1003 * Sets the select type.
1004 *
1005 * @public @memberof GoProfileStripZ
1006 * @version Introduced in firmware 4.0.10.27
1007 * @param measurement GoProfileStripZ object.
1008 * @param selectType The select type to set.
1009 * @return Operation status.
1010 */
1011 GoFx(kStatus) GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType);
1012
1013 /**
1014 * Gets the select index.
1015 *
1016 * @public @memberof GoProfileStripZ
1017 * @version Introduced in firmware 4.0.10.27
1018 * @param measurement GoProfileStripZ object.
1019 * @return The select index.
1020 */
1021 GoFx(k32u) GoProfileStripZ_SelectIndex(GoProfileStripZ measurement);
1022
1023 /**
1024 * Sets the select index.
1025 *
1026 * @public @memberof GoProfileStripZ
1027 * @version Introduced in firmware 4.0.10.27
1028 * @param measurement GoProfileStripZ object.
1029 * @param selectIndex The select index value to set.
1030 * @return Operation status.
1031 */
1032 GoFx(kStatus) GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex);
1033
1034
1035 /**
1036 * @class GoProfileStripWidth
1037 * @extends GoMeasurement
1038 * @ingroup GoSdk-ProfileTools
1039 * @brief Represents a width measurement for a Profile Strip Tool.
1040 */
1041 typedef GoMeasurement GoProfileStripWidth;
1042
1043 /**
1044 * Gets the select type.
1045 *
1046 * @public @memberof GoProfileStripWidth
1047 * @version Introduced in firmware 4.0.10.27
1048 * @param measurement GoProfileStripWidth object.
1049 * @return The select type.
1050 */
1051 GoFx(GoProfileGrooveSelectType) GoProfileStripWidth_SelectType(GoProfileStripWidth measurement);
1052
1053 /**
1054 * Sets the select type.
1055 *
1056 * @public @memberof GoProfileStripWidth
1057 * @version Introduced in firmware 4.0.10.27
1058 * @param measurement GoProfileStripWidth object.
1059 * @param selectType The select type to set.
1060 * @return Operation status.
1061 */
1062 GoFx(kStatus) GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType);
1063
1064 /**
1065 * Gets the select index.
1066 *
1067 * @public @memberof GoProfileStripWidth
1068 * @version Introduced in firmware 4.0.10.27
1069 * @param measurement GoProfileStripWidth object.
1070 * @return The select index.
1071 */
1072 GoFx(k32u) GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement);
1073
1074 /**
1075 * Sets the select index.
1076 *
1077 * @public @memberof GoProfileStripWidth
1078 * @version Introduced in firmware 4.0.10.27
1079 * @param measurement GoProfileStripWidth object.
1080 * @param selectIndex The select index value to set.
1081 * @return Operation status.
1082 */
1083 GoFx(kStatus) GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex);
1084
1085
1086 /**
1087 * @class GoProfileStripHeight
1088 * @extends GoMeasurement
1089 * @ingroup GoSdk-ProfileTools
1090 * @brief Represents an height measurement for a Profile Strip Tool.
1091 */
1092 typedef GoMeasurement GoProfileStripHeight;
1093
1094 /**
1095 * Gets the groove location setting.
1096 *
1097 * @public @memberof GoProfileStripHeight
1098 * @version Introduced in firmware 4.0.10.27
1099 * @param measurement GoProfileStripHeight object.
1100 * @return The groove location setting.
1101 */
1102 GoFx(GoProfileGrooveLocation) GoProfileStripHeight_Location(GoProfileStripHeight measurement);
1103
1104 /**
1105 * Sets the location.
1106 *
1107 * @public @memberof GoProfileStripHeight
1108 * @version Introduced in firmware 4.0.10.27
1109 * @param measurement GoProfileStripHeight object.
1110 * @param location The location value to set.
1111 * @return Operation status.
1112 */
1113 GoFx(kStatus) GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location);
1114
1115 /**
1116 * Gets the select type.
1117 *
1118 * @public @memberof GoProfileStripHeight
1119 * @version Introduced in firmware 4.0.10.27
1120 * @param measurement GoProfileStripHeight object.
1121 * @return The select type.
1122 */
1123 GoFx(GoProfileGrooveSelectType) GoProfileStripHeight_SelectType(GoProfileStripHeight measurement);
1124
1125 /**
1126 * Sets the select type.
1127 *
1128 * @public @memberof GoProfileStripHeight
1129 * @version Introduced in firmware 4.0.10.27
1130 * @param measurement GoProfileStripHeight object.
1131 * @param selectType The select type value to set.
1132 * @return Operation status.
1133 */
1134 GoFx(kStatus) GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType);
1135
1136 /**
1137 * Gets the select index.
1138 *
1139 * @public @memberof GoProfileStripHeight
1140 * @version Introduced in firmware 4.0.10.27
1141 * @param measurement GoProfileStripHeight object.
1142 * @return The select index.
1143 */
1144 GoFx(k32u) GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement);
1145
1146 /**
1147 * Sets the select index.
1148 *
1149 * @public @memberof GoProfileStripHeight
1150 * @version Introduced in firmware 4.0.10.27
1151 * @param measurement GoProfileStripHeight object.
1152 * @param selectIndex The select index value to set.
1153 * @return Operation status.
1154 */
1155 GoFx(kStatus) GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex);
1156
1157 /**
1158 * @class GoProfileXLineZ
1159 * @extends GoMeasurement
1160 * @ingroup GoSdk-ProfileTools
1161 * @brief Represents an Z measurement for a Profile X-Line tool.
1162 */
1163 typedef GoMeasurement GoProfileXLineZ;
1164
1165 /**
1166 * @class GoProfileXLineValidity
1167 * @extends GoMeasurement
1168 * @ingroup GoSdk-ProfileTools
1169 * @brief Represents a validity measurement for a Profile X-Line tool.
1170 */
1171 typedef GoMeasurement GoProfileXLineValidity;
1172
1173
1174 /// @cond (Gocator_2x00 || Gocator_3x00)
1175
1176 /**
1177 * @class GoSurfaceBoxX
1178 * @extends GoMeasurement
1179 * @ingroup GoSdk-SurfaceTools
1180 * @brief Represents an X measurement for a Surface Bounding Box tool.
1181 */
1182 typedef GoMeasurement GoSurfaceBoxX;
1183
1184 /**
1185 * @class GoSurfaceBoxY
1186 * @extends GoMeasurement
1187 * @ingroup GoSdk-SurfaceTools
1188 * @brief Represents a Y measurement for a Surface Bounding Box tool.
1189 */
1190 typedef GoMeasurement GoSurfaceBoxY;
1191
1192 /**
1193 * @class GoSurfaceBoxZ
1194 * @extends GoMeasurement
1195 * @ingroup GoSdk-SurfaceTools
1196 * @brief Represents a Z measurement for a Surface Bounding Box tool.
1197 */
1198 typedef GoMeasurement GoSurfaceBoxZ;
1199
1200
1201 /**
1202 * @class GoSurfaceBoxZAngle
1203 * @extends GoMeasurement
1204 * @ingroup GoSdk-SurfaceTools
1205 * @brief Represents a Z-angle measurement for a Surface Bounding Box tool.
1206 */
1207 typedef GoMeasurement GoSurfaceBoxZAngle;
1208
1209 /**
1210 * @class GoSurfaceBoxGlobalX
1211 * @extends GoMeasurement
1212 * @ingroup GoSdk-SurfaceTools
1213 * @brief Represents a global X measurement for a Surface Bounding Box tool.
1214 */
1215 typedef GoMeasurement GoSurfaceBoxGlobalX;
1216
1217 /**
1218 * @class GoSurfaceBoxGlobalY
1219 * @extends GoMeasurement
1220 * @ingroup GoSdk-SurfaceTools
1221 * @brief Represents a global Y measurement for a Surface Bounding Box tool.
1222 */
1223 typedef GoMeasurement GoSurfaceBoxGlobalY;
1224
1225 /**
1226 * @class GoSurfaceBoxGlobalZAngle
1227 * @extends GoMeasurement
1228 * @ingroup GoSdk-SurfaceTools
1229 * @brief Represents a global Z angle measurement for a Surface Bounding Box tool.
1230 */
1231 typedef GoMeasurement GoSurfaceBoxGlobalZAngle;
1232
1233 /**
1234 * @class GoSurfaceBoxLength
1235 * @extends GoMeasurement
1236 * @ingroup GoSdk-SurfaceTools
1237 * @brief Represents a length measurement for a Surface Bounding Box tool.
1238 */
1239 typedef GoMeasurement GoSurfaceBoxLength;
1240
1241 /**
1242 * @class GoSurfaceBoxWidth
1243 * @extends GoMeasurement
1244 * @ingroup GoSdk-SurfaceTools
1245 * @brief Represents a width measurement for a Surface Bounding Box tool.
1246 */
1247 typedef GoMeasurement GoSurfaceBoxWidth;
1248
1249 /**
1250 * @class GoSurfaceBoxHeight
1251 * @extends GoMeasurement
1252 * @ingroup GoSdk-SurfaceTools
1253 * @brief Represents a height measurement for a Surface Bounding Box tool.
1254 */
1255 typedef GoMeasurement GoSurfaceBoxHeight;
1256
1257
1258 /**
1259 * @class GoSurfaceDimWidth
1260 * @extends GoMeasurement
1261 * @ingroup GoSdk-SurfaceTools
1262 * @brief Represents a width value measurement for a Surface Dimension Tool.
1263 */
1264 typedef GoMeasurement GoSurfaceDimWidth;
1265
1266 /**
1267 * Returns a boolean value representing whether an absolute measurement value will be returned.
1268 *
1269 * @public @memberof GoSurfaceDimWidth
1270 * @version Introduced in firmware 4.4.4.14
1271 * @param measurement GoSurfaceDimWidth object.
1272 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1273 */
1274 GoFx(kBool) GoSurfaceDimWidth_AbsoluteEnabled(GoSurfaceDimWidth measurement);
1275
1276 /**
1277 * Enables or disables an absolute value result for the given measurement.
1278 *
1279 * @public @memberof GoSurfaceDimWidth
1280 * @version Introduced in firmware 4.4.4.14
1281 * @param measurement GoSurfaceDimWidth object.
1282 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1283 * @return Operation status.
1284 */
1285 GoFx(kStatus) GoSurfaceDimWidth_EnableAbsolute(GoSurfaceDimWidth measurement, kBool absolute);
1286
1287 /**
1288 * @class GoSurfaceDimHeight
1289 * @extends GoMeasurement
1290 * @ingroup GoSdk-SurfaceTools
1291 * @brief Represents a height value measurement for a Surface Dimension Tool.
1292 */
1293 typedef GoMeasurement GoSurfaceDimHeight;
1294
1295 /**
1296 * Returns a boolean value representing whether an absolute measurement value will be returned.
1297 *
1298 * @public @memberof GoSurfaceDimHeight
1299 * @version Introduced in firmware 4.4.4.14
1300 * @param measurement GoSurfaceDimHeight object.
1301 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1302 */
1303 GoFx(kBool) GoSurfaceDimHeight_AbsoluteEnabled(GoSurfaceDimHeight measurement);
1304
1305 /**
1306 * Enables or disables an absolute value result for the given measurement.
1307 *
1308 * @public @memberof GoSurfaceDimHeight
1309 * @version Introduced in firmware 4.4.4.14
1310 * @param measurement GoSurfaceDimHeight object.
1311 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1312 * @return Operation status.
1313 */
1314 GoFx(kStatus) GoSurfaceDimHeight_EnableAbsolute(GoSurfaceDimHeight measurement, kBool absolute);
1315
1316 /**
1317 * @class GoSurfaceDimLength
1318 * @extends GoMeasurement
1319 * @ingroup GoSdk-SurfaceTools
1320 * @brief Represents a Length value measurement for a Surface Dimension Tool.
1321 */
1322 typedef GoMeasurement GoSurfaceDimLength;
1323
1324 /**
1325 * Returns a boolean value representing whether an absolute measurement value will be returned.
1326 *
1327 * @public @memberof GoSurfaceDimLength
1328 * @version Introduced in firmware 4.4.4.14
1329 * @param measurement GoSurfaceDimLength object.
1330 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1331 */
1332 GoFx(kBool) GoSurfaceDimLength_AbsoluteEnabled(GoSurfaceDimLength measurement);
1333
1334 /**
1335 * Enables or disables an absolute value result for the given measurement.
1336 *
1337 * @public @memberof GoSurfaceDimLength
1338 * @version Introduced in firmware 4.4.4.14
1339 * @param measurement GoSurfaceDimLength object.
1340 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1341 * @return Operation status.
1342 */
1343 GoFx(kStatus) GoSurfaceDimLength_EnableAbsolute(GoSurfaceDimLength measurement, kBool absolute);
1344
1345 /**
1346 * @class GoSurfaceDimDistance
1347 * @extends GoMeasurement
1348 * @ingroup GoSdk-SurfaceTools
1349 * @brief Represents a distance value measurement for a Surface Dimension Tool.
1350 */
1351 typedef GoMeasurement GoSurfaceDimDistance;
1352
1353 /**
1354 * @class GoSurfaceDimPlaneDistance
1355 * @extends GoMeasurement
1356 * @ingroup GoSdk-SurfaceTools
1357 * @brief Represents a distance value measurement for a Surface Dimension Tool.
1358 */
1359 typedef GoMeasurement GoSurfaceDimPlaneDistance;
1360
1361 /**
1362 * @class GoSurfaceDimCenterX
1363 * @extends GoMeasurement
1364 * @ingroup GoSdk-SurfaceTools
1365 * @brief Represents a center X value measurement for a Surface Dimension Tool.
1366 */
1367 typedef GoMeasurement GoSurfaceDimCenterX;
1368
1369 /**
1370 * @class GoSurfaceDimCenterY
1371 * @extends GoMeasurement
1372 * @ingroup GoSdk-SurfaceTools
1373 * @brief Represents a center Y value measurement for a Surface Dimension Tool.
1374 */
1375 typedef GoMeasurement GoSurfaceDimCenterY;
1376
1377
1378 /**
1379 * @class GoSurfaceDimCenterZ
1380 * @extends GoMeasurement
1381 * @ingroup GoSdk-SurfaceTools
1382 * @brief Represents a center Z value measurement for a Surface Dimension Tool.
1383 */
1384 typedef GoMeasurement GoSurfaceDimCenterZ;
1385
1386 /**
1387 * @class GoSurfaceEllipseMajor
1388 * @extends GoMeasurement
1389 * @ingroup GoSdk-SurfaceTools
1390 * @brief Represents a major value measurement for a Surface Ellipse tool.
1391 */
1392 typedef GoMeasurement GoSurfaceEllipseMajor;
1393
1394 /**
1395 * @class GoSurfaceEllipseMinor
1396 * @extends GoMeasurement
1397 * @ingroup GoSdk-SurfaceTools
1398 * @brief Represents a minor value measurement for a Surface Ellipse tool.
1399 */
1400 typedef GoMeasurement GoSurfaceEllipseMinor;
1401
1402 /**
1403 * @class GoSurfaceEllipseRatio
1404 * @extends GoMeasurement
1405 * @ingroup GoSdk-SurfaceTools
1406 * @brief Represents a ratio measurement for a Surface Ellipse tool.
1407 */
1408 typedef GoMeasurement GoSurfaceEllipseRatio;
1409
1410 /**
1411 * @class GoSurfaceEllipseZAngle
1412 * @extends GoMeasurement
1413 * @ingroup GoSdk-SurfaceTools
1414 * @brief Represents a Z-angle measurement for a Surface Ellipse tool.
1415 */
1416 typedef GoMeasurement GoSurfaceEllipseZAngle;
1417
1418 /**
1419 * @class GoSurfaceHoleX
1420 * @extends GoMeasurement
1421 * @ingroup GoSdk-SurfaceTools
1422 * @brief Represents an X measurement for a Surface Hole Tool.
1423 */
1424 typedef GoMeasurement GoSurfaceHoleX;
1425
1426 /**
1427 * @class GoSurfaceHoleY
1428 * @extends GoMeasurement
1429 * @ingroup GoSdk-SurfaceTools
1430 * @brief Represents a Y measurement for a Surface Hole Tool.
1431 */
1432 typedef GoMeasurement GoSurfaceHoleY;
1433
1434 /**
1435 * @class GoSurfaceHoleZ
1436 * @extends GoMeasurement
1437 * @ingroup GoSdk-SurfaceTools
1438 * @brief Represents a Z measurement for a Surface Hole Tool.
1439 */
1440 typedef GoMeasurement GoSurfaceHoleZ;
1441
1442 /**
1443 * @class GoSurfaceHoleRadius
1444 * @extends GoMeasurement
1445 * @ingroup GoSdk-SurfaceTools
1446 * @brief Represents a radius measurement for a Surface Hole Tool.
1447 */
1448 typedef GoMeasurement GoSurfaceHoleRadius;
1449
1450
1451 /**
1452 * @class GoSurfaceOpeningX
1453 * @extends GoMeasurement
1454 * @ingroup GoSdk-SurfaceTools
1455 * @brief Represents an X measurement for a Surface Opening Tool.
1456 */
1457 typedef GoMeasurement GoSurfaceOpeningX;
1458
1459 /**
1460 * @class GoSurfaceOpeningY
1461 * @extends GoMeasurement
1462 * @ingroup GoSdk-SurfaceTools
1463 * @brief Represents a Y measurement for a Surface Opening Tool.
1464 */
1465 typedef GoMeasurement GoSurfaceOpeningY;
1466
1467 /**
1468 * @class GoSurfaceOpeningZ
1469 * @extends GoMeasurement
1470 * @ingroup GoSdk-SurfaceTools
1471 * @brief Represents a Z measurement for a Surface Opening Tool.
1472 */
1473 typedef GoMeasurement GoSurfaceOpeningZ;
1474
1475 /**
1476 * @class GoSurfaceOpeningWidth
1477 * @extends GoMeasurement
1478 * @ingroup GoSdk-SurfaceTools
1479 * @brief Represents a width measurement for a Surface Opening Tool.
1480 */
1481 typedef GoMeasurement GoSurfaceOpeningWidth;
1482
1483 /**
1484 * @class GoSurfaceOpeningLength
1485 * @extends GoMeasurement
1486 * @ingroup GoSdk-SurfaceTools
1487 * @brief Represents a length measurement for a Surface Opening Tool.
1488 */
1489 typedef GoMeasurement GoSurfaceOpeningLength;
1490
1491 /**
1492 * @class GoSurfaceOpeningAngle
1493 * @extends GoMeasurement
1494 * @ingroup GoSdk-SurfaceTools
1495 * @brief Represents an angle measurement for a Surface Opening Tool.
1496 */
1497 typedef GoMeasurement GoSurfaceOpeningAngle;
1498
1499
1500 /**
1501 * @class GoSurfacePlaneXAngle
1502 * @extends GoMeasurement
1503 * @ingroup GoSdk-SurfaceTools
1504 * @brief Represents an X-angle measurement for a Surface Plane Tool.
1505 */
1506 typedef GoMeasurement GoSurfacePlaneXAngle;
1507
1508 /**
1509 * @class GoSurfacePlaneYAngle
1510 * @extends GoMeasurement
1511 * @ingroup GoSdk-SurfaceTools
1512 * @brief Represents a Y-angle measurement for a Surface Plane Tool.
1513 */
1514 typedef GoMeasurement GoSurfacePlaneYAngle;
1515
1516 /**
1517 * @class GoSurfacePlaneZOffset
1518 * @extends GoMeasurement
1519 * @ingroup GoSdk-SurfaceTools
1520 * @brief Represents a Z-offset measurement for a Surface Plane Tool.
1521 */
1522 typedef GoMeasurement GoSurfacePlaneZOffset;
1523
1524 /**
1525 * @class GoSurfacePlaneStdDev
1526 * @extends GoMeasurement
1527 * @ingroup GoSdk-SurfaceTools
1528 * @brief Represents a Standard Deviation measurement for a Surface Plane Tool.
1529 */
1530 typedef GoMeasurement GoSurfacePlaneStdDev;
1531
1532 /**
1533 * @class GoSurfacePlaneMinError
1534 * @extends GoMeasurement
1535 * @ingroup GoSdk-SurfaceTools
1536 * @brief Represents a Minimum Error measurement for a Surface Plane Tool.
1537 */
1538 typedef GoMeasurement GoSurfacePlaneMinError;
1539
1540 /**
1541 * @class GoSurfacePlaneMaxError
1542 * @extends GoMeasurement
1543 * @ingroup GoSdk-SurfaceTools
1544 * @brief Represents a Maximum Error measurement for a Surface Plane Tool.
1545 */
1546 typedef GoMeasurement GoSurfacePlaneMaxError;
1547
1548 /**
1549 * @class GoSurfacePlaneXNormal
1550 * @extends GoMeasurement
1551 * @ingroup GoSdk-SurfaceTools
1552 * @brief Represents the X component of the normal measurement for a Surface Plane Tool.
1553 */
1554 typedef GoMeasurement GoSurfacePlaneXNormal;
1555
1556 /**
1557 * @class GoSurfacePlaneYNormal
1558 * @extends GoMeasurement
1559 * @ingroup GoSdk-SurfaceTools
1560 * @brief Represents the Y component of the normal measurement for a Surface Plane Tool.
1561 */
1562 typedef GoMeasurement GoSurfacePlaneYNormal;
1563
1564 /**
1565 * @class GoSurfacePlaneZNormal
1566 * @extends GoMeasurement
1567 * @ingroup GoSdk-SurfaceTools
1568 * @brief Represents the Z component of the normal measurement for a Surface Plane Tool.
1569 */
1570 typedef GoMeasurement GoSurfacePlaneZNormal;
1571
1572 /**
1573 * @class GoSurfacePlaneDistance
1574 * @extends GoMeasurement
1575 * @ingroup GoSdk-SurfaceTools
1576 * @brief Represents the distance measurement for a Surface Plane Tool.
1577 */
1578 typedef GoMeasurement GoSurfacePlaneDistance;
1579
1580 /**
1581 * @class GoSurfaceEdgeX
1582 * @extends GoMeasurement
1583 * @ingroup GoSdk-SurfaceTools
1584 * @brief Represents an X measurement for a Surface Edge Tool.
1585 */
1586 typedef GoMeasurement GoSurfaceEdgeX;
1587
1588 /**
1589 * @class GoSurfaceEdgeY
1590 * @extends GoMeasurement
1591 * @ingroup GoSdk-SurfaceTools
1592 * @brief Represents a Y measurement for a Surface Edge Tool.
1593 */
1594 typedef GoMeasurement GoSurfaceEdgeY;
1595
1596 /**
1597 * @class GoSurfaceEdgeZ
1598 * @extends GoMeasurement
1599 * @ingroup GoSdk-SurfaceTools
1600 * @brief Represents a Z measurement for a Surface Edge Tool.
1601 */
1602 typedef GoMeasurement GoSurfaceEdgeZ;
1603
1604 /**
1605 * @class GoSurfacePositionX
1606 * @extends GoMeasurement
1607 * @ingroup GoSdk-SurfaceTools
1608 * @brief Represents an X measurement for a Surface Position Tool.
1609 */
1610 typedef GoMeasurement GoSurfacePositionX;
1611
1612 /**
1613 * @class GoSurfacePositionY
1614 * @extends GoMeasurement
1615 * @ingroup GoSdk-SurfaceTools
1616 * @brief Represents a Y measurement for a Surface Position Tool.
1617 */
1618 typedef GoMeasurement GoSurfacePositionY;
1619
1620 /**
1621 * @class GoSurfacePositionZ
1622 * @extends GoMeasurement
1623 * @ingroup GoSdk-SurfaceTools
1624 * @brief Represents a Z measurement for a Surface Position Tool.
1625 */
1626 typedef GoMeasurement GoSurfacePositionZ;
1627
1628 /**
1629 * @class GoSurfaceStudBaseX
1630 * @extends GoMeasurement
1631 * @ingroup GoSdk-SurfaceTools
1632 * @brief Represents a base X measurement for a Surface Stud Tool.
1633 */
1634 typedef GoMeasurement GoSurfaceStudBaseX;
1635
1636 /**
1637 * @class GoSurfaceStudBaseY
1638 * @extends GoMeasurement
1639 * @ingroup GoSdk-SurfaceTools
1640 * @brief Represents a base Y measurement for a Surface Stud Tool.
1641 */
1642 typedef GoMeasurement GoSurfaceStudBaseY;
1643
1644 /**
1645 * @class GoSurfaceStudBaseZ
1646 * @extends GoMeasurement
1647 * @ingroup GoSdk-SurfaceTools
1648 * @brief Represents a base Z measurement for a Surface Stud Tool.
1649 */
1650 typedef GoMeasurement GoSurfaceStudBaseZ;
1651
1652 /**
1653 * @class GoSurfaceStudTipX
1654 * @extends GoMeasurement
1655 * @ingroup GoSdk-SurfaceTools
1656 * @brief Represents a tip X measurement for a Surface Stud Tool.
1657 */
1658 typedef GoMeasurement GoSurfaceStudTipX;
1659
1660 /**
1661 * @class GoSurfaceStudTipY
1662 * @extends GoMeasurement
1663 * @ingroup GoSdk-SurfaceTools
1664 * @brief Represents a tip Y measurement for a Surface Stud Tool.
1665 */
1666 typedef GoMeasurement GoSurfaceStudTipY;
1667
1668 /**
1669 * @class GoSurfaceStudTipZ
1670 * @extends GoMeasurement
1671 * @ingroup GoSdk-SurfaceTools
1672 * @brief Represents a tip Z measurement for a Surface Stud Tool.
1673 */
1674 typedef GoMeasurement GoSurfaceStudTipZ;
1675
1676 /**
1677 * @class GoSurfaceStudRadius
1678 * @extends GoMeasurement
1679 * @ingroup GoSdk-SurfaceTools
1680 * @brief Represents a radius measurement for a Surface Stud Tool.
1681 */
1682 typedef GoMeasurement GoSurfaceStudRadius;
1683
1684 /**
1685 * Gets the radius offset.
1686 *
1687 * @public @memberof GoSurfaceStudRadius
1688 * @version Introduced in firmware 4.0.10.27
1689 * @param measurement GoSurfaceStudRadius object.
1690 * @return The surface location.
1691 */
1692 GoFx(k64f) GoSurfaceStudRadius_RadiusOffset(GoSurfaceStudRadius measurement);
1693
1694 /**
1695 * Sets the radius offset.
1696 *
1697 * @public @memberof GoSurfaceStudRadius
1698 * @version Introduced in firmware 4.0.10.27
1699 * @param measurement GoSurfaceStudRadius object.
1700 * @param value The offset value to set.
1701 * @return Operation status.
1702 */
1703 GoFx(kStatus) GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value);
1704
1705 /**
1706 * @class GoSurfaceVolumeVolume
1707 * @extends GoMeasurement
1708 * @ingroup GoSdk-SurfaceTools
1709 * @brief Represents a volume measurement for a Surface Volume Tool.
1710 */
1711 typedef GoMeasurement GoSurfaceVolumeVolume;
1712
1713 /**
1714 * @class GoSurfaceVolumeArea
1715 * @extends GoMeasurement
1716 * @ingroup GoSdk-SurfaceTools
1717 * @brief Represents an area measurement for a Surface Volume Tool.
1718 */
1719 typedef GoMeasurement GoSurfaceVolumeArea;
1720
1721 /**
1722 * @class GoSurfaceVolumeThickness
1723 * @extends GoMeasurement
1724 * @ingroup GoSdk-SurfaceTools
1725 * @brief Represents a thickness measurement for a Surface Volume Tool.
1726 */
1727 typedef GoMeasurement GoSurfaceVolumeThickness;
1728
1729 /**
1730 * Gets the location.
1731 *
1732 * @public @memberof GoSurfaceVolumeThickness
1733 * @version Introduced in firmware 4.0.10.27
1734 * @param measurement GoSurfaceVolumeThickness object.
1735 * @return The surface location.
1736 */
1737 GoFx(GoSurfaceLocation) GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement);
1738
1739 /**
1740 * Sets the location.
1741 *
1742 * @public @memberof GoSurfaceVolumeThickness
1743 * @version Introduced in firmware 4.0.10.27
1744 * @param measurement GoSurfaceVolumeThickness object.
1745 * @param location The surface location.
1746 * @return Operation status.
1747 */
1748 GoFx(kStatus) GoSurfaceVolumeThickness_SetLocation(GoSurfaceVolumeThickness measurement, GoSurfaceLocation location);
1749
1750 /**
1751 * @class GoSurfaceCountersunkHoleX
1752 * @extends GoMeasurement
1753 * @ingroup GoSdk-SurfaceTools
1754 * @brief Represents an X position measurement for a Surface Counter Sunk Hole Tool.
1755 */
1756 typedef GoMeasurement GoSurfaceCountersunkHoleX;
1757
1758 /**
1759 * @class GoSurfaceCountersunkHoleY
1760 * @extends GoMeasurement
1761 * @ingroup GoSdk-SurfaceTools
1762 * @brief Represents a Y position measurement for a Surface Counter Sunk Hole Tool.
1763 */
1764 typedef GoMeasurement GoSurfaceCountersunkHoleY;
1765
1766 /**
1767 * @class GoSurfaceCountersunkHoleZ
1768 * @extends GoMeasurement
1769 * @ingroup GoSdk-SurfaceTools
1770 * @brief Represents a Z position measurement for a Surface Counter Sunk Hole Tool.
1771 */
1772 typedef GoMeasurement GoSurfaceCountersunkHoleZ;
1773
1774 /**
1775 * @class GoSurfaceCountersunkHoleOuterRadius
1776 * @extends GoMeasurement
1777 * @ingroup GoSdk-SurfaceTools
1778 * @brief Represents an Outer Radius position measurement for a Surface Counter Sunk Hole Tool.
1779 */
1780 typedef GoMeasurement GoSurfaceCountersunkHoleOuterRadius;
1781
1782 /**
1783 * @class GoSurfaceCountersunkHoleDepth
1784 * @extends GoMeasurement
1785 * @ingroup GoSdk-SurfaceTools
1786 * @brief Represents a Depth position measurement for a Surface Counter Sunk Hole Tool.
1787 */
1788 typedef GoMeasurement GoSurfaceCountersunkHoleDepth;
1789
1790 /**
1791 * @class GoSurfaceCountersunkHoleBevelRadius
1792 * @extends GoMeasurement
1793 * @ingroup GoSdk-SurfaceTools
1794 * @brief Represents an Bevel Radius position measurement for a Surface Counter Sunk Hole Tool.
1795 */
1796 typedef GoMeasurement GoSurfaceCountersunkHoleBevelRadius;
1797
1798 /**
1799 * @class GoSurfaceCountersunkHoleBevelAngle
1800 * @extends GoMeasurement
1801 * @ingroup GoSdk-SurfaceTools
1802 * @brief Represents a Bevel Angle measurement for a Surface Counter Sunk Hole Tool.
1803 */
1804 typedef GoMeasurement GoSurfaceCountersunkHoleBevelAngle;
1805
1806 /**
1807 * @class GoSurfaceCountersunkHoleXAngle
1808 * @extends GoMeasurement
1809 * @ingroup GoSdk-SurfaceTools
1810 * @brief Represents an X Angle position measurement for a Surface Counter Sunk Hole Tool.
1811 */
1812 typedef GoMeasurement GoSurfaceCountersunkHoleXAngle;
1813
1814 /**
1815 * @class GoSurfaceCountersunkHoleYAngle
1816 * @extends GoMeasurement
1817 * @ingroup GoSdk-SurfaceTools
1818 * @brief Represents a Y Angle position measurement for a Surface Counter Sunk Hole Tool.
1819 */
1820 typedef GoMeasurement GoSurfaceCountersunkHoleYAngle;
1821
1822 /**
1823 * @class GoSurfaceCountersunkHoleCounterboreDepth
1824 * @extends GoMeasurement
1825 * @ingroup GoSdk-SurfaceTools
1826 * @brief Represents a counterbore depth measurement for a Surface Counter Sunk Hole Tool.
1827 */
1828 typedef GoMeasurement GoSurfaceCountersunkHoleCounterboreDepth;
1829
1830 /**
1831 * @class GoSurfaceCountersunkHoleAxisTilt
1832 * @extends GoMeasurement
1833 * @ingroup GoSdk-SurfaceTools
1834 * @brief Represents a axis tilt measurement for a Surface Counter Sunk Hole Tool.
1835 */
1836 typedef GoMeasurement GoSurfaceCountersunkHoleAxisTilt;
1837
1838 /**
1839 * @class GoSurfaceCountersunkHoleAxisOrientation
1840 * @extends GoMeasurement
1841 * @ingroup GoSdk-SurfaceTools
1842 * @brief Represents a axis orientation measurement for a Surface Counter Sunk Hole Tool.
1843 */
1844 typedef GoMeasurement GoSurfaceCountersunkHoleAxisOrientation;
1845
1846 /// @endcond
1847
1848
1849 /**
1850 * @class GoScriptOutput
1851 * @extends GoMeasurement
1852 * @ingroup GoSdk-Tools
1853 * @brief Represents a script output for a Script Tool.
1854 */
1855 typedef GoMeasurement GoScriptOutput;
1856
1857 kEndHeader()
1858 #include <GoSdk/Tools/GoMeasurements.x.h>
1859
1860 #endif
GoProfileCircleMaxError
Represents a max error measurement for a Profile Circle Tool.
GoProfileGrooveZ::GoProfileGrooveZ_SetSelectIndex
kStatus GoProfileGrooveZ_SetSelectIndex(GoProfileGrooveZ measurement, k32u selectN)
Sets the selected groove index.
GoProfilePanelGap::GoProfilePanelGap_SetAxis
kStatus GoProfilePanelGap_SetAxis(GoProfilePanelGap measurement, GoProfileGapAxis axis)
Sets the gap axis.
GoProfileStripHeight::GoProfileStripHeight_SetSelectType
kStatus GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
k32u
GoProfileStripX::GoProfileStripX_SetSelectType
kStatus GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
GoProfileCircleX
Represents an X value measurement for a Profile Circle Tool.
GoProfileDimWidth::GoProfileDimWidth_EnableAbsolute
kStatus GoProfileDimWidth_EnableAbsolute(GoProfileDimWidth measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
GoMeasurement
Represents the base class for a tool measurement or script output.
GoProfileGrooveX::GoProfileGrooveX_SelectIndex
k32u GoProfileGrooveX_SelectIndex(GoProfileGrooveX measurement)
Gets the current selected groove index.
GoProfileStripZ::GoProfileStripZ_Location
GoProfileGrooveLocation GoProfileStripZ_Location(GoProfileStripZ measurement)
Gets the groove location configuration value.
GoProfileBoxZ
Represents a Z measurement for a Profile Bounding Box tool.
GoProfileGrooveZ::GoProfileGrooveZ_Location
GoProfileGrooveLocation GoProfileGrooveZ_Location(GoProfileGrooveZ measurement)
Gets the current groove location type.
GoProfilePanelRightFlushX
Represents a Right Flush X measurement for a Profile Panel tool.
GoProfileStripX::GoProfileStripX_SelectIndex
k32u GoProfileStripX_SelectIndex(GoProfileStripX measurement)
Gets the select index.
GoProfileGrooveWidth::GoProfileGrooveWidth_SelectType
GoProfileGrooveSelectType GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement)
Gets the current groove selection type.
GoMeasurement.h
Declares the GoMeasurement class.
GoProfilePanelGap
Represents a gap measurement for a Profile Panel Tool.
GoProfileStripHeight
Represents an height measurement for a Profile Strip Tool.
GoProfilePanelLeftSurfaceAngle
Represents a Left Surface Angle measurement for a Profile Panel tool.
GoProfileDimCenterX
Represents a center X value measurement for a Profile Dimension Tool.
GoProfilePanelFlush
Represents a flush measurement for a Profile Panel Tool.
GoProfileStripWidth::GoProfileStripWidth_SetSelectIndex
kStatus GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex)
Sets the select index.
GoProfileGrooveWidth
Represents a width measurement for a Profile Groove Tool.
GoProfileStripHeight::GoProfileStripHeight_SetSelectIndex
kStatus GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex)
Sets the select index.
GoProfileLineMaxErrorZ
Represents a Maximum Z Error measurement for a Profile Line Tool.
GoProfileBridgeValueStdDev
Represents an standard deviation measurement for a Profile Bridge Value tool.
GoProfileStripHeight::GoProfileStripHeight_SetLocation
kStatus GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location)
Sets the location.
GoProfileGrooveX::GoProfileGrooveX_SetSelectIndex
kStatus GoProfileGrooveX_SetSelectIndex(GoProfileGrooveX measurement, k32u selectN)
Sets the selected groove index.
GoProfileStripZ
Represents a Z measurement for a Profile Strip Tool.
GoProfileCircleMinErrorX
Represents a min error X measurement for a Profile Circle Tool.
GoProfileDimWidth::GoProfileDimWidth_AbsoluteEnabled
kBool GoProfileDimWidth_AbsoluteEnabled(GoProfileDimWidth measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
GoProfileRoundCornerZ
Represents an Z measurement for a Profile Round Corner tool.
GoProfileLineMinErrorZ
Represents a Minimum Z Error measurement for a Profile Line Tool.
GoProfileDimWidth
Represents a width value measurement for a Profile Dimension Tool.
GoProfileStripWidth::GoProfileStripWidth_SetSelectType
kStatus GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
GoProfileBridgeValueAngle
Represents an angle measurement for a Profile Bridge Value tool.
GoProfilePanelFlush::GoProfilePanelFlush_EnableAbsolute
kStatus GoProfilePanelFlush_EnableAbsolute(GoProfilePanelFlush measurement, kBool absolute)
Enables or disables the absolute value state.
GoProfileGrooveDepth::GoProfileGrooveDepth_SelectIndex
k32u GoProfileGrooveDepth_SelectIndex(GoProfileGrooveDepth measurement)
Gets the current selected groove index.
GoRangePositionZ
Represents a position Z measurement of a Range Position tool.
GoProfileStripWidth
Represents a width measurement for a Profile Strip Tool.
GoProfileGrooveX
Represents an X value measurement for a Profile Groove Tool.
GoProfileGrooveDepth::GoProfileGrooveDepth_SelectType
GoProfileGrooveSelectType GoProfileGrooveDepth_SelectType(GoProfileGrooveDepth measurement)
Gets the current groove selection type.
GoProfileIntersectX
Represents an intersect X measurement for a Profile Intersect Tool.
GoProfileGrooveX::GoProfileGrooveX_Location
GoProfileGrooveLocation GoProfileGrooveX_Location(GoProfileGrooveX measurement)
Gets the current groove location.
GoProfileCircleMaxErrorX
Represents a max error X measurement for a Profile Circle Tool.
GoProfileLineMaxError
Represents a maximum error measurement for a Profile Line Tool.
GoProfileGrooveZ::GoProfileGrooveZ_SetLocation
kStatus GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location)
Sets the groove location type.
GoScriptOutput
Represents a script output for a Script Tool.
GoProfileAreaCentroidZ
Represents a centroid Z measurement for a Profile Area Tool.
GoProfilePanelLeftGapX
Represents a Left Gap X measurement for a Profile Panel tool.
GoProfileGrooveX::GoProfileGrooveX_SetLocation
kStatus GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value)
Sets the groove location.
GoProfileStripZ::GoProfileStripZ_SetLocation
kStatus GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location)
Sets the groove location configuration value.
GoProfilePanelRightGapZ
Represents a Right Gap Z measurement for a Profile Panel tool.
GoProfileStripX::GoProfileStripX_SelectType
GoProfileGrooveSelectType GoProfileStripX_SelectType(GoProfileStripX measurement)
Gets the select type.
GoProfilePanelLeftFlushX
Represents a Left Flush X measurement for a Profile Panel tool.
GoProfileAreaArea
Represents an area measurement for a Profile Area tool.
GoProfileCircleStdDev
Represents a standard deviation measurement for a Profile Circle Tool.
GoProfileBoxHeight
Represents a height measurement for a Profile Bounding Box tool.
GoProfileBoxGlobalAngle
Represents a global angle measurement for a Profile Bounding Box tool.
GoProfileLineMinError
Represents a minimum error measurement for a Profile Line Tool.
GoProfileGrooveZ::GoProfileGrooveZ_SelectIndex
k32u GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement)
Gets the current selected groove index.
GoProfileGrooveSelectType
Determines which groove to select when multiple are present.
GoProfilePositionZ
Represents an Z measurement for a Profile Position tool.
GoSdkDef.h
Essential SDK declarations.
GoProfileGrooveZ::GoProfileGrooveZ_SetSelectType
kStatus GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileStripHeight::GoProfileStripHeight_Location
GoProfileGrooveLocation GoProfileStripHeight_Location(GoProfileStripHeight measurement)
Gets the groove location setting.
GoProfileLinePercentile
Represents a percentile measurement for a Profile Line Tool.
GoProfilePanelFlush::GoProfilePanelFlush_AbsoluteEnabled
kBool GoProfilePanelFlush_AbsoluteEnabled(GoProfilePanelFlush measurement)
Gets absolute value state.
GoProfileGrooveWidth::GoProfileGrooveWidth_SetSelectType
kStatus GoProfileGrooveWidth_SetSelectType(GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileGrooveWidth::GoProfileGrooveWidth_SetSelectIndex
kStatus GoProfileGrooveWidth_SetSelectIndex(GoProfileGrooveWidth measurement, k32u selectN)
Sets the selected groove index.
GoProfileStripX::GoProfileStripX_SetSelectIndex
kStatus GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex)
Sets the select index.
GoProfileStripZ::GoProfileStripZ_SetSelectIndex
kStatus GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex)
Sets the select index.
GoProfileStripZ::GoProfileStripZ_SelectIndex
k32u GoProfileStripZ_SelectIndex(GoProfileStripZ measurement)
Gets the select index.
GoProfileBoxX
Represents an X measurement for a Profile Bounding Box tool.
GoProfileGrooveDepth::GoProfileGrooveDepth_SetSelectIndex
kStatus GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN)
Sets the selected groove index.
GoProfileDimHeight
Represents a height value measurement for a Profile Dimension Tool.
GoProfileLinePercentile::GoProfileLinePercentile_SetPercent
kStatus GoProfileLinePercentile_SetPercent(GoProfileLinePercentile measurement, k64f percent)
Sets the percent threshold.
GoProfileGrooveZ::GoProfileGrooveZ_SelectType
GoProfileGrooveSelectType GoProfileGrooveZ_SelectType(GoProfileGrooveZ measurement)
Gets the current groove selection type.
GoProfileCircleZ
Represents a Z value measurement for a Profile Circle Tool.
GoProfileStripZ::GoProfileStripZ_SelectType
GoProfileGrooveSelectType GoProfileStripZ_SelectType(GoProfileStripZ measurement)
Gets the select type.
GoProfileBoxGlobalY
Represents a global Y measurement for a Profile Bounding Box tool.
GoProfilePanelGap::GoProfilePanelGap_Axis
GoProfileGapAxis GoProfilePanelGap_Axis(GoProfilePanelGap measurement)
Gets the gap axis.
GoProfileStripHeight::GoProfileStripHeight_SelectIndex
k32u GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement)
Gets the select index.
GoProfileGrooveLocation
Determines which groove position to return.
GoProfileIntersectAngle::GoProfileIntersectAngle_EnableRange0to180
kStatus GoProfileIntersectAngle_EnableRange0to180(GoProfileIntersectAngle measurement, kBool enable)
Enables or disables a result in the range of 0 to 180 instead of -90 to 90 degrees for the given meas...
GoProfileLineAngle
Represents an Angle measurement for a Profile Line Tool.
GoProfileStripX
Represents an X measurement for a Profile Strip Tool.
GoExtMeasurement.h
Declares the GoExtMeasurement class.
GoProfilePanelRightFlushZ
Represents a Right Flush Z measurement for a Profile Panel tool.
GoProfileGrooveX::GoProfileGrooveX_SelectType
GoProfileGrooveSelectType GoProfileGrooveX_SelectType(GoProfileGrooveX measurement)
Gets the current groove selection type.
GoProfileRoundCornerX
Represents an X measurement for a Profile Round Corner tool.
GoProfileLinePercentile::GoProfileLinePercentile_Percent
k64f GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement)
Gets the percent threshold.
GoProfileGapAxis
Represents a profile gap measurement axis.
GoRangeThicknessThickness
Represents a the thickness measurement of a Range Thickness tool.
GoProfileStripZ::GoProfileStripZ_SetSelectType
kStatus GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
GoProfileGrooveX::GoProfileGrooveX_SetSelectType
kStatus GoProfileGrooveX_SetSelectType(GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileLineStdDev
Represents a standard deviation measurement for a Profile Line Tool.
GoProfileDimCenterZ
Represents a center Z value measurement for a Profile Dimension Tool.
GoProfileStripWidth::GoProfileStripWidth_SelectIndex
k32u GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement)
Gets the select index.
GoProfileXLineValidity
Represents a validity measurement for a Profile X-Line tool.
GoProfileGrooveWidth::GoProfileGrooveWidth_SelectIndex
k32u GoProfileGrooveWidth_SelectIndex(GoProfileGrooveWidth measurement)
Gets the current selected groove index.
GoProfileAreaCentroidX
Represents a centroid X measurement for a Profile Area Tool.
GoProfileLineMaxErrorX
Represents a Maximum X Error measurement for a Profile Line Tool.
GoProfilePanelLeftGapZ
Represents a Left Gap Z measurement for a Profile Panel tool.
GoProfileGrooveDepth
Represents a depth measurement for a Profile Groove Tool.
GoProfileDimHeight::GoProfileDimHeight_AbsoluteEnabled
kBool GoProfileDimHeight_AbsoluteEnabled(GoProfileDimHeight measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
kStatus
GoProfileIntersectAngle
Represents an intersect angle measurement for a Profile Intersect Tool.
GoProfileCircleMinErrorZ
Represents a min error Z measurement for a Profile Circle Tool.
GoProfileCircleRadius
Represents a radius value measurement for a Profile Circle Tool.
GoProfileLineMinErrorX
Represents an Minimum X Error measurement for a Profile Line Tool.
GoProfileStripX::GoProfileStripX_Location
GoProfileGrooveLocation GoProfileStripX_Location(GoProfileStripX measurement)
Gets the groove location configuration value.
GoProfilePanelRightGapX
Represents a Right Gap X measurement for a Profile Panel tool.
GoProfileXLineZ
Represents an Z measurement for a Profile X-Line tool.
GoProfilePanelLeftFlushZ
Represents a Left Flush Z measurement for a Profile Panel tool.
GoProfileStripHeight::GoProfileStripHeight_SelectType
GoProfileGrooveSelectType GoProfileStripHeight_SelectType(GoProfileStripHeight measurement)
Gets the select type.
GoProfileBoxWidth
Represents a width measurement for a Profile Bounding Box tool.
GoProfileDimHeight::GoProfileDimHeight_EnableAbsolute
kStatus GoProfileDimHeight_EnableAbsolute(GoProfileDimHeight measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
k64f
GoProfileGrooveZ
Represents a Z value measurement for a Profile Groove tool.
GoProfileLineOffset
Represents an offset measurement for a Profile Line Tool.
GoProfileIntersectZ
Represents an intersect Z measurement for a Profile Intersect Tool.
GoProfilePositionX
Represents an X measurement for a Profile Position tool.
GoProfileCircleMaxErrorZ
Represents a max error Z measurement for a Profile Circle Tool.
GoProfileCircleMinError
Represents a min error measurement for a Profile Circle Tool.
GoProfileStripX::GoProfileStripX_SetLocation
kStatus GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location)
Sets the groove location configuration value.
GoProfileBridgeValueWindow
Represents an window measurement for a Profile Bridge Value tool.
kBool
GoProfileBridgeValueBridgeValue
Represents a bridge value measurement for a Profile Bridge Value tool.
GoProfilePanelRightSurfaceAngle
Represents a Right Surface Angle measurement for a Profile Panel tool.
GoProfileBoxGlobalX
Represents a global X measurement for a Profile Bounding Box tool.
GoProfileGrooveDepth::GoProfileGrooveDepth_SetSelectType
kStatus GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileRoundCornerAngle
Represents an Angle measurement for a Profile Round Corner tool.
GoProfileStripWidth::GoProfileStripWidth_SelectType
GoProfileGrooveSelectType GoProfileStripWidth_SelectType(GoProfileStripWidth measurement)
Gets the select type.
GoProfileIntersectAngle::GoProfileIntersectAngle_Range0to180Enabled
kBool GoProfileIntersectAngle_Range0to180Enabled(GoProfileIntersectAngle measurement)
Returns a boolean value representing whether a absolute measurement value in the range of 0 to 180 de...
GoProfileDimDistance
Represents a distance value measurement for a Profile Dimension Tool.