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