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) 2015 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/GoExtParam.h>
16
17 kBeginHeader()
18
19 /// @cond Gocator_1x00
20
21 /**
22 * @class GoRangePositionZ
23 * @extends GoMeasurement
24 * @ingroup GoSdk
25 * @brief Represents a position Z measurement of a Range Position tool.
26 */
27 typedef GoMeasurement GoRangePositionZ;
28
29 /**
30 * @class GoRangeThicknessThickness
31 * @extends GoMeasurement
32 * @ingroup GoSdk
33 * @brief Represents a the thickness measurement of a Range Thickness tool.
34 */
35 typedef GoMeasurement GoRangeThicknessThickness;
36
37 /// @endcond
38
39
40 /// @cond (Gocator_1x00 || Gocator_2x00)
41
42 /**
43 * @class GoProfileAreaArea
44 * @extends GoMeasurement
45 * @ingroup GoSdk-ProfileTools
46 * @brief Represents an area measurement for a Profile Area tool.
47 */
48 typedef GoMeasurement GoProfileAreaArea;
49
50 /**
51 * @class GoProfileAreaCentroidX
52 * @extends GoMeasurement
53 * @ingroup GoSdk-ProfileTools
54 * @brief Represents a centroid X measurement for a Profile Area Tool.
55 */
56 typedef GoMeasurement GoProfileAreaCentroidX;
57
58 /**
59 * @class GoProfileAreaCentroidZ
60 * @extends GoMeasurement
61 * @ingroup GoSdk-ProfileTools
62 * @brief Represents a centroid Z measurement for a Profile Area Tool.
63 */
64 typedef GoMeasurement GoProfileAreaCentroidZ;
65
66 /**
67 * @class GoProfileBoxX
68 * @extends GoMeasurement
69 * @ingroup GoSdk-ProfileTools
70 * @brief Represents an X measurement for a Profile Bounding Box tool.
71 */
72 typedef GoMeasurement GoProfileBoxX;
73
74 /**
75 * @class GoProfileBoxZ
76 * @extends GoMeasurement
77 * @ingroup GoSdk-ProfileTools
78 * @brief Represents a Z measurement for a Profile Bounding Box tool.
79 */
80 typedef GoMeasurement GoProfileBoxZ;
81
82 /**
83 * @class GoProfileBoxWidth
84 * @extends GoMeasurement
85 * @ingroup GoSdk-ProfileTools
86 * @brief Represents a width measurement for a Profile Bounding Box tool.
87 */
88 typedef GoMeasurement GoProfileBoxWidth;
89
90 /**
91 * @class GoProfileBoxHeight
92 * @extends GoMeasurement
93 * @ingroup GoSdk-ProfileTools
94 * @brief Represents a height measurement for a Profile Bounding Box tool.
95 */
96 typedef GoMeasurement GoProfileBoxHeight;
97
98 /**
99 * @class GoProfileBoxGlobalX
100 * @extends GoMeasurement
101 * @ingroup GoSdk-ProfileTools
102 * @brief Represents a global X measurement for a Profile Bounding Box tool.
103 */
104 typedef GoMeasurement GoProfileBoxGlobalX;
105
106 /**
107 * @class GoProfileBridgeValueBridgeValue
108 * @extends GoMeasurement
109 * @ingroup GoSdk-ProfileTools
110 * @brief Represents a bridge value measurement for a Profile Bridge Value tool.
111 */
112 typedef GoMeasurement GoProfileBridgeValueBridgeValue;
113
114 /**
115 * @class GoProfileBridgeValueAngle
116 * @extends GoMeasurement
117 * @ingroup GoSdk-ProfileTools
118 * @brief Represents an angle measurement for a Profile Bridge Value tool.
119 */
120 typedef GoMeasurement GoProfileBridgeValueAngle;
121
122
123 /**
124 * @class GoProfileCircleX
125 * @extends GoMeasurement
126 * @ingroup GoSdk-ProfileTools
127 * @brief Represents an X value measurement for a Profile Circle Tool.
128 */
129 typedef GoMeasurement GoProfileCircleX;
130
131 /**
132 * @class GoProfileCircleZ
133 * @extends GoMeasurement
134 * @ingroup GoSdk-ProfileTools
135 * @brief Represents a Z value measurement for a Profile Circle Tool.
136 */
137 typedef GoMeasurement GoProfileCircleZ;
138
139
140 /**
141 * @class GoProfileCircleRadius
142 * @extends GoMeasurement
143 * @ingroup GoSdk-ProfileTools
144 * @brief Represents a radius value measurement for a Profile Circle Tool.
145 */
146 typedef GoMeasurement GoProfileCircleRadius;
147
148
149 /**
150 * @class GoProfileDimWidth
151 * @extends GoMeasurement
152 * @ingroup GoSdk-ProfileTools
153 * @brief Represents a width value measurement for a Profile Dimension Tool.
154 */
155 typedef GoMeasurement GoProfileDimWidth;
156
157 /**
158 * Returns a boolean value representing whether an absolute measurement value will be returned.
159 *
160 * @public @memberof GoProfileDimWidth
161 * @version Introduced in firmware 4.0.10.27
162 * @param measurement GoProfileDimWidth object.
163 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
164 */
165 GoFx(kBool) GoProfileDimWidth_AbsoluteEnabled(GoProfileDimWidth measurement);
166
167 /**
168 * Enables or disables an absolute value result for the given measurement.
169 *
170 * @public @memberof GoProfileDimWidth
171 * @version Introduced in firmware 4.0.10.27
172 * @param measurement GoProfileDimWidth object.
173 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
174 * @return Operation status.
175 */
176 GoFx(kStatus) GoProfileDimWidth_EnableAbsolute(GoProfileDimWidth measurement, kBool absolute);
177
178 /**
179 * @class GoProfileDimHeight
180 * @extends GoMeasurement
181 * @ingroup GoSdk-ProfileTools
182 * @brief Represents a height value measurement for a Profile Dimension Tool.
183 */
184 typedef GoMeasurement GoProfileDimHeight;
185
186 /**
187 * Returns a boolean value representing whether an absolute measurement value will be returned.
188 *
189 * @public @memberof GoProfileDimHeight
190 * @version Introduced in firmware 4.0.10.27
191 * @param measurement GoProfileDimHeight object.
192 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
193 */
194 GoFx(kBool) GoProfileDimHeight_AbsoluteEnabled(GoProfileDimHeight measurement);
195
196 /**
197 * Enables or disables an absolute value result for the given measurement.
198 *
199 * @public @memberof GoProfileDimHeight
200 * @version Introduced in firmware 4.0.10.27
201 * @param measurement GoProfileDimHeight object.
202 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
203 * @return Operation status.
204 */
205 GoFx(kStatus) GoProfileDimHeight_EnableAbsolute(GoProfileDimHeight measurement, kBool absolute);
206
207 /**
208 * @class GoProfileDimDistance
209 * @extends GoMeasurement
210 * @ingroup GoSdk-ProfileTools
211 * @brief Represents a distance value measurement for a Profile Dimension Tool.
212 */
213 typedef GoMeasurement GoProfileDimDistance;
214
215 /**
216 * @class GoProfileDimCenterX
217 * @extends GoMeasurement
218 * @ingroup GoSdk-ProfileTools
219 * @brief Represents a center X value measurement for a Profile Dimension Tool.
220 */
221 typedef GoMeasurement GoProfileDimCenterX;
222
223 /**
224 * @class GoProfileDimCenterZ
225 * @extends GoMeasurement
226 * @ingroup GoSdk-ProfileTools
227 * @brief Represents a center Z value measurement for a Profile Dimension Tool.
228 */
229 typedef GoMeasurement GoProfileDimCenterZ;
230
231 /**
232 * @class GoProfileIntersectX
233 * @extends GoMeasurement
234 * @ingroup GoSdk-ProfileTools
235 * @brief Represents an intersect X measurement for a Profile Intersect Tool.
236 */
237 typedef GoMeasurement GoProfileIntersectX;
238
239 /**
240 * @class GoProfileIntersectZ
241 * @extends GoMeasurement
242 * @ingroup GoSdk-ProfileTools
243 * @brief Represents an intersect Z measurement for a Profile Intersect Tool.
244 */
245 typedef GoMeasurement GoProfileIntersectZ;
246
247 /**
248 * @class GoProfileIntersectAngle
249 * @extends GoMeasurement
250 * @ingroup GoSdk-ProfileTools
251 * @brief Represents an intersect angle measurement for a Profile Intersect Tool.
252 */
253 typedef GoMeasurement GoProfileIntersectAngle;
254
255 /**
256 * Returns a boolean value representing whether an absolute measurement value will be returned.
257 *
258 * @public @memberof GoProfileIntersectAngle
259 * @version Introduced in firmware 4.0.10.27
260 * @param measurement GoProfileIntersectAngle object.
261 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
262 */
263 GoFx(kBool) GoProfileIntersectAngle_AbsoluteEnabled(GoProfileIntersectAngle measurement);
264
265 /**
266 * Enables or disables an absolute value result for the given measurement.
267 *
268 * @public @memberof GoProfileIntersectAngle
269 * @version Introduced in firmware 4.0.10.27
270 * @param measurement GoProfileIntersectAngle object.
271 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
272 * @return Operation status.
273 */
274 GoFx(kStatus) GoProfileIntersectAngle_EnableAbsolute(GoProfileIntersectAngle measurement, kBool absolute);
275
276 /**
277 * @class GoProfileGrooveX
278 * @extends GoMeasurement
279 * @ingroup GoSdk-ProfileTools
280 * @brief Represents an X value measurement for a Profile Groove Tool.
281 */
282 typedef GoMeasurement GoProfileGrooveX;
283
284 /**
285 * Gets the current groove selection type.
286 *
287 * @public @memberof GoProfileGrooveX
288 * @version Introduced in firmware 4.0.10.27
289 * @param measurement GoProfileGrooveX object.
290 * @return The profile groove location.
291 */
292 GoFx(GoProfileGrooveLocation) GoProfileGrooveX_Location(GoProfileGrooveX measurement);
293
294 /**
295 * Sets the groove location.
296 *
297 * @public @memberof GoProfileGrooveX
298 * @version Introduced in firmware 4.0.10.27
299 * @param measurement GoProfileGrooveX object.
300 * @param value The groove location value to be set.
301 * @return Operation status.
302 */
303 GoFx(kStatus) GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value);
304
305
306 /**
307 * Gets the current groove selection type.
308 *
309 * @public @memberof GoProfileGrooveX
310 * @version Introduced in firmware 4.0.10.27
311 * @param measurement GoProfileGrooveX object.
312 * @return The profile groove selection type.
313 */
314 GoFx(GoProfileGrooveSelectType) GoProfileGrooveX_SelectType(GoProfileGrooveX measurement);
315
316 /**
317 * Sets the groove selection type.
318 *
319 * @public @memberof GoProfileGrooveX
320 * @version Introduced in firmware 4.0.10.27
321 * @param measurement GoProfileGrooveX object.
322 * @param selectType The profile groove type.
323 * @return Operation status.
324 */
325 GoFx(kStatus) GoProfileGrooveX_SetSelectType(GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType);
326
327 /**
328 * Gets the current selected groove index.
329 *
330 * @public @memberof GoProfileGrooveX
331 * @version Introduced in firmware 4.0.10.27
332 * @param measurement GoProfileGrooveX object.
333 * @return The current groove index.
334 */
335 GoFx(k32u) GoProfileGrooveX_SelectIndex(GoProfileGrooveX measurement);
336
337 /**
338 * Sets the selected groove index.
339 *
340 * @public @memberof GoProfileGrooveX
341 * @version Introduced in firmware 4.0.10.27
342 * @param measurement GoProfileGrooveX object.
343 * @param selectN The selected groove index.
344 * @return Operation status.
345 */
346 GoFx(kStatus) GoProfileGrooveX_SetSelectIndex(GoProfileGrooveX measurement, k32u selectN);
347
348
349
350 /**
351 * @class GoProfileGrooveZ
352 * @extends GoMeasurement
353 * @ingroup GoSdk-ProfileTools
354 * @brief Represents a Z value measurement for a Profile Groove tool.
355 */
356 typedef GoMeasurement GoProfileGrooveZ;
357
358 /**
359 * Gets the current groove location type.
360 *
361 * @public @memberof GoProfileGrooveZ
362 * @version Introduced in firmware 4.0.10.27
363 * @param measurement GoProfileGrooveZ object.
364 * @return The profile groove location type.
365 */
366 GoFx(GoProfileGrooveLocation) GoProfileGrooveZ_Location(GoProfileGrooveZ measurement);
367
368 /**
369 * Sets the groove location type.
370 *
371 * @public @memberof GoProfileGrooveZ
372 * @version Introduced in firmware 4.0.10.27
373 * @param measurement GoProfileGrooveZ object.
374 * @param location The profile groove location type.
375 * @return Operation status.
376 */
377 GoFx(kStatus) GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location);
378
379 /**
380 * Gets the current groove selection type.
381 *
382 * @public @memberof GoProfileGrooveZ
383 * @version Introduced in firmware 4.0.10.27
384 * @param measurement GoProfileGrooveZ object.
385 * @return The profile groove selection type.
386 */
387 GoFx(GoProfileGrooveSelectType) GoProfileGrooveZ_SelectType(GoProfileGrooveZ measurement);
388
389 /**
390 * Sets the groove selection type.
391 *
392 * @public @memberof GoProfileGrooveZ
393 * @version Introduced in firmware 4.0.10.27
394 * @param measurement GoProfileGrooveZ object.
395 * @param selectType The profile groove selection type.
396 * @return Operation status.
397 */
398 GoFx(kStatus) GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType);
399
400 /**
401 * Gets the current selected groove index.
402 *
403 * @public @memberof GoProfileGrooveZ
404 * @version Introduced in firmware 4.0.10.27
405 * @param measurement GoProfileGrooveZ object.
406 * @return The current groove index.
407 */
408 GoFx(k32u) GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement);
409
410 /**
411 * Sets the selected groove index.
412 *
413 * @public @memberof GoProfileGrooveZ
414 * @version Introduced in firmware 4.0.10.27
415 * @param measurement GoProfileGrooveZ object.
416 * @param selectN The selected groove index.
417 * @return Operation status.
418 */
419 GoFx(kStatus) GoProfileGrooveZ_SetSelectIndex(GoProfileGrooveZ measurement, k32u selectN);
420
421
422 /**
423 * @class GoProfileGrooveWidth
424 * @extends GoMeasurement
425 * @ingroup GoSdk-ProfileTools
426 * @brief Represents a width measurement for a Profile Groove Tool.
427 */
428 typedef GoMeasurement GoProfileGrooveWidth;
429
430 /**
431 * Gets the current groove selection type.
432 *
433 * @public @memberof GoProfileGrooveWidth
434 * @version Introduced in firmware 4.0.10.27
435 * @param measurement GoProfileGrooveWidth object.
436 * @return The profile groove selection type.
437 */
438 GoFx(GoProfileGrooveSelectType) GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement);
439
440 /**
441 * Sets the groove selection type.
442 *
443 * @public @memberof GoProfileGrooveWidth
444 * @version Introduced in firmware 4.0.10.27
445 * @param measurement GoProfileGrooveWidth object.
446 * @param selectType The profile groove type.
447 * @return Operation status.
448 */
449 GoFx(kStatus) GoProfileGrooveWidth_SetSelectType(GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType);
450
451 /**
452 * Gets the current selected groove index.
453 *
454 * @public @memberof GoProfileGrooveWidth
455 * @version Introduced in firmware 4.0.10.27
456 * @param measurement GoProfileGrooveWidth object.
457 * @return The current groove index.
458 */
459 GoFx(k32u) GoProfileGrooveWidth_SelectIndex(GoProfileGrooveWidth measurement);
460
461 /**
462 * Sets the selected groove index.
463 *
464 * @public @memberof GoProfileGrooveWidth
465 * @version Introduced in firmware 4.0.10.27
466 * @param measurement GoProfileGrooveWidth object.
467 * @param selectN The selected groove index.
468 * @return Operation status.
469 */
470 GoFx(kStatus) GoProfileGrooveWidth_SetSelectIndex(GoProfileGrooveWidth measurement, k32u selectN);
471
472
473 /**
474 * @class GoProfileGrooveDepth
475 * @extends GoMeasurement
476 * @ingroup GoSdk-ProfileTools
477 * @brief Represents a depth measurement for a Profile Groove Tool.
478 */
479 typedef GoMeasurement GoProfileGrooveDepth;
480
481 /**
482 * Gets the current groove selection type.
483 *
484 * @public @memberof GoProfileGrooveDepth
485 * @version Introduced in firmware 4.0.10.27
486 * @param measurement GoProfileGrooveDepth object.
487 * @return The profile groove selection type.
488 */
489 GoFx(GoProfileGrooveSelectType) GoProfileGrooveDepth_SelectType(GoProfileGrooveDepth measurement);
490
491 /**
492 * Sets the groove selection type.
493 *
494 * @public @memberof GoProfileGrooveDepth
495 * @version Introduced in firmware 4.0.10.27
496 * @param measurement GoProfileGrooveDepth object.
497 * @param selectType The profile groove type.
498 * @return Operation status.
499 */
500 GoFx(kStatus) GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType);
501
502 /**
503 * Gets the current selected groove index.
504 *
505 * @public @memberof GoProfileGrooveDepth
506 * @version Introduced in firmware 4.0.10.27
507 * @param measurement GoProfileGrooveDepth object.
508 * @return The current groove index.
509 */
510 GoFx(k32u) GoProfileGrooveDepth_SelectIndex(GoProfileGrooveDepth measurement);
511
512 /**
513 * Sets the selected groove index.
514 *
515 * @public @memberof GoProfileGrooveDepth
516 * @version Introduced in firmware 4.0.10.27
517 * @param measurement GoProfileGrooveDepth object.
518 * @param selectN The selected groove index.
519 * @return Operation status.
520 */
521 GoFx(kStatus) GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN);
522
523
524 /**
525 * @class GoProfileLineStdDev
526 * @extends GoMeasurement
527 * @ingroup GoSdk-ProfileTools
528 * @brief Represents a standard deviation measurement for a Profile Line Tool.
529 */
530 typedef GoMeasurement GoProfileLineStdDev;
531
532 /**
533 * @class GoProfileLineMinError
534 * @extends GoMeasurement
535 * @ingroup GoSdk-ProfileTools
536 * @brief Represents a minimum error measurement for a Profile Line Tool.
537 */
538 typedef GoMeasurement GoProfileLineMinError;
539
540 /**
541 * @class GoProfileLineMaxError
542 * @extends GoMeasurement
543 * @ingroup GoSdk-ProfileTools
544 * @brief Represents a maximum error measurement for a Profile Line Tool.
545 */
546 typedef GoMeasurement GoProfileLineMaxError;
547
548 /**
549 * @class GoProfileLinePercentile
550 * @extends GoMeasurement
551 * @ingroup GoSdk-ProfileTools
552 * @brief Represents a percentile measurement for a Profile Line Tool.
553 */
554 typedef GoMeasurement GoProfileLinePercentile;
555
556 /**
557 * Gets the percent threshold.
558 *
559 * @public @memberof GoProfileLinePercentile
560 * @version Introduced in firmware 4.0.10.27
561 * @param measurement GoProfileLinePercentile object.
562 * @return The percent threshold.
563 */
564 GoFx(k64f) GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement);
565
566 /**
567 * Sets the percent threshold.
568 *
569 * @public @memberof GoProfileLinePercentile
570 * @version Introduced in firmware 4.0.10.27
571 * @param measurement GoProfileLinePercentile object.
572 * @param percent The percent threshold to set.
573 * @return Operation status.
574 */
575 GoFx(kStatus) GoProfileLinePercentile_SetPercent(GoProfileLinePercentile measurement, k64f percent);
576
577 /**
578 * @class GoProfilePanelGap
579 * @extends GoMeasurement
580 * @ingroup GoSdk-ProfileTools
581 * @brief Represents a gap measurement for a Profile Panel Tool.
582 */
583 typedef GoMeasurement GoProfilePanelGap;
584
585 /**
586 * Gets the gap axis.
587 *
588 * @public @memberof GoProfilePanelGap
589 * @version Introduced in firmware 4.0.10.27
590 * @param measurement GoProfilePanelGap object.
591 * @return The gap axis.
592 */
593 GoFx(GoProfileGapAxis) GoProfilePanelGap_Axis(GoProfilePanelGap measurement);
594
595 /**
596 * Sets the gap axis.
597 *
598 * @public @memberof GoProfilePanelGap
599 * @version Introduced in firmware 4.0.10.27
600 * @param measurement GoProfilePanelGap object.
601 * @param axis The gap axis value to set.
602 * @return Operation status.
603 */
604 GoFx(kStatus) GoProfilePanelGap_SetAxis(GoProfilePanelGap measurement, GoProfileGapAxis axis);
605
606 /**
607 * @class GoProfilePanelFlush
608 * @extends GoMeasurement
609 * @ingroup GoSdk-ProfileTools
610 * @brief Represents a flush measurement for a Profile Panel Tool.
611 */
612 typedef GoMeasurement GoProfilePanelFlush;
613
614 /**
615 * Gets absolute value state.
616 *
617 * @public @memberof GoProfilePanelFlush
618 * @version Introduced in firmware 4.0.10.27
619 * @param measurement GoProfilePanelFlush object.
620 * @return kTRUE if absolute value is enabled and kFALSE otherwise.
621 */
622 GoFx(kBool) GoProfilePanelFlush_AbsoluteEnabled(GoProfilePanelFlush measurement);
623
624 /**
625 * Enables or disables the absolute value state.
626 *
627 * @public @memberof GoProfilePanelFlush
628 * @version Introduced in firmware 4.0.10.27
629 * @param measurement GoProfilePanelFlush object.
630 * @param absolute kTRUE to enable and kFALSE to disable.
631 * @return Operation status.
632 */
633 GoFx(kStatus) GoProfilePanelFlush_EnableAbsolute(GoProfilePanelFlush measurement, kBool absolute);
634
635 /**
636 * @class GoProfilePositionX
637 * @extends GoMeasurement
638 * @ingroup GoSdk-ProfileTools
639 * @brief Represents an X measurement for a Profile Position tool.
640 */
641 typedef GoMeasurement GoProfilePositionX;
642
643 /**
644 * @class GoProfilePositionZ
645 * @extends GoMeasurement
646 * @ingroup GoSdk-ProfileTools
647 * @brief Represents an Z measurement for a Profile Position tool.
648 */
649 typedef GoMeasurement GoProfilePositionZ;
650
651
652 /**
653 * @class GoProfileStripX
654 * @extends GoMeasurement
655 * @ingroup GoSdk-ProfileTools
656 * @brief Represents an X measurement for a Profile Strip Tool.
657 */
658 typedef GoMeasurement GoProfileStripX;
659
660 /**
661 * Gets the groove location configuration value.
662 *
663 * @public @memberof GoProfileStripX
664 * @version Introduced in firmware 4.0.10.27
665 * @param measurement GoProfileStripX object.
666 * @return The profile groove location.
667 */
668 GoFx(GoProfileGrooveLocation) GoProfileStripX_Location(GoProfileStripX measurement);
669
670 /**
671 * Sets the groove location configuration value.
672 *
673 * @public @memberof GoProfileStripX
674 * @version Introduced in firmware 4.0.10.27
675 * @param measurement GoProfileStripX object.
676 * @param location The groove location value to set.
677 * @return Operation status.
678 */
679 GoFx(kStatus) GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location);
680
681 /**
682 * Gets the select type.
683 *
684 * @public @memberof GoProfileStripX
685 * @version Introduced in firmware 4.0.10.27
686 * @param measurement GoProfileStripX object.
687 * @return The select type.
688 */
689 GoFx(GoProfileGrooveSelectType) GoProfileStripX_SelectType(GoProfileStripX measurement);
690
691 /**
692 * Sets the select type.
693 *
694 * @public @memberof GoProfileStripX
695 * @version Introduced in firmware 4.0.10.27
696 * @param measurement GoProfileStripX object.
697 * @param selectType The select type to set.
698 * @return Operation status.
699 */
700 GoFx(kStatus) GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType);
701
702 /**
703 * Gets the select index.
704 *
705 * @public @memberof GoProfileStripX
706 * @version Introduced in firmware 4.0.10.27
707 * @param measurement GoProfileStripX object.
708 * @return The select index.
709 */
710 GoFx(k32u) GoProfileStripX_SelectIndex(GoProfileStripX measurement);
711
712 /**
713 * Sets the select index.
714 *
715 * @public @memberof GoProfileStripX
716 * @version Introduced in firmware 4.0.10.27
717 * @param measurement GoProfileStripX object.
718 * @param selectIndex The select index value to set.
719 * @return Operation status.
720 */
721 GoFx(kStatus) GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex);
722
723
724 /**
725 * @class GoProfileStripZ
726 * @extends GoMeasurement
727 * @ingroup GoSdk-ProfileTools
728 * @brief Represents a Z measurement for a Profile Strip Tool.
729 */
730 typedef GoMeasurement GoProfileStripZ;
731
732 /**
733 * Gets the groove location configuration value.
734 *
735 * @public @memberof GoProfileStripZ
736 * @version Introduced in firmware 4.0.10.27
737 * @param measurement GoProfileStripZ object.
738 * @return The profile groove location.
739 */
740 GoFx(GoProfileGrooveLocation) GoProfileStripZ_Location(GoProfileStripZ measurement);
741
742 /**
743 * Sets the groove location configuration value.
744 *
745 * @public @memberof GoProfileStripZ
746 * @version Introduced in firmware 4.0.10.27
747 * @param measurement GoProfileStripZ object.
748 * @param location The profile groove location to set.
749 * @return Operation status.
750 */
751 GoFx(kStatus) GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location);
752
753 /**
754 * Gets the select type.
755 *
756 * @public @memberof GoProfileStripZ
757 * @version Introduced in firmware 4.0.10.27
758 * @param measurement GoProfileStripZ object.
759 * @return The select type.
760 */
761 GoFx(GoProfileGrooveSelectType) GoProfileStripZ_SelectType(GoProfileStripZ measurement);
762
763 /**
764 * Sets the select type.
765 *
766 * @public @memberof GoProfileStripZ
767 * @version Introduced in firmware 4.0.10.27
768 * @param measurement GoProfileStripZ object.
769 * @param selectType The select type to set.
770 * @return Operation status.
771 */
772 GoFx(kStatus) GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType);
773
774 /**
775 * Gets the select index.
776 *
777 * @public @memberof GoProfileStripZ
778 * @version Introduced in firmware 4.0.10.27
779 * @param measurement GoProfileStripZ object.
780 * @return The select index.
781 */
782 GoFx(k32u) GoProfileStripZ_SelectIndex(GoProfileStripZ measurement);
783
784 /**
785 * Sets the select index.
786 *
787 * @public @memberof GoProfileStripZ
788 * @version Introduced in firmware 4.0.10.27
789 * @param measurement GoProfileStripZ object.
790 * @param selectIndex The select index value to set.
791 * @return Operation status.
792 */
793 GoFx(kStatus) GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex);
794
795
796 /**
797 * @class GoProfileStripWidth
798 * @extends GoMeasurement
799 * @ingroup GoSdk-ProfileTools
800 * @brief Represents a width measurement for a Profile Strip Tool.
801 */
802 typedef GoMeasurement GoProfileStripWidth;
803
804 /**
805 * Gets the select type.
806 *
807 * @public @memberof GoProfileStripWidth
808 * @version Introduced in firmware 4.0.10.27
809 * @param measurement GoProfileStripWidth object.
810 * @return The select type.
811 */
812 GoFx(GoProfileGrooveSelectType) GoProfileStripWidth_SelectType(GoProfileStripWidth measurement);
813
814 /**
815 * Sets the select type.
816 *
817 * @public @memberof GoProfileStripWidth
818 * @version Introduced in firmware 4.0.10.27
819 * @param measurement GoProfileStripWidth object.
820 * @param selectType The select type to set.
821 * @return Operation status.
822 */
823 GoFx(kStatus) GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType);
824
825 /**
826 * Gets the select index.
827 *
828 * @public @memberof GoProfileStripWidth
829 * @version Introduced in firmware 4.0.10.27
830 * @param measurement GoProfileStripWidth object.
831 * @return The select index.
832 */
833 GoFx(k32u) GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement);
834
835 /**
836 * Sets the select index.
837 *
838 * @public @memberof GoProfileStripWidth
839 * @version Introduced in firmware 4.0.10.27
840 * @param measurement GoProfileStripWidth object.
841 * @param selectIndex The select index value to set.
842 * @return Operation status.
843 */
844 GoFx(kStatus) GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex);
845
846
847 /**
848 * @class GoProfileStripHeight
849 * @extends GoMeasurement
850 * @ingroup GoSdk-ProfileTools
851 * @brief Represents an height measurement for a Profile Strip Tool.
852 */
853 typedef GoMeasurement GoProfileStripHeight;
854
855 /**
856 * Gets the groove location setting.
857 *
858 * @public @memberof GoProfileStripHeight
859 * @version Introduced in firmware 4.0.10.27
860 * @param measurement GoProfileStripHeight object.
861 * @return The groove location setting.
862 */
863 GoFx(GoProfileGrooveLocation) GoProfileStripHeight_Location(GoProfileStripHeight measurement);
864
865 /**
866 * Sets the location.
867 *
868 * @public @memberof GoProfileStripHeight
869 * @version Introduced in firmware 4.0.10.27
870 * @param measurement GoProfileStripHeight object.
871 * @param location The location value to set.
872 * @return Operation status.
873 */
874 GoFx(kStatus) GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location);
875
876 /**
877 * Gets the select type.
878 *
879 * @public @memberof GoProfileStripHeight
880 * @version Introduced in firmware 4.0.10.27
881 * @param measurement GoProfileStripHeight object.
882 * @return The select type.
883 */
884 GoFx(GoProfileGrooveSelectType) GoProfileStripHeight_SelectType(GoProfileStripHeight measurement);
885
886 /**
887 * Sets the select type.
888 *
889 * @public @memberof GoProfileStripHeight
890 * @version Introduced in firmware 4.0.10.27
891 * @param measurement GoProfileStripHeight object.
892 * @param selectType The select type value to set.
893 * @return Operation status.
894 */
895 GoFx(kStatus) GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType);
896
897 /**
898 * Gets the select index.
899 *
900 * @public @memberof GoProfileStripHeight
901 * @version Introduced in firmware 4.0.10.27
902 * @param measurement GoProfileStripHeight object.
903 * @return The select index.
904 */
905 GoFx(k32u) GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement);
906
907 /**
908 * Sets the select index.
909 *
910 * @public @memberof GoProfileStripHeight
911 * @version Introduced in firmware 4.0.10.27
912 * @param measurement GoProfileStripHeight object.
913 * @param selectIndex The select index value to set.
914 * @return Operation status.
915 */
916 GoFx(kStatus) GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex);
917
918 /**
919 * @class GoProfileXLineZ
920 * @extends GoMeasurement
921 * @ingroup GoSdk-ProfileTools
922 * @brief Represents an Z measurement for a Profile X-Line tool.
923 */
924 typedef GoMeasurement GoProfileXLineZ;
925
926 /**
927 * @class GoProfileXLineValidity
928 * @extends GoMeasurement
929 * @ingroup GoSdk-ProfileTools
930 * @brief Represents an Validity measurement for a Profile X-Line tool.
931 */
932 typedef GoMeasurement GoProfileXLineValidity;
933
934 /// @endcond
935
936
937 /// @cond (Gocator_2x00 || Gocator_3x00)
938
939 /**
940 * @class GoSurfaceBoxX
941 * @extends GoMeasurement
942 * @ingroup GoSdk-SurfaceTools
943 * @brief Represents an X measurement for a Surface Bounding Box tool.
944 */
945 typedef GoMeasurement GoSurfaceBoxX;
946
947 /**
948 * @class GoSurfaceBoxY
949 * @extends GoMeasurement
950 * @ingroup GoSdk-SurfaceTools
951 * @brief Represents a Y measurement for a Surface Bounding Box tool.
952 */
953 typedef GoMeasurement GoSurfaceBoxY;
954
955 /**
956 * @class GoSurfaceBoxZ
957 * @extends GoMeasurement
958 * @ingroup GoSdk-SurfaceTools
959 * @brief Represents a Z measurement for a Surface Bounding Box tool.
960 */
961 typedef GoMeasurement GoSurfaceBoxZ;
962
963
964 /**
965 * @class GoSurfaceBoxZAngle
966 * @extends GoMeasurement
967 * @ingroup GoSdk-SurfaceTools
968 * @brief Represents a Z-angle measurement for a Surface Bounding Box tool.
969 */
970 typedef GoMeasurement GoSurfaceBoxZAngle;
971
972 /**
973 * @class GoSurfaceBoxGlobalX
974 * @extends GoMeasurement
975 * @ingroup GoSdk-SurfaceTools
976 * @brief Represents a global X measurement for a Surface Bounding Box tool.
977 */
978 typedef GoMeasurement GoSurfaceBoxGlobalX;
979
980 /**
981 * @class GoSurfaceBoxGlobalY
982 * @extends GoMeasurement
983 * @ingroup GoSdk-SurfaceTools
984 * @brief Represents a global Y measurement for a Surface Bounding Box tool.
985 */
986 typedef GoMeasurement GoSurfaceBoxGlobalY;
987
988 /**
989 * @class GoSurfaceBoxGlobalZAngle
990 * @extends GoMeasurement
991 * @ingroup GoSdk-SurfaceTools
992 * @brief Represents a global Z angle measurement for a Surface Bounding Box tool.
993 */
994 typedef GoMeasurement GoSurfaceBoxGlobalZAngle;
995
996 /**
997 * @class GoSurfaceBoxLength
998 * @extends GoMeasurement
999 * @ingroup GoSdk-SurfaceTools
1000 * @brief Represents a length measurement for a Surface Bounding Box tool.
1001 */
1002 typedef GoMeasurement GoSurfaceBoxLength;
1003
1004 /**
1005 * @class GoSurfaceBoxWidth
1006 * @extends GoMeasurement
1007 * @ingroup GoSdk-SurfaceTools
1008 * @brief Represents a width measurement for a Surface Bounding Box tool.
1009 */
1010 typedef GoMeasurement GoSurfaceBoxWidth;
1011
1012 /**
1013 * @class GoSurfaceBoxHeight
1014 * @extends GoMeasurement
1015 * @ingroup GoSdk-SurfaceTools
1016 * @brief Represents a height measurement for a Surface Bounding Box tool.
1017 */
1018 typedef GoMeasurement GoSurfaceBoxHeight;
1019
1020 /**
1021 * @class GoSurfaceEllipseMajor
1022 * @extends GoMeasurement
1023 * @ingroup GoSdk-SurfaceTools
1024 * @brief Represents a major value measurement for a Surface Ellipse tool.
1025 */
1026 typedef GoMeasurement GoSurfaceEllipseMajor;
1027
1028 /**
1029 * @class GoSurfaceEllipseMinor
1030 * @extends GoMeasurement
1031 * @ingroup GoSdk-SurfaceTools
1032 * @brief Represents a minor value measurement for a Surface Ellipse tool.
1033 */
1034 typedef GoMeasurement GoSurfaceEllipseMinor;
1035
1036 /**
1037 * @class GoSurfaceEllipseRatio
1038 * @extends GoMeasurement
1039 * @ingroup GoSdk-SurfaceTools
1040 * @brief Represents a ratio measurement for a Surface Ellipse tool.
1041 */
1042 typedef GoMeasurement GoSurfaceEllipseRatio;
1043
1044 /**
1045 * @class GoSurfaceEllipseZAngle
1046 * @extends GoMeasurement
1047 * @ingroup GoSdk-SurfaceTools
1048 * @brief Represents a Z-angle measurement for a Surface Ellipse tool.
1049 */
1050 typedef GoMeasurement GoSurfaceEllipseZAngle;
1051
1052 /**
1053 * @class GoSurfaceHoleX
1054 * @extends GoMeasurement
1055 * @ingroup GoSdk-SurfaceTools
1056 * @brief Represents an X measurement for a Surface Hole Tool.
1057 */
1058 typedef GoMeasurement GoSurfaceHoleX;
1059
1060 /**
1061 * @class GoSurfaceHoleY
1062 * @extends GoMeasurement
1063 * @ingroup GoSdk-SurfaceTools
1064 * @brief Represents a Y measurement for a Surface Hole Tool.
1065 */
1066 typedef GoMeasurement GoSurfaceHoleY;
1067
1068 /**
1069 * @class GoSurfaceHoleZ
1070 * @extends GoMeasurement
1071 * @ingroup GoSdk-SurfaceTools
1072 * @brief Represents a Z measurement for a Surface Hole Tool.
1073 */
1074 typedef GoMeasurement GoSurfaceHoleZ;
1075
1076 /**
1077 * @class GoSurfaceHoleRadius
1078 * @extends GoMeasurement
1079 * @ingroup GoSdk-SurfaceTools
1080 * @brief Represents a radius measurement for a Surface Hole Tool.
1081 */
1082 typedef GoMeasurement GoSurfaceHoleRadius;
1083
1084
1085 /**
1086 * @class GoSurfaceOpeningX
1087 * @extends GoMeasurement
1088 * @ingroup GoSdk-SurfaceTools
1089 * @brief Represents an X measurement for a Surface Opening Tool.
1090 */
1091 typedef GoMeasurement GoSurfaceOpeningX;
1092
1093 /**
1094 * @class GoSurfaceOpeningY
1095 * @extends GoMeasurement
1096 * @ingroup GoSdk-SurfaceTools
1097 * @brief Represents a Y measurement for a Surface Opening Tool.
1098 */
1099 typedef GoMeasurement GoSurfaceOpeningY;
1100
1101 /**
1102 * @class GoSurfaceOpeningZ
1103 * @extends GoMeasurement
1104 * @ingroup GoSdk-SurfaceTools
1105 * @brief Represents a Z measurement for a Surface Opening Tool.
1106 */
1107 typedef GoMeasurement GoSurfaceOpeningZ;
1108
1109 /**
1110 * @class GoSurfaceOpeningWidth
1111 * @extends GoMeasurement
1112 * @ingroup GoSdk-SurfaceTools
1113 * @brief Represents a width measurement for a Surface Opening Tool.
1114 */
1115 typedef GoMeasurement GoSurfaceOpeningWidth;
1116
1117 /**
1118 * @class GoSurfaceOpeningLength
1119 * @extends GoMeasurement
1120 * @ingroup GoSdk-SurfaceTools
1121 * @brief Represents a length measurement for a Surface Opening Tool.
1122 */
1123 typedef GoMeasurement GoSurfaceOpeningLength;
1124
1125 /**
1126 * @class GoSurfaceOpeningAngle
1127 * @extends GoMeasurement
1128 * @ingroup GoSdk-SurfaceTools
1129 * @brief Represents an angle measurement for a Surface Opening Tool.
1130 */
1131 typedef GoMeasurement GoSurfaceOpeningAngle;
1132
1133
1134 /**
1135 * @class GoSurfacePlaneXAngle
1136 * @extends GoMeasurement
1137 * @ingroup GoSdk-SurfaceTools
1138 * @brief Represents an X-angle measurement for a Surface Plane Tool.
1139 */
1140 typedef GoMeasurement GoSurfacePlaneXAngle;
1141
1142 /**
1143 * @class GoSurfacePlaneYAngle
1144 * @extends GoMeasurement
1145 * @ingroup GoSdk-SurfaceTools
1146 * @brief Represents a Y-angle measurement for a Surface Plane Tool.
1147 */
1148 typedef GoMeasurement GoSurfacePlaneYAngle;
1149
1150 /**
1151 * @class GoSurfacePlaneZOffset
1152 * @extends GoMeasurement
1153 * @ingroup GoSdk-SurfaceTools
1154 * @brief Represents a Z-offset measurement for a Surface Plane Tool.
1155 */
1156 typedef GoMeasurement GoSurfacePlaneZOffset;
1157
1158
1159 /**
1160 * @class GoSurfacePositionX
1161 * @extends GoMeasurement
1162 * @ingroup GoSdk-SurfaceTools
1163 * @brief Represents an X measurement for a Surface Position Tool.
1164 */
1165 typedef GoMeasurement GoSurfacePositionX;
1166
1167 /**
1168 * @class GoSurfacePositionY
1169 * @extends GoMeasurement
1170 * @ingroup GoSdk-SurfaceTools
1171 * @brief Represents a Y measurement for a Surface Position Tool.
1172 */
1173 typedef GoMeasurement GoSurfacePositionY;
1174
1175 /**
1176 * @class GoSurfacePositionZ
1177 * @extends GoMeasurement
1178 * @ingroup GoSdk-SurfaceTools
1179 * @brief Represents a Z measurement for a Surface Position Tool.
1180 */
1181 typedef GoMeasurement GoSurfacePositionZ;
1182
1183
1184 /**
1185 * @class GoSurfaceStudBaseX
1186 * @extends GoMeasurement
1187 * @ingroup GoSdk-SurfaceTools
1188 * @brief Represents a base X measurement for a Surface Stud Tool.
1189 */
1190 typedef GoMeasurement GoSurfaceStudBaseX;
1191
1192 /**
1193 * @class GoSurfaceStudBaseY
1194 * @extends GoMeasurement
1195 * @ingroup GoSdk-SurfaceTools
1196 * @brief Represents a base Y measurement for a Surface Stud Tool.
1197 */
1198 typedef GoMeasurement GoSurfaceStudBaseY;
1199
1200 /**
1201 * @class GoSurfaceStudBaseZ
1202 * @extends GoMeasurement
1203 * @ingroup GoSdk-SurfaceTools
1204 * @brief Represents a base Z measurement for a Surface Stud Tool.
1205 */
1206 typedef GoMeasurement GoSurfaceStudBaseZ;
1207
1208 /**
1209 * @class GoSurfaceStudTipX
1210 * @extends GoMeasurement
1211 * @ingroup GoSdk-SurfaceTools
1212 * @brief Represents a tip X measurement for a Surface Stud Tool.
1213 */
1214 typedef GoMeasurement GoSurfaceStudTipX;
1215
1216 /**
1217 * @class GoSurfaceStudTipY
1218 * @extends GoMeasurement
1219 * @ingroup GoSdk-SurfaceTools
1220 * @brief Represents a tip Y measurement for a Surface Stud Tool.
1221 */
1222 typedef GoMeasurement GoSurfaceStudTipY;
1223
1224 /**
1225 * @class GoSurfaceStudTipZ
1226 * @extends GoMeasurement
1227 * @ingroup GoSdk-SurfaceTools
1228 * @brief Represents a tip Z measurement for a Surface Stud Tool.
1229 */
1230 typedef GoMeasurement GoSurfaceStudTipZ;
1231
1232 /**
1233 * @class GoSurfaceStudRadius
1234 * @extends GoMeasurement
1235 * @ingroup GoSdk-SurfaceTools
1236 * @brief Represents a radius measurement for a Surface Stud Tool.
1237 */
1238 typedef GoMeasurement GoSurfaceStudRadius;
1239
1240 /**
1241 * Gets the radius offset.
1242 *
1243 * @public @memberof GoSurfaceStudRadius
1244 * @version Introduced in firmware 4.0.10.27
1245 * @param measurement GoSurfaceStudRadius object.
1246 * @return The surface location.
1247 */
1248 GoFx(k64f) GoSurfaceStudRadius_RadiusOffset(GoSurfaceStudRadius measurement);
1249
1250 /**
1251 * Sets the radius offset.
1252 *
1253 * @public @memberof GoSurfaceStudRadius
1254 * @version Introduced in firmware 4.0.10.27
1255 * @param measurement GoSurfaceStudRadius object.
1256 * @param value The offset value to set.
1257 * @return Operation status.
1258 */
1259 GoFx(kStatus) GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value);
1260
1261 /**
1262 * @class GoSurfaceVolumeVolume
1263 * @extends GoMeasurement
1264 * @ingroup GoSdk-SurfaceTools
1265 * @brief Represents a volume measurement for a Surface Volume Tool.
1266 */
1267 typedef GoMeasurement GoSurfaceVolumeVolume;
1268
1269 /**
1270 * @class GoSurfaceVolumeArea
1271 * @extends GoMeasurement
1272 * @ingroup GoSdk-SurfaceTools
1273 * @brief Represents an area measurement for a Surface Volume Tool.
1274 */
1275 typedef GoMeasurement GoSurfaceVolumeArea;
1276
1277 /**
1278 * @class GoSurfaceVolumeThickness
1279 * @extends GoMeasurement
1280 * @ingroup GoSdk-SurfaceTools
1281 * @brief Represents a thickness measurement for a Surface Volume Tool.
1282 */
1283 typedef GoMeasurement GoSurfaceVolumeThickness;
1284
1285 /**
1286 * Gets the location.
1287 *
1288 * @public @memberof GoSurfaceVolumeThickness
1289 * @version Introduced in firmware 4.0.10.27
1290 * @param measurement GoSurfaceVolumeThickness object.
1291 * @return The surface location.
1292 */
1293 GoFx(GoSurfaceLocation) GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement);
1294
1295 /**
1296 * Sets the location.
1297 *
1298 * @public @memberof GoSurfaceVolumeThickness
1299 * @version Introduced in firmware 4.0.10.27
1300 * @param measurement GoSurfaceVolumeThickness object.
1301 * @param location The surface location.
1302 * @return Operation status.
1303 */
1304 GoFx(kStatus) GoSurfaceVolumeThickness_SetLocation(GoSurfaceVolumeThickness measurement, GoSurfaceLocation location);
1305
1306 /**
1307 * @class GoSurfaceCountersunkHoleX
1308 * @extends GoMeasurement
1309 * @ingroup GoSdk-SurfaceTools
1310 * @brief Represents an X position measurement for a Surface Counter Sunk Hole Tool.
1311 */
1312 typedef GoMeasurement GoSurfaceCountersunkHoleX;
1313
1314 /**
1315 * @class GoSurfaceCountersunkHoleY
1316 * @extends GoMeasurement
1317 * @ingroup GoSdk-SurfaceTools
1318 * @brief Represents a Y position measurement for a Surface Counter Sunk Hole Tool.
1319 */
1320 typedef GoMeasurement GoSurfaceCountersunkHoleY;
1321
1322 /**
1323 * @class GoSurfaceCountersunkHoleZ
1324 * @extends GoMeasurement
1325 * @ingroup GoSdk-SurfaceTools
1326 * @brief Represents a Z position measurement for a Surface Counter Sunk Hole Tool.
1327 */
1328 typedef GoMeasurement GoSurfaceCountersunkHoleZ;
1329
1330 /**
1331 * @class GoSurfaceCountersunkHoleOuterRadius
1332 * @extends GoMeasurement
1333 * @ingroup GoSdk-SurfaceTools
1334 * @brief Represents an Outer Radius position measurement for a Surface Counter Sunk Hole Tool.
1335 */
1336 typedef GoMeasurement GoSurfaceCountersunkHoleOuterRadius;
1337
1338 /**
1339 * @class GoSurfaceCountersunkHoleDepth
1340 * @extends GoMeasurement
1341 * @ingroup GoSdk-SurfaceTools
1342 * @brief Represents a Depth position measurement for a Surface Counter Sunk Hole Tool.
1343 */
1344 typedef GoMeasurement GoSurfaceCountersunkHoleDepth;
1345
1346 /**
1347 * @class GoSurfaceCountersunkHoleBevelRadius
1348 * @extends GoMeasurement
1349 * @ingroup GoSdk-SurfaceTools
1350 * @brief Represents an Bevel Radius position measurement for a Surface Counter Sunk Hole Tool.
1351 */
1352 typedef GoMeasurement GoSurfaceCountersunkHoleBevelRadius;
1353
1354 /**
1355 * @class GoSurfaceCountersunkHoleBevelAngle
1356 * @extends GoMeasurement
1357 * @ingroup GoSdk-SurfaceTools
1358 * @brief Represents a Bevel Angle measurement for a Surface Counter Sunk Hole Tool.
1359 */
1360 typedef GoMeasurement GoSurfaceCountersunkHoleBevelAngle;
1361
1362 /**
1363 * @class GoSurfaceCountersunkHoleXAngle
1364 * @extends GoMeasurement
1365 * @ingroup GoSdk-SurfaceTools
1366 * @brief Represents an X Angle position measurement for a Surface Counter Sunk Hole Tool.
1367 */
1368 typedef GoMeasurement GoSurfaceCountersunkHoleXAngle;
1369
1370 /**
1371 * @class GoSurfaceCountersunkHoleYAngle
1372 * @extends GoMeasurement
1373 * @ingroup GoSdk-SurfaceTools
1374 * @brief Represents a Y Angle position measurement for a Surface Counter Sunk Hole Tool.
1375 */
1376 typedef GoMeasurement GoSurfaceCountersunkHoleYAngle;
1377
1378 /**
1379 * @class GoSurfaceCountersunkHoleCounterboreDepth
1380 * @extends GoMeasurement
1381 * @ingroup GoSdk-SurfaceTools
1382 * @brief Represents a counterbore depth measurement for a Surface Counter Sunk Hole Tool.
1383 */
1384 typedef GoMeasurement GoSurfaceCountersunkHoleCounterboreDepth;
1385
1386 /// @endcond
1387
1388
1389 /**
1390 * @class GoScriptOutput
1391 * @extends GoMeasurement
1392 * @ingroup GoSdk-Tools
1393 * @brief Represents a script output for a Script Tool.
1394 */
1395 typedef GoMeasurement GoScriptOutput;
1396
1397 kEndHeader()
1398 #include <GoSdk/Tools/GoMeasurements.x.h>
1399
1400 #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.
k32u
GoSurfaceStudRadius::GoSurfaceStudRadius_SetRadiusOffset
kStatus GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value)
Sets the radius offset.
GoSurfaceBoxZAngle
Represents a Z-angle measurement for a Surface Bounding Box tool.
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.
GoSurfaceHoleY
Represents a Y measurement for a Surface Hole Tool.
GoSurfaceOpeningZ
Represents a Z measurement for a Surface Opening Tool.
GoMeasurement.h
Declares the GoMeasurement class.
GoSurfaceCountersunkHoleZ
Represents a Z position measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceVolumeArea
Represents an area measurement for a Surface Volume Tool.
GoSurfaceEllipseMinor
Represents a minor value measurement for a Surface Ellipse tool.
GoSurfaceStudBaseY
Represents a base Y measurement for a Surface Stud Tool.
GoSurfaceEllipseZAngle
Represents a Z-angle measurement for a Surface Ellipse tool.
GoSurfacePlaneZOffset
Represents a Z-offset measurement for a Surface Plane Tool.
GoSurfaceStudTipX
Represents a tip X measurement for a Surface Stud Tool.
GoSurfaceCountersunkHoleDepth
Represents a Depth position measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceHoleX
Represents an X measurement for a Surface Hole Tool.
GoSurfaceOpeningY
Represents a Y measurement for a Surface Opening Tool.
GoScriptOutput
Represents a script output for a Script Tool.
GoSurfacePlaneXAngle
Represents an X-angle measurement for a Surface Plane Tool.
GoSurfaceEllipseMajor
Represents a major value measurement for a Surface Ellipse tool.
GoSurfacePositionX
Represents an X measurement for a Surface Position Tool.
GoSurfaceCountersunkHoleBevelAngle
Represents a Bevel Angle measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceCountersunkHoleOuterRadius
Represents an Outer Radius position measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceStudTipY
Represents a tip Y measurement for a Surface Stud Tool.
GoSdkDef.h
Essential SDK declarations.
GoSurfaceLocation
Represents a surface location.
GoSurfaceOpeningWidth
Represents a width measurement for a Surface Opening Tool.
GoSurfaceCountersunkHoleBevelRadius
Represents an Bevel Radius position measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceBoxX
Represents an X measurement for a Surface Bounding Box tool.
GoSurfaceStudBaseX
Represents a base X measurement for a Surface Stud Tool.
GoSurfaceOpeningX
Represents an X measurement for a Surface Opening 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.
GoSurfaceBoxGlobalX
Represents a global X measurement for a Surface Bounding Box tool.
GoSurfaceOpeningAngle
Represents an angle measurement for a Surface Opening Tool.
GoSurfacePositionY
Represents a Y measurement for a Surface Position Tool.
GoSurfaceVolumeThickness::GoSurfaceVolumeThickness_Location
GoSurfaceLocation GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement)
Gets the location.
GoSurfaceBoxHeight
Represents a height measurement for a Surface Bounding Box tool.
GoSurfaceStudTipZ
Represents a tip Z measurement for a Surface Stud Tool.
GoSurfaceCountersunkHoleCounterboreDepth
Represents a counterbore depth measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceBoxY
Represents a Y measurement for a Surface Bounding Box tool.
GoSurfaceVolumeVolume
Represents a volume measurement for a Surface Volume Tool.
GoSurfaceCountersunkHoleXAngle
Represents an X Angle position measurement for a Surface Counter Sunk Hole Tool.
GoSurfaceHoleRadius
Represents a radius measurement for a Surface Hole Tool.
kStatus
GoSurfaceBoxGlobalY
Represents a global Y measurement for a Surface Bounding Box tool.
GoSurfacePositionZ
Represents a Z measurement for a Surface Position Tool.
k64f
GoSurfaceEllipseRatio
Represents a ratio measurement for a Surface Ellipse tool.
GoSurfaceHoleZ
Represents a Z measurement for a Surface Hole 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.
GoSurfaceBoxZ
Represents a Z measurement for a Surface Bounding Box tool.
GoSurfaceStudBaseZ
Represents a base Z measurement for a Surface Stud Tool.