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