Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoProfileTools.h
Go to the documentation of this file.
1 /**
2  * @file GoProfileTools.h
3  * @brief Declares all profile tools and their related classes.
4  *
5  * @internal
6  * Copyright (C) 2016-2019 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_PROFILE_TOOLS_H
11 #define GO_PROFILE_TOOLS_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoTool.h>
15 #include <GoSdk/Tools/GoProfileToolUtils.h>
16 #include <GoSdk/GoUtils.h>
17 
18 kBeginHeader()
19 
20 /**
21  * @class GoProfileTool
22  * @extends GoTool
23  * @ingroup GoSdk-ProfileTools
24  * @brief Represents a base profile tool.
25  */
26 typedef GoTool GoProfileTool;
27 
28 
29 /**
30  * Sets the data stream. Note that stream validation will only occur if tool
31  * is in the tool options list.
32  *
33  * @public @memberof GoProfileTool
34  * @version Introduced in firmware 4.4.4.14
35  * @param tool GoProfileTool object.
36  * @param stream GoDataStream value.
37  * @return Operation status.
38  * @see GoProfileTool_StreamOptionCount, GoProfileTool_StreamOptionAt
39  */
40 GoFx(kStatus) GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream);
41 
42 /**
43  * Gets the data stream.
44  *
45  * @public @memberof GoProfileTool
46  * @version Introduced in firmware 4.4.4.14
47  * @param tool GoProfileTool object.
48  * @return The current profile tool data stream value.
49  */
50 GoFx(GoDataStream) GoProfileTool_Stream(GoProfileTool tool);
51 
52 /**
53  * Gets the data stream option list count.
54  *
55  * @public @memberof GoProfileTool
56  * @version Introduced in firmware 4.4.4.14
57  * @param tool GoProfileTool object.
58  * @return The current profile tool data stream option list count.
59  */
60 GoFx(kSize) GoProfileTool_StreamOptionCount(GoProfileTool tool);
61 
62 /**
63  * Gets the data stream option at the given index.
64  *
65  * @public @memberof GoProfileTool
66  * @version Introduced in firmware 4.4.4.14
67  * @param tool GoProfileTool object.
68  * @param index The index of the option list to access.
69  * @return The profile tool data stream option at the given index, or k32U_MAX if an invalid index is given.
70  */
71 GoFx(GoDataStream) GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index);
72 
73 /**
74  * Sets the data source. Note that source validation will only occur if tool
75  * is in the tool options list.
76  *
77  * @public @memberof GoProfileTool
78  * @version Introduced in firmware 4.0.10.27
79  * @param tool GoProfileTool object.
80  * @param source GoDataSource object.
81  * @return Operation status.
82  * @see GoTools_ToolOptionCount, GoTools_ToolOptionAt
83  */
84 GoFx(kStatus) GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source);
85 
86 /**
87  * Gets the data source.
88  *
89  * @public @memberof GoProfileTool
90  * @version Introduced in firmware 4.0.10.27
91  * @param tool GoProfileTool object.
92  * @return The current profile tool data source.
93  */
94 GoFx(GoDataSource) GoProfileTool_Source(GoProfileTool tool);
95 
96 /**
97  * Gets the data source option list count.
98  *
99  * @public @memberof GoProfileTool
100  * @version Introduced in firmware 4.0.10.27
101  * @param tool GoProfileTool object.
102  * @return The current profile tool data source option list count.
103  */
104 GoFx(kSize) GoProfileTool_SourceOptionCount(GoProfileTool tool);
105 
106 /**
107  * Gets the data source option at the given index.
108  *
109  * @public @memberof GoProfileTool
110  * @version Introduced in firmware 4.0.10.27
111  * @param tool GoProfileTool object.
112  * @param index The index of the option list to access.
113  * @return The profile tool data source option at the given index, or k32U_MAX if an invalid index is given.
114  */
115 GoFx(GoDataSource) GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index);
116 
117 /**
118  * Gets the X-anchoring option list count.
119  *
120  * @public @memberof GoProfileTool
121  * @version Introduced in firmware 4.0.10.27
122  * @param tool GoProfileTool object.
123  * @return The X-anchoring option list count.
124  */
125 GoFx(kSize) GoProfileTool_XAnchorOptionCount(GoProfileTool tool);
126 
127 /**
128  * Gets the X-anchoring option at the given index.
129  *
130  * @public @memberof GoProfileTool
131  * @version Introduced in firmware 4.0.10.27
132  * @param tool GoProfileTool object.
133  * @param index The index of the option list to access.
134  * @return The X-anchoring option at the given index or k32U_MAX if invalid.
135  */
136 GoFx(k32u) GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index);
137 
138 /**
139  * Gets the current X-anchoring source.
140  *
141  * @public @memberof GoProfileTool
142  * @version Introduced in firmware 4.0.10.27
143  * @param tool GoProfileTool object.
144  * @return The X-anchoring source or -1 if no source is currently set.
145  */
146 GoFx(k32s) GoProfileTool_XAnchor(GoProfileTool tool);
147 
148 /**
149  * Sets the X-anchoring source.
150  *
151  * @public @memberof GoProfileTool
152  * @version Introduced in firmware 4.0.10.27
153  * @param tool GoProfileTool object.
154  * @param id The measurement ID of a valid X-anchoring source.
155  * @return Operation status.
156  */
157 GoFx(kStatus) GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id);
158 
159 /**
160  * Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.
161  *
162  * @public @memberof GoProfileTool
163  * @version Introduced in firmware 4.0.10.27
164  * @param tool GoProfileTool object.
165  * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
166  */
167 GoFx(kBool) GoProfileTool_XAnchorEnabled(GoProfileTool tool);
168 
169 /**
170  * Gets the Z-anchoring option list count.
171  *
172  * @public @memberof GoProfileTool
173  * @version Introduced in firmware 4.0.10.27
174  * @param tool GoProfileTool object.
175  * @return The X-anchoring option list count.
176  */
177 GoFx(kSize) GoProfileTool_ZAnchorOptionCount(GoProfileTool tool);
178 
179 /**
180  * Gets the Z-anchoring option at the given index.
181  *
182  * @public @memberof GoProfileTool
183  * @version Introduced in firmware 4.0.10.27
184  * @param tool GoProfileTool object.
185  * @param index The index of the option list to access.
186  * @return The Z-anchoring option at the given index or k32U_MAX if invalid.
187  */
188 GoFx(k32u) GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index);
189 
190 /**
191  * Gets the current Z-anchoring source.
192  *
193  * @public @memberof GoProfileTool
194  * @version Introduced in firmware 4.0.10.27
195  * @param tool GoProfileTool object.
196  * @return The Z-anchoring source or -1 if no source is currently set.
197  */
198 GoFx(k32s) GoProfileTool_ZAnchor(GoProfileTool tool);
199 
200 /**
201  * Sets the Z-anchoring source.
202  *
203  * @public @memberof GoProfileTool
204  * @version Introduced in firmware 4.0.10.27
205  * @param tool GoProfileTool object.
206  * @param id The measurement ID of a valid Z-anchoring source.
207  * @return Operation status.
208  */
209 GoFx(kStatus) GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id);
210 
211 /**
212  * Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.
213  *
214  * @public @memberof GoProfileTool
215  * @version Introduced in firmware 4.0.10.27
216  * @param tool GoProfileTool object.
217  * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
218  */
219 GoFx(kBool) GoProfileTool_ZAnchorEnabled(GoProfileTool tool);
220 
221 
222 /**
223  * @class GoProfileArea
224  * @extends GoProfileTool
225  * @ingroup GoSdk-ProfileTools
226  * @brief Represents a profile area tool.
227  */
228 typedef GoProfileTool GoProfileArea;
229 
230 /**
231  * Gets the profile area baseline.
232  *
233  * @public @memberof GoProfileArea
234  * @version Introduced in firmware 4.0.10.27
235  * @param tool GoProfileArea object.
236  * @return The profile area baseline.
237  */
238 GoFx(GoProfileBaseline) GoProfileArea_Baseline(GoProfileArea tool);
239 
240 /**
241  * Sets the profile area type.
242  *
243  * @public @memberof GoProfileArea
244  * @version Introduced in firmware 4.0.10.27
245  * @param tool GoProfileArea object.
246  * @param type The baseline type to set.
247  * @return Operation status.
248  */
249 GoFx(kStatus) GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type);
250 
251 /**
252  * Returns a boolean representing whether the profile area baseline is used.
253  *
254  * @public @memberof GoProfileArea
255  * @version Introduced in firmware 4.0.10.27
256  * @param tool GoProfileArea object.
257  * @return kTRUE if the baseline is used; kFALSE otherwise.
258  */
259 GoFx(kBool) GoProfileArea_BaselineUsed(GoProfileArea tool);
260 
261 /**
262  * Gets the reference profile line.
263  *
264  * @public @memberof GoProfileArea
265  * @version Introduced in firmware 4.0.10.27
266  * @param tool GoProfileArea object.
267  * @return The reference profile line.
268  */
269 GoFx(GoProfileLineRegion) GoProfileArea_LineRegion(GoProfileArea tool);
270 
271 /**
272  * Gets the profile area type.
273  *
274  * @public @memberof GoProfileArea
275  * @version Introduced in firmware 4.0.10.27
276  * @param tool GoProfileArea object.
277  * @return The profile area type.
278  */
279 GoFx(GoProfileAreaType) GoProfileArea_Type(GoProfileArea tool);
280 
281 /**
282  * Gets the boolean representing whether the area type is used.
283  *
284  * @public @memberof GoProfileArea
285  * @version Introduced in firmware 4.0.10.27
286  * @param tool GoProfileArea object.
287  * @return kTRUE if profile area type is used; kFALSE otherwise.
288  */
289 GoFx(kBool) GoProfileArea_TypeUsed(GoProfileArea tool);
290 
291 /**
292  * Sets the profile area type.
293  *
294  * @public @memberof GoProfileArea
295  * @version Introduced in firmware 4.0.10.27
296  * @param tool GoProfileArea object.
297  * @param type GoProfileAreaType object.
298  * @return Operation status.
299  */
300 GoFx(kStatus) GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type);
301 
302 /**
303  * Gets the profile region.
304  *
305  * @public @memberof GoProfileArea
306  * @version Introduced in firmware 4.0.10.27
307  * @param tool GoProfileArea object.
308  * @return The profile region.
309  */
310 GoFx(GoProfileRegion) GoProfileArea_Region(GoProfileArea tool);
311 
312 /**
313  * Indicates whether the region is enabled.
314  *
315  * @public @memberof GoProfileArea
316  * @version Introduced in firmware 4.4.4.14
317  * @param tool GoProfileArea object.
318  * @return kTRUE if enabled and kFALSE otherwise.
319  */
320 GoFx(kBool) GoProfileArea_RegionEnabled(GoProfileArea tool);
321 
322 /**
323  * Enables or disables the region.
324  *
325  * @public @memberof GoProfileArea
326  * @version Introduced in firmware 4.4.4.14
327  * @param tool GoProfileArea object.
328  * @param enable kTRUE to enable the region and kFALSE to disable it.
329  * @return Operation status.
330  */
331 GoFx(kStatus) GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable);
332 
333 /**
334  * Returns a GoProfileArea Area measurement object.
335  *
336  * @public @memberof GoProfileArea
337  * @version Introduced in firmware 4.0.10.27
338  * @param tool GoProfileArea object.
339  * @return A GoProfileAreaArea measurement.
340  */
341 GoFx(GoProfileAreaArea) GoProfileArea_AreaMeasurement(GoProfileArea tool);
342 
343 /**
344  * Returns a GoProfileArea Centroid X measurement object.
345  *
346  * @public @memberof GoProfileArea
347  * @version Introduced in firmware 4.0.10.27
348  * @param tool GoProfileArea object.
349  * @return A GoProfileAreaCentroidX measurement.
350  */
352 
353 /**
354  * Returns a GoProfileArea Centroid Z measurement object.
355  *
356  * @public @memberof GoProfileArea
357  * @version Introduced in firmware 4.0.10.27
358  * @param tool GoProfileArea object.
359  * @return A GoProfileAreaCentroidZ measurement.
360  */
362 
363 /**
364 * Returns a GoProfileArea Center point feature object.
365 *
366 * @public @memberof GoProfileArea
367 * @version Introduced in firmware 4.6.4.9
368 * @param tool GoProfileArea object.
369 * @return A GoProfileAreaCenterPoint Center point feature.
370 */
371 GoFx(GoProfileAreaCenterPoint) GoProfileArea_CenterPoint(GoProfileArea tool);
372 
373 /**
374  * @class GoProfileBox
375  * @extends GoProfileTool
376  * @ingroup GoSdk-ProfileTools
377  * @brief Represents a profile bounding box tool.
378  */
379 typedef GoProfileTool GoProfileBox;
380 
381 /**
382  * Returns the enabled state of the tool region.
383  *
384  * @public @memberof GoProfileBox
385  * @version Introduced in firmware 4.2.4.7
386  * @param tool GoProfileBox object.
387  * @return kTRUE if enabled and kFALSE if disabled.
388  */
389 GoFx(kBool) GoProfileBox_RegionEnabled(GoProfileBox tool);
390 
391 /**
392  * Enables or disables the tool region.
393  *
394  * @public @memberof GoProfileBox
395  * @version Introduced in firmware 4.2.4.7
396  * @param tool GoProfileBox object.
397  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
398  * @return Operation status.
399  */
400 GoFx(kStatus) GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable);
401 
402 /**
403  * Gets the profile bounding box region.
404  *
405  * @public @memberof GoProfileBox
406  * @version Introduced in firmware 4.2.4.7
407  * @param tool GoProfileBox object.
408  * @return A GoRegion3d object.
409  */
410 GoFx(GoProfileRegion) GoProfileBox_Region(GoProfileBox tool);
411 
412 /**
413  * Returns a GoProfileBox X measurement object.
414  *
415  * @public @memberof GoProfileBox
416  * @version Introduced in firmware 4.2.4.7
417  * @param tool GoProfileBox object.
418  * @return A GoProfileBox X measurement. (mm)
419  */
420 GoFx(GoProfileBoxX) GoProfileBox_XMeasurement(GoProfileBox tool);
421 
422 /**
423  * Returns a GoProfileBox Z measurement object.
424  *
425  * @public @memberof GoProfileBox
426  * @version Introduced in firmware 4.2.4.7
427  * @param tool GoProfileBox object.
428  * @return A GoProfileBox Z measurement. (mm)
429  */
430 GoFx(GoProfileBoxZ) GoProfileBox_ZMeasurement(GoProfileBox tool);
431 
432 /**
433  * Returns a GoProfileBox Width measurement object.
434  *
435  * @public @memberof GoProfileBox
436  * @version Introduced in firmware 4.2.4.7
437  * @param tool GoProfileBox object.
438  * @return A GoProfileBox Width measurement. (mm)
439  */
440 GoFx(GoProfileBoxWidth) GoProfileBox_WidthMeasurement(GoProfileBox tool);
441 
442 /**
443  * Returns a GoProfileBox Height measurement object.
444  *
445  * @public @memberof GoProfileBox
446  * @version Introduced in firmware 4.2.4.7
447  * @param tool GoProfileBox object.
448  * @return A GoProfileBox Height measurement. (mm)
449  */
450 GoFx(GoProfileBoxHeight) GoProfileBox_HeightMeasurement(GoProfileBox tool);
451 
452 /**
453  * Returns a GoProfileBox global X measurement object.
454  *
455  * @public @memberof GoProfileBox
456  * @version Introduced in firmware 4.2.4.7
457  * @param tool GoProfileBox object.
458  * @return A GoProfileBox global X measurement. (mm)
459  */
461 
462 /**
463  * Returns a GoProfileBox global Y measurement object.
464  *
465  * @public @memberof GoProfileBox
466  * @version Introduced in firmware 4.4.4.14
467  * @param tool GoProfileBox object.
468  * @return A GoProfileBox global Y measurement. (mm)
469  */
471 
472 /**
473  * Returns a GoProfileBox global Angle measurement object.
474  *
475  * @public @memberof GoProfileBox
476  * @version Introduced in firmware 4.4.4.14
477  * @param tool GoProfileBox object.
478  * @return A GoProfileBox global angle measurement. (degrees)
479  */
481 
482 /**
483 * Returns a GoProfileBox corner point feature object.
484 *
485 * @public @memberof GoProfileBox
486 * @version Introduced in firmware 4.4.4.14
487 * @param tool GoProfileBox object.
488 * @return A GoProfileBoundingBoxCornerPoint global angle measurement. (degrees)
489 */
491 
492 /**
493 * Returns a GoProfileBox center point feature object.
494 *
495 * @public @memberof GoProfileBox
496 * @version Introduced in firmware 4.4.4.14
497 * @param tool GoProfileBox object.
498 * @return A GoProfileBoundingBoxCenterPoint center point feature.
499 */
501 
502 /**
503  * @class GoProfileBridgeValue
504  * @extends GoProfileTool
505  * @ingroup GoSdk-ProfileTools
506  * @brief Represents a profile bridge value tool.
507 */
508 typedef GoProfileTool GoProfileBridgeValue;
509 
510 /**
511  * Returns the enabled state of the tool region.
512  *
513  * @public @memberof GoProfileBridgeValue
514  * @version Introduced in firmware 4.3.3.124
515  * @param tool GoProfileBridgeValue object.
516  * @return kTRUE if enabled and kFALSE if disabled.
517  */
518 GoFx(kBool) GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool);
519 
520 /**
521  * Enables or disables the tool region.
522  *
523  * @public @memberof GoProfileBridgeValue
524  * @version Introduced in firmware 4.3.3.124
525  * @param tool GoProfileBridgeValue object.
526  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
527  * @return Operation status.
528  */
529 GoFx(kStatus) GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable);
530 
531 /**
532  * Gets the bridge value profile region.
533  *
534  * @public @memberof GoProfileBridgeValue
535  * @version Introduced in firmware 4.3.3.124
536  * @param tool GoProfileArea object.
537  * @return The profile region.
538  */
539 GoFx(GoProfileRegion) GoProfileBridgeValue_Region(GoProfileBridgeValue tool);
540 
541 
542 /**
543  * Returns the enabled state of normalization.
544  *
545  * @public @memberof GoProfileBridgeValue
546  * @version Introduced in firmware 4.3.3.124
547  * @param tool GoProfileBridgeValue object.
548  * @return kTRUE if enabled and kFALSE if disabled.
549  */
550 GoFx(kBool) GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool);
551 
552 /**
553  * Enables or disables normalization.
554  *
555  * @public @memberof GoProfileBridgeValue
556  * @version Introduced in firmware 4.3.3.124
557  * @param tool GoProfileBridgeValue object.
558  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
559  * @return Operation status.
560  */
561 GoFx(kStatus) GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable);
562 
563 /**
564  * Sets the profile X-Line tool window size percentage.
565  *
566  * @public @memberof GoProfileBridgeValue
567  * @version Introduced in firmware 4.3.3.124
568  * @param tool GoProfileBridgeValue object.
569  * @param value The value to set.
570  * @return Operation status.
571  */
572 GoFx(kStatus) GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value);
573 
574 /**
575  * Gets the profile X-Line tool window size percentage.
576  *
577  * @public @memberof GoProfileBridgeValue
578  * @version Introduced in firmware 4.3.3.124
579  * @param tool GoProfileBridgeValue object.
580  * @return The window size.
581  */
582 GoFx(k64f) GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool);
583 
584 /**
585  * Sets the profile X-Line tool window skip percentage.
586  *
587  * @public @memberof GoProfileBridgeValue
588  * @version Introduced in firmware 4.3.3.124
589  * @param tool GoProfileBridgeValue object.
590  * @param value The value to set.
591  * @return Operation status.
592  */
593 GoFx(kStatus) GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value);
594 
595 /**
596  * Gets the profile X-Line tool window skip percentage.
597  *
598  * @public @memberof GoProfileBridgeValue
599  * @version Introduced in firmware 4.3.3.124
600  * @param tool GoProfileBridgeValue object.
601  * @return The window size.
602  */
603 GoFx(k64f) GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool);
604 
605 /**
606  * Sets the profile X-Line tool max invalid percentage.
607  *
608  * @public @memberof GoProfileBridgeValue
609  * @version Introduced in firmware 4.3.3.124
610  * @param tool GoProfileBridgeValue object.
611  * @param value The value to set.
612  * @return Operation status.
613  */
614 GoFx(kStatus) GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value);
615 
616 /**
617  * Gets the profile X-Line tool max invalid percentage.
618  *
619  * @public @memberof GoProfileBridgeValue
620  * @version Introduced in firmware 4.3.3.124
621  * @param tool GoProfileBridgeValue object.
622  * @return The window size.
623  */
624 GoFx(k64f) GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool);
625 
626 /**
627  * Sets the profile X-Line tool max differential.
628  *
629  * @public @memberof GoProfileBridgeValue
630  * @version Introduced in firmware 4.3.3.124
631  * @param tool GoProfileBridgeValue object.
632  * @param value The value to set.
633  * @return Operation status.
634  */
635 GoFx(kStatus) GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value);
636 
637 /**
638  * Gets the profile X-Line tool max differential.
639  *
640  * @public @memberof GoProfileBridgeValue
641  * @version Introduced in firmware 4.3.3.124
642  * @param tool GoProfileBridgeValue object.
643  * @return The max differential.
644  */
645 GoFx(k64f) GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool);
646 
647 /**
648  * Gets the profile X-Line tool max differential maximum value limit.
649  *
650  * @public @memberof GoProfileBridgeValue
651  * @version Introduced in firmware 4.3.3.124
652  * @param tool GoProfileBridgeValue object.
653  * @return The max differential maximum value limit.
654  */
655 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool);
656 
657 /**
658  * Gets the profile X-Line tool max differential minimum value limit.
659  * NOTE: A value of 0 will result in an automated differential determination.
660  *
661  * @public @memberof GoProfileBridgeValue
662  * @version Introduced in firmware 4.3.3.124
663  * @param tool GoProfileBridgeValue object.
664  * @return The max differential minimum value limit.
665  */
666 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool);
667 
668 /**
669  * Returns a GoProfileBridgeValue bridge value measurement object.
670  *
671  * @public @memberof GoProfileBridgeValue
672  * @version Introduced in firmware 4.3.3.124
673  * @param tool GoProfileBridgeValue object.
674  * @return A GoProfileBridgeValue bridge value measurement.
675  */
677 
678 /**
679  * Returns a GoProfileBridgeValue angle measurement object.
680  *
681  * @public @memberof GoProfileBridgeValue
682  * @version Introduced in firmware 4.3.3.124
683  * @param tool GoProfileBridgeValue object.
684  * @return A GoProfileBridgeValue angle measurement. (degrees)
685  */
687 
688 /**
689 * Returns a GoProfileBridgeValue window measurement object.
690 *
691 * @public @memberof GoProfileBridgeValue
692 * @version Introduced in firmware 4.3.3.124
693 * @param tool GoProfileBridgeValue object.
694 * @return A GoProfileBridgeValue window measurement.
695 */
697 
698 /**
699 * Returns a GoProfileBridgeValue standard deviation measurement object.
700 *
701 * @public @memberof GoProfileBridgeValue
702 * @version Introduced in firmware 4.3.3.124
703 * @param tool GoProfileBridgeValue object.
704 * @return A GoProfileBridgeValue standard deviation measurement.
705 */
707 
708 
709 /**
710  * @class GoProfileCircle
711  * @extends GoProfileTool
712  * @ingroup GoSdk-ProfileTools
713  * @brief Represents a profile circle tool.
714  */
715 typedef GoProfileTool GoProfileCircle;
716 
717 /**
718  * Gets the profile region.
719  *
720  * @public @memberof GoProfileCircle
721  * @version Introduced in firmware 4.0.10.27
722  * @param tool GoProfileCircle object.
723  * @return The profile region.
724  */
725 GoFx(GoProfileRegion) GoProfileCircle_Region(GoProfileCircle tool);
726 
727 /**
728  * Indicates whether the region is enabled.
729  *
730  * @public @memberof GoProfileCircle
731  * @version Introduced in firmware 4.4.4.14
732  * @param tool GoProfileCircle object.
733  * @return kTRUE if enabled and kFALSE otherwise.
734  */
735 GoFx(kBool) GoProfileCircle_RegionEnabled(GoProfileCircle tool);
736 
737 /**
738  * Enables or disables the region.
739  *
740  * @public @memberof GoProfileCircle
741  * @version Introduced in firmware 4.4.4.14
742  * @param tool GoProfileCircle object.
743  * @param enable kTRUE to enable the region and kFALSE to disable it.
744  * @return Operation status.
745  */
746 GoFx(kStatus) GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable);
747 
748 /**
749  * Returns a GoProfileCircle X measurement object.
750  *
751  * @public @memberof GoProfileCircle
752  * @version Introduced in firmware 4.0.10.27
753  * @param tool GoProfileCircle object.
754  * @return A GoProfileCircleX measurement. (mm)
755  */
756 GoFx(GoProfileCircleX) GoProfileCircle_XMeasurement(GoProfileCircle tool);
757 
758 /**
759  * Returns a GoProfileCircle Z measurement object.
760  *
761  * @public @memberof GoProfileCircle
762  * @version Introduced in firmware 4.0.10.27
763  * @param tool GoProfileCircle object.
764  * @return A GoProfileCircleZ measurement. (mm)
765  */
766 GoFx(GoProfileCircleZ) GoProfileCircle_ZMeasurement(GoProfileCircle tool);
767 
768 /**
769  * Returns a GoProfileCircle Radius measurement object.
770  *
771  * @public @memberof GoProfileCircle
772  * @version Introduced in firmware 4.0.10.27
773  * @param tool GoProfileCircle object.
774  * @return A GoProfileCircleRadius Radius measurement.(mm)
775  */
776 GoFx(GoProfileCircleRadius) GoProfileCircle_RadiusMeasurement(GoProfileCircle tool);
777 
778 /**
779  * Returns a GoProfileCircle StdDev measurement object.
780  *
781  * @public @memberof GoProfileCircle
782  * @version Introduced in firmware 5.2.18.3
783  * @param tool GoProfileCircle object.
784  * @return A GoProfileCircleRadius StdDev measurement (mm).
785  */
786 GoFx(GoProfileCircleRadius) GoProfileCircle_StdDevMeasurement(GoProfileCircle tool);
787 
788 /**
789  * Returns a GoProfileCircle Min Error measurement object.
790  *
791  * @public @memberof GoProfileCircle
792  * @version Introduced in firmware 5.2.18.3
793  * @param tool GoProfileCircle object.
794  * @return A GoProfileCircleRadius Min Error measurement (mm).
795  */
797 
798 /**
799  * Returns a GoProfileCircle Min Error X measurement object.
800  *
801  * @public @memberof GoProfileCircle
802  * @version Introduced in firmware 5.2.18.3
803  * @param tool GoProfileCircle object.
804  * @return A GoProfileCircleRadius Min Error X measurement (mm).
805  */
807 
808 /**
809  * Returns a GoProfileCircle Min Error Z measurement object.
810  *
811  * @public @memberof GoProfileCircle
812  * @version Introduced in firmware 5.2.18.3
813  * @param tool GoProfileCircle object.
814  * @return A GoProfileCircleRadius Min Error Z measurement (mm).
815  */
817 
818 /**
819  * Returns a GoProfileCircle Max Error measurement object.
820  *
821  * @public @memberof GoProfileCircle
822  * @version Introduced in firmware 5.2.18.3
823  * @param tool GoProfileCircle object.
824  * @return A GoProfileCircleRadius Max Error measurement (mm).
825  */
827 
828 /**
829  * Returns a GoProfileCircle Max Error X measurement object.
830  *
831  * @public @memberof GoProfileCircle
832  * @version Introduced in firmware 5.2.18.3
833  * @param tool GoProfileCircle object.
834  * @return A GoProfileCircleRadius Max Error X measurement (mm).
835  */
837 
838 /**
839  * Returns a GoProfileCircle Max Error Z measurement object.
840  *
841  * @public @memberof GoProfileCircle
842  * @version Introduced in firmware 5.2.18.3
843  * @param tool GoProfileCircle object.
844  * @return A GoProfileCircleRadius Max Error Z measurement (mm).
845  */
847 
848 
849 /**
850 * Returns a GoProfileCircle center point feature object.
851 *
852 * @public @memberof GoProfileCircle
853 * @version Introduced in firmware 4.0.10.27
854 * @param tool GoProfileCircle object.
855 * @return A GoProfileCircleCenterPoint center point feature .
856 */
857 GoFx(GoProfileCircleCenterPoint) GoProfileCircle_CenterPoint(GoProfileCircle tool);
858 
859 /**
860  * @class GoProfileDim
861  * @extends GoProfileTool
862  * @ingroup GoSdk-ProfileTools
863  * @brief Represents a profile dimension tool.
864  */
865 typedef GoProfileTool GoProfileDim;
866 
867 
868 /**
869  * Gets the reference profile feature.
870  *
871  * @public @memberof GoProfileDim
872  * @version Introduced in firmware 4.0.10.27
873  * @param tool GoProfileDim object.
874  * @return The reference profile feature object.
875  */
876 GoFx(GoProfileFeature) GoProfileDim_RefFeature(GoProfileDim tool);
877 
878 /**
879  * Gets the non-reference profile feature.
880  *
881  * @public @memberof GoProfileDim
882  * @version Introduced in firmware 4.0.10.27
883  * @param tool GoProfileDim object.
884  * @return The profile feature object.
885  */
886 GoFx(GoProfileFeature) GoProfileDim_Feature(GoProfileDim tool);
887 
888 /**
889  * Returns a GoProfileDim Width measurement object.
890  *
891  * @public @memberof GoProfileDim
892  * @version Introduced in firmware 4.0.10.27
893  * @param tool GoProfileDim object.
894  * @return A GoProfileDimWidth measurement.(mm)
895  */
896 GoFx(GoProfileDimWidth) GoProfileDim_WidthMeasurement(GoProfileDim tool);
897 
898 /**
899  * Returns a GoProfileDim Height measurement object.
900  *
901  * @public @memberof GoProfileDim
902  * @version Introduced in firmware 4.0.10.27
903  * @param tool GoProfileDim object.
904  * @return A GoProfileDimHeight measurement.(mm)
905  */
906 GoFx(GoProfileDimHeight) GoProfileDim_HeightMeasurement(GoProfileDim tool);
907 
908 /**
909  * Returns a GoProfileDim Distance measurement object.
910  *
911  * @public @memberof GoProfileDim
912  * @version Introduced in firmware 4.0.10.27
913  * @param tool GoProfileDim object.
914  * @return A GoProfileDimDistance measurement.(mm)
915  */
917 
918 /**
919  * Returns a GoProfileDim Center X measurement object.
920  *
921  * @public @memberof GoProfileDim
922  * @version Introduced in firmware 4.0.10.27
923  * @param tool GoProfileDim object.
924  * @return A GoProfileDimCenterX measurement.
925  */
927 
928 /**
929  * Returns a GoProfileDim Center Z measurement object.
930  *
931  * @public @memberof GoProfileDim
932  * @version Introduced in firmware 4.0.10.27
933  * @param tool GoProfileDim object.
934  * @return A GoProfileDimCenterZ measurement.
935  */
937 
938 /**
939 * Returns a GoProfileDim Center point feature object.
940 *
941 * @public @memberof GoProfileDim
942 * @version Introduced in firmware 4.0.10.27
943 * @param tool GoProfileDim object.
944 * @return A GoProfileDimensionCenterPoint Center point feature.
945 */
947 
948 /**
949  * @class GoProfileGroove
950  * @extends GoProfileTool
951  * @ingroup GoSdk-ProfileTools
952  * @brief Represents a profile groove tool.
953  */
954 typedef GoProfileTool GoProfileGroove;
955 
956 /**
957  * Adds an additional profile groove tool measurement.
958  *
959  * @public @memberof GoProfileGroove
960  * @version Introduced in firmware 4.0.10.27
961  * @param tool GoProfileGroove object.
962  * @param type The measurement type to add. It must be a valid profile groove tool type.
963  * @param measurement A reference to the new GoMeasurement handle. Can be kNULL if you do not wish to do anything immediate with the new measurement.
964  * @return Operation status.
965  */
966 GoFx(kStatus) GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement* measurement);
967 
968 /**
969  * Removes a measurement from the tool at the given index.
970  *
971  * @public @memberof GoProfileGroove
972  * @version Introduced in firmware 4.0.10.27
973  * @param tool GoProfileGroove object.
974  * @param index The index with which to remove a measurement.
975  * @return Operation status.
976  */
977 GoFx(kStatus) GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index);
978 
979 /**
980  * Returns the measurement count for the given tool.
981  *
982  * @public @memberof GoProfileGroove
983  * @version Introduced in firmware 4.0.10.27
984  * @param tool GoProfileGroove object.
985  * @return Tool measurement count.
986  */
987 GoFx(kSize) GoProfileGroove_MeasurementCount(GoProfileGroove tool);
988 
989 /**
990  * Returns a measurement object at the given index.
991  *
992  * @public @memberof GoProfileGroove
993  * @version Introduced in firmware 4.0.10.27
994  * @param tool GoProfileGroove object.
995  * @param index The index with which to return a measurement object.
996  * @return A profile groove tool measurement or kNULL if the index is invalid.
997  */
998 GoFx(GoMeasurement) GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index);
999 
1000 /**
1001  * Gets the current groove determination shape.
1002  *
1003  * @public @memberof GoProfileGroove
1004  * @version Introduced in firmware 4.0.10.27
1005  * @param tool GoProfileGroove object.
1006  * @return The profile groove shape.
1007  */
1008 GoFx(GoProfileGrooveShape) GoProfileGroove_Shape(GoProfileGroove tool);
1009 
1010 /**
1011  * Sets the groove determination shape.
1012  *
1013  * @public @memberof GoProfileGroove
1014  * @version Introduced in firmware 4.0.10.27
1015  * @param tool GoProfileGroove object.
1016  * @param shape The intended profile groove shape.
1017  * @return Operation status.
1018  */
1019 GoFx(kStatus) GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape);
1020 
1021 /**
1022  * Gets the groove depth minimum.
1023  *
1024  * @public @memberof GoProfileGroove
1025  * @version Introduced in firmware 4.0.10.27
1026  * @param tool GoProfileGroove object.
1027  * @return The groove depth minimum value.(mm)
1028  */
1029 GoFx(k64f) GoProfileGroove_MinDepth(GoProfileGroove tool);
1030 
1031 /**
1032  * Sets the groove depth minimum.
1033  *
1034  * @public @memberof GoProfileGroove
1035  * @version Introduced in firmware 4.0.10.27
1036  * @param tool GoProfileGroove object.
1037  * @param depth The minimum groove depth value to set.(mm)
1038  * @return Operation status.
1039  */
1040 GoFx(kStatus) GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth);
1041 
1042 /**
1043  * Gets the groove width maximum.
1044  *
1045  * @public @memberof GoProfileGroove
1046  * @version Introduced in firmware 4.0.10.27
1047  * @param tool GoProfileGroove object.
1048  * @return The groove width maximum value.(mm)
1049  */
1050 GoFx(k64f) GoProfileGroove_MaxWidth(GoProfileGroove tool);
1051 
1052 /**
1053  * Sets the groove width maximum.
1054  *
1055  * @public @memberof GoProfileGroove
1056  * @version Introduced in firmware 4.0.10.27
1057  * @param tool GoProfileGroove object.
1058  * @param width The maximum groove width value to set.(mm)
1059  * @return Operation status.
1060  */
1061 GoFx(kStatus) GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width);
1062 
1063 /**
1064  * Gets the groove width minimum value.
1065  *
1066  * @public @memberof GoProfileGroove
1067  * @version Introduced in firmware 4.0.10.27
1068  * @param tool GoProfileGroove object.
1069  * @return The groove width minimum.(mm)
1070  */
1071 GoFx(k64f) GoProfileGroove_MinWidth(GoProfileGroove tool);
1072 
1073 /**
1074  * Sets the groove width minimum.
1075  *
1076  * @public @memberof GoProfileGroove
1077  * @version Introduced in firmware 4.0.10.27
1078  * @param tool GoProfileGroove object.
1079  * @param width The minimum groove width value to set.(mm)
1080  * @return Operation status.
1081  */
1082 GoFx(kStatus) GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width);
1083 
1084 /**
1085  * Gets the profile region.
1086  *
1087  * @public @memberof GoProfileGroove
1088  * @version Introduced in firmware 4.0.10.27
1089  * @param tool GoProfileGroove object.
1090  * @return The profile region.
1091  */
1092 GoFx(GoProfileRegion) GoProfileGroove_Region(GoProfileGroove tool);
1093 
1094 /**
1095  * Indicates whether the region is enabled.
1096  *
1097  * @public @memberof GoProfileGroove
1098  * @version Introduced in firmware 4.4.4.14
1099  * @param tool GoProfileGroove object.
1100  * @return kTRUE if enabled and kFALSE otherwise.
1101  */
1102 GoFx(kBool) GoProfileGroove_RegionEnabled(GoProfileGroove tool);
1103 
1104 /**
1105  * Enables or disables the region.
1106  *
1107  * @public @memberof GoProfileGroove
1108  * @version Introduced in firmware 4.4.4.14
1109  * @param tool GoProfileGroove object.
1110  * @param enable kTRUE to enable the region and kFALSE to disable it.
1111  * @return Operation status.
1112  */
1113 GoFx(kStatus) GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable);
1114 
1115 
1116 /**
1117  * @class GoProfileIntersect
1118  * @extends GoProfileTool
1119  * @ingroup GoSdk-ProfileTools
1120  * @brief Represents a profile intersect tool.
1121  */
1122 typedef GoProfileTool GoProfileIntersect;
1123 
1124 
1125 /**
1126  * Gets the reference profile line type.
1127  *
1128  * @public @memberof GoProfileIntersect
1129  * @version Introduced in firmware 4.0.10.27
1130  * @param tool GoProfileIntersect object.
1131  * @return The profile line type.
1132  */
1133 GoFx(GoProfileBaseline) GoProfileIntersect_RefLineType(GoProfileIntersect tool);
1134 
1135 /**
1136  * Sets the reference line type.
1137  *
1138  * @public @memberof GoProfileIntersect
1139  * @version Introduced in firmware 4.0.10.27
1140  * @param tool GoProfileIntersect object.
1141  * @param type The line type to set.
1142  * @return
1143  */
1144 GoFx(kStatus) GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type);
1145 
1146 /**
1147  * Gets the reference profile line.
1148  *
1149  * @public @memberof GoProfileIntersect
1150  * @version Introduced in firmware 4.0.10.27
1151  * @param tool GoProfileIntersect object.
1152  * @return The reference profile line.
1153  */
1154 GoFx(GoProfileLineRegion) GoProfileIntersect_RefLine(GoProfileIntersect tool);
1155 
1156 /**
1157  * Gets the non-reference profile line.
1158  *
1159  * @public @memberof GoProfileIntersect
1160  * @version Introduced in firmware 4.0.10.27
1161  * @param tool GoProfileIntersect object.
1162  * @return The non-reference profile line.
1163  */
1164 GoFx(GoProfileLineRegion) GoProfileIntersect_Line(GoProfileIntersect tool);
1165 
1166 /**
1167  * Returns a GoProfileIntersect X measurement object.
1168  *
1169  * @public @memberof GoProfileIntersect
1170  * @version Introduced in firmware 4.0.10.27
1171  * @param tool GoProfileIntersect object.
1172  * @return A GoProfileIntersect X measurement. (mm)
1173  */
1174 GoFx(GoProfileIntersectX) GoProfileIntersect_XMeasurement(GoProfileIntersect tool);
1175 
1176 /**
1177  * Returns a GoProfileIntersect Z measurement object.
1178  *
1179  * @public @memberof GoProfileIntersect
1180  * @version Introduced in firmware 4.0.10.27
1181  * @param tool GoProfileIntersect object.
1182  * @return A GoProfileIntersect Z measurement.(mm)
1183  */
1184 GoFx(GoProfileIntersectZ) GoProfileIntersect_ZMeasurement(GoProfileIntersect tool);
1185 
1186 /**
1187  * Returns a GoProfileIntersect Angle measurement object.
1188  *
1189  * @public @memberof GoProfileIntersect
1190  * @version Introduced in firmware 4.0.10.27
1191  * @param tool GoProfileIntersect object.
1192  * @return A GoProfileIntersect Angle measurement.(degrees)
1193  */
1194 GoFx(GoProfileIntersectAngle) GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool);
1195 
1196 /**
1197 * Returns a GoProfileIntersect Angle measurement object.
1198 *
1199 * @public @memberof GoProfileIntersect
1200 * @version Introduced in firmware 4.0.10.27
1201 * @param tool GoProfileIntersect object.
1202 * @return A GoProfileIntersect Angle measurement.(degrees)
1203 */
1205 
1206 /**
1207 * Returns a GoProfileIntersectLine Feature object.
1208 *
1209 * @public @memberof GoProfileIntersect
1210 * @version Introduced in firmware 4.6.4.10
1211 * @param tool GoProfileIntersect object.
1212 * @return A GoProfileIntersectLine feature object.
1213 */
1214 GoFx(GoProfileIntersectLine) GoProfileIntersect_LineFeature(GoProfileIntersect tool);
1215 
1216 /**
1217 * Returns a GoProfileIntersectBaseLine Feature object.
1218 *
1219 * @public @memberof GoProfileIntersect
1220 * @version Introduced in firmware 4.6.4.10
1221 * @param tool GoProfileIntersect object.
1222 * @return A GoProfileIntersectBaseLine feature object.
1223 */
1224 GoFx(GoProfileIntersectBaseLine) GoProfileIntersect_BaseLineFeature(GoProfileIntersect tool);
1225 
1226 
1227 /**
1228  * @class GoProfileLine
1229  * @extends GoProfileTool
1230  * @ingroup GoSdk-ProfileTools
1231  * @brief Represents a profile line tool.
1232  */
1233 typedef GoProfileTool GoProfileLine;
1234 
1235 /**
1236  * Gets the measurement region.
1237  *
1238  * @public @memberof GoProfileDev
1239  * @version Introduced in firmware 4.0.10.27
1240  * @param tool GoProfileDev object.
1241  * @return The profile Line Measurement region.
1242  */
1243 GoFx(GoProfileRegion) GoProfileLine_Region(GoProfileLine tool);
1244 
1245 /**
1246  * Indicates whether the region is enabled.
1247  *
1248  * @public @memberof GoProfileLine
1249  * @version Introduced in firmware 4.4.4.14
1250  * @param tool GoProfileLine object.
1251  * @return kTRUE if enabled and kFALSE otherwise.
1252  */
1253 GoFx(kBool) GoProfileLine_RegionEnabled(GoProfileLine tool);
1254 
1255 /**
1256  * Enables or disables the region.
1257  *
1258  * @public @memberof GoProfileLine
1259  * @version Introduced in firmware 4.4.4.14
1260  * @param tool GoProfileLine object.
1261  * @param enable kTRUE to enable the region and kFALSE to disable it.
1262  * @return Operation status.
1263  */
1264 GoFx(kStatus) GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable);
1265 
1266 /**
1267 * Gets the fitting regions.
1268 *
1269 * @public @memberof GoProfileDev
1270 * @version Introduced in firmware 4.6.0.95
1271 * @param tool GoProfileLine object.
1272 * @return The profile Line fitting regions.
1273 */
1274 GoFx(GoProfileLineRegion) GoProfileLine_FittingRegions(GoProfileLine tool);
1275 
1276 /**
1277 * Indicates whether the fitting regions are enabled.
1278 *
1279 * @public @memberof GoProfileLine
1280 * @version Introduced in firmware 4.6.0.147
1281 * @param tool GoProfileLine object.
1282 * @return kTRUE if enabled and kFALSE otherwise.
1283 */
1284 GoFx(kBool) GoProfileLine_FittingRegionsEnabled(GoProfileLine tool);
1285 
1286 /**
1287 * Enables or disables the fitting regions.
1288 *
1289 * @public @memberof GoProfileLine
1290 * @version Introduced in firmware 4.6.0.147
1291 * @param tool GoProfileLine object.
1292 * @param enable Boolean enable or disable fitting regions.
1293 * @return kTRUE if enabled and kFALSE otherwise.
1294 */
1295 GoFx(kStatus) GoProfileLine_EnableFittingRegions(GoProfileLine tool, kBool enable);
1296 
1297 /**
1298  * Returns a GoProfileLine Standard Deviation measurement object.
1299  *
1300  * @public @memberof GoProfileLine
1301  * @version Introduced in firmware 4.0.10.27
1302  * @param tool GoProfileLine object.
1303  * @return A GoProfileLine Standard Deviation measurement.
1304  */
1305 GoFx(GoProfileLineStdDev) GoProfileLine_StdDevMeasurement(GoProfileLine tool);
1306 
1307 /**
1308  * Returns a GoProfileLine Maximum Error measurement object.
1309  *
1310  * @public @memberof GoProfileLine
1311  * @version Introduced in firmware 4.0.10.27
1312  * @param tool GoProfileLine object.
1313  * @return A GoProfileLine Maximum Error measurement.
1314  */
1316 
1317 /**
1318  * Returns a GoProfileLine Minimum Error measurement object.
1319  *
1320  * @public @memberof GoProfileLine
1321  * @version Introduced in firmware 4.0.10.27
1322  * @param tool GoProfileLine object.
1323  * @return A GoProfileLine Minimum Error measurement.
1324  */
1326 
1327 /**
1328  * Returns a GoProfileLine Percentile measurement object.
1329  *
1330  * @public @memberof GoProfileLine
1331  * @version Introduced in firmware 4.0.10.27
1332  * @param tool GoProfileLine object.
1333  * @return A GoProfileLine Percentile measurement.
1334  */
1336 
1337 /**
1338  * Returns a GoProfileLine Offset measurement object.
1339  *
1340  * @public @memberof GoProfileLine
1341  * @version Introduced in firmware 4.6.0.49
1342  * @param tool GoProfileLine object.
1343  * @return A GoProfileLine Offset measurement.
1344  */
1345 GoFx(GoProfileLineOffset) GoProfileLine_OffsetMeasurement(GoProfileLine tool);
1346 
1347 /**
1348  * Returns a GoProfileLine Angle measurement object.
1349  *
1350  * @public @memberof GoProfileLine
1351  * @version Introduced in firmware 4.6.0.49
1352  * @param tool GoProfileLine object.
1353  * @return A GoProfileLine Angle measurement.
1354  */
1355 GoFx(GoProfileLineAngle) GoProfileLine_AngleMeasurement(GoProfileLine tool);
1356 
1357 /**
1358  * Returns a GoProfileLine Minimum X Error measurement object.
1359  *
1360  * @public @memberof GoProfileLine
1361  * @version Introduced in firmware 4.6.0.49
1362  * @param tool GoProfileLine object.
1363  * @return A GoProfileLine Minimum X Error measurement.
1364  */
1366 
1367 /**
1368  * Returns a GoProfileLine Minimum Z Error measurement object.
1369  *
1370  * @public @memberof GoProfileLine
1371  * @version Introduced in firmware 4.6.0.49
1372  * @param tool GoProfileLine object.
1373  * @return A GoProfileLine Minimum Z Error measurement.
1374  */
1376 
1377 /**
1378  * Returns a GoProfileLine Maximum X Error measurement object.
1379  *
1380  * @public @memberof GoProfileLine
1381  * @version Introduced in firmware 4.6.0.49
1382  * @param tool GoProfileLine object.
1383  * @return A GoProfileLine Maximum X Error measurement.
1384  */
1386 
1387 /**
1388  * Returns a GoProfileLine Maximum Z Error measurement object.
1389  *
1390  * @public @memberof GoProfileLine
1391  * @version Introduced in firmware 4.6.0.49
1392  * @param tool GoProfileLine object.
1393  * @return A GoProfileLine Maximum Z Error measurement.
1394  */
1396 
1397 /**
1398 * Returns a GoProfileLine line feature object.
1399 *
1400 * @public @memberof GoProfileLine
1401 * @version Introduced in firmware 4.6.0.49
1402 * @param tool GoProfileLine object.
1403 * @return A GoProfileLineLine line feature.
1404 */
1405 GoFx(GoProfileLineLine) GoProfileLine_Line(GoProfileLine tool);
1406 
1407 /**
1408 * Returns a GoProfileLine Maximum Z Error measurement object.
1409 *
1410 * @public @memberof GoProfileLine
1411 * @version Introduced in firmware 4.6.0.49
1412 * @param tool GoProfileLineMinErrorPoint object.
1413 * @return A GoProfileLineMinErrorPoint min error point feature.
1414 */
1416 
1417 /**
1418 * Returns a GoProfileLine min error point feature object.
1419 *
1420 * @public @memberof GoProfileLine
1421 * @version Introduced in firmware 4.6.0.49
1422 * @param tool GoProfileLineMaxErrorPoint object.
1423 * @return A GoProfileLineMaxErrorPoint min error point feature.
1424 */
1426 
1427 /**
1428  * @class GoProfilePanel
1429  * @extends GoProfileTool
1430  * @ingroup GoSdk-ProfileTools
1431  * @brief Represents a profile panel tool.
1432  */
1433 typedef GoProfileTool GoProfilePanel;
1434 
1435 /**
1436  * Gets the maximum gap width.
1437  *
1438  * @public @memberof GoProfilePanel
1439  * @version Introduced in firmware 4.0.10.27
1440  * @param tool GoProfilePanel object.
1441  * @return The maximum gap width.(mm)
1442  */
1443 GoFx(k64f) GoProfilePanel_MaxGapWidth(GoProfilePanel tool);
1444 
1445 /**
1446  * Sets the maximum gap width.
1447  *
1448  * @public @memberof GoProfilePanel
1449  * @version Introduced in firmware 4.0.10.27
1450  * @param tool GoProfilePanel object.
1451  * @param width The maximum gap width value to set.(mm)
1452  * @return Operation status.
1453  */
1454 GoFx(kStatus) GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width);
1455 
1456 /**
1457  * Gets the reference edge side.
1458  *
1459  * @public @memberof GoProfilePanel
1460  * @version Introduced in firmware 4.0.10.27
1461  * @param tool GoProfilePanel object.
1462  * @return The reference edge side.
1463  */
1464 GoFx(GoProfilePanelSide) GoProfilePanel_RefEdgeSide(GoProfilePanel tool);
1465 
1466 /**
1467  * Sets the reference edge side.
1468  *
1469  * @public @memberof GoProfilePanel
1470  * @version Introduced in firmware 4.0.10.27
1471  * @param tool GoProfilePanel object.
1472  * @param side The reference edge side.
1473  * @return Operation status.
1474  */
1475 GoFx(kStatus) GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side);
1476 
1477 /**
1478  * Gets the left profile edge.
1479  *
1480  * @public @memberof GoProfilePanel
1481  * @version Introduced in firmware 4.0.10.27
1482  * @param tool GoProfilePanel object.
1483  * @return The left profile edge.
1484  */
1485 GoFx(GoProfileEdge) GoProfilePanel_LeftEdge(GoProfilePanel tool);
1486 
1487 /**
1488  * Gets the right profile edge.
1489  *
1490  * @public @memberof GoProfilePanel
1491  * @version Introduced in firmware 4.0.10.27
1492  * @param tool GoProfilePanel object.
1493  * @return The right profile edge.
1494  */
1495 GoFx(GoProfileEdge) GoProfilePanel_RightEdge(GoProfilePanel tool);
1496 
1497 /**
1498  * Returns a GoProfilePanel Gap measurement object.
1499  *
1500  * @public @memberof GoProfilePanel
1501  * @version Introduced in firmware 4.0.10.27
1502  * @param tool GoProfilePanel object.
1503  * @return A GoProfilePanel Gap measurement.
1504  */
1505 GoFx(GoProfilePanelGap) GoProfilePanel_GapMeasurement(GoProfilePanel tool);
1506 
1507 /**
1508  * Returns a GoProfilePanel Flush measurement object.
1509  *
1510  * @public @memberof GoProfilePanel
1511  * @version Introduced in firmware 4.0.10.27
1512  * @param tool GoProfilePanel object.
1513  * @return A GoProfilePanel Flush measurement.
1514  */
1515 GoFx(GoProfilePanelFlush) GoProfilePanel_FlushMeasurement(GoProfilePanel tool);
1516 
1517 /**
1518 * Returns a GoProfilePanel Left Gap X measurement object.
1519 *
1520 * @public @memberof GoProfilePanel
1521 * @version Introduced in firmware 4.0.10.27
1522 * @param tool GoProfilePanel object.
1523 * @return A GoProfilePanel Left Gap X measurement.
1524 */
1526 
1527 /**
1528 * Returns a GoProfilePanel Left Gap Z measurement object.
1529 *
1530 * @public @memberof GoProfilePanel
1531 * @version Introduced in firmware 4.0.10.27
1532 * @param tool GoProfilePanel object.
1533 * @return A GoProfilePanel Left Gap Z measurement.
1534 */
1536 
1537 /**
1538 * Returns a GoProfilePanel Left Flush X measurement object.
1539 *
1540 * @public @memberof GoProfilePanel
1541 * @version Introduced in firmware 4.0.10.27
1542 * @param tool GoProfilePanel object.
1543 * @return A GoProfilePanel Left Flush X measurement.
1544 */
1546 
1547 /**
1548 * Returns a GoProfilePanel Left Flush Z measurement object.
1549 *
1550 * @public @memberof GoProfilePanel
1551 * @version Introduced in firmware 4.0.10.27
1552 * @param tool GoProfilePanel object.
1553 * @return A GoProfilePanel Left Flush Z measurement.
1554 */
1556 
1557 /**
1558 * Returns a GoProfilePanel Left Surface Angle measurement object.
1559 *
1560 * @public @memberof GoProfilePanel
1561 * @version Introduced in firmware 4.0.10.27
1562 * @param tool GoProfilePanel object.
1563 * @return A GoProfilePanel Left Surface Angle measurement.
1564 */
1566 
1567 /**
1568 * Returns a GoProfilePanel Right Gap X measurement object.
1569 *
1570 * @public @memberof GoProfilePanel
1571 * @version Introduced in firmware 4.0.10.27
1572 * @param tool GoProfilePanel object.
1573 * @return A GoProfilePanel Right Gap X measurement.
1574 */
1576 
1577 /**
1578 * Returns a GoProfilePanel Right Gap Z measurement object.
1579 *
1580 * @public @memberof GoProfilePanel
1581 * @version Introduced in firmware 4.0.10.27
1582 * @param tool GoProfilePanel object.
1583 * @return A GoProfilePanel Right Gap Z measurement.
1584 */
1586 
1587 /**
1588 * Returns a GoProfilePanel Right Flush Z measurement object.
1589 *
1590 * @public @memberof GoProfilePanel
1591 * @version Introduced in firmware 4.0.10.27
1592 * @param tool GoProfilePanel object.
1593 * @return A GoProfilePanel Right Flush Z measurement.
1594 */
1596 
1597 /**
1598 * Returns a GoProfilePanel Right Surface Angle measurement object.
1599 *
1600 * @public @memberof GoProfilePanel
1601 * @version Introduced in firmware 4.0.10.27
1602 * @param tool GoProfilePanel object.
1603 * @return A GoProfilePanel Right Surface Angle measurement.
1604 */
1606 
1607 /**
1608  * @class GoProfilePosition
1609  * @extends GoProfileTool
1610  * @ingroup GoSdk-ProfileTools
1611  * @brief Represents a profile position tool.
1612  */
1613 typedef GoProfileTool GoProfilePosition;
1614 
1615 /**
1616 * Indicates whether the region is enabled.
1617 *
1618 * @public @memberof GoProfilePosition
1619  * @version Introduced in firmware 4.8.2.76
1620 * @param tool GoProfilePosition object.
1621 * @return kTRUE if enabled and kFALSE otherwise.
1622 */
1623 GoFx(kBool) GoProfilePosition_RegionEnabled(GoProfilePosition tool);
1624 
1625 /**
1626 * Enables or disables the region.
1627 *
1628 * @public @memberof GoProfilePosition
1629  * @version Introduced in firmware 4.8.2.76
1630 * @param tool GoProfilePosition object.
1631 * @param enable kTRUE to enable the region and kFALSE to disable it.
1632 * @return Operation status.
1633 */
1634 GoFx(kStatus) GoProfilePosition_EnableRegion(GoProfilePosition tool, kBool enable);
1635 /**
1636  * Gets the profile feature.
1637  *
1638  * @public @memberof GoProfilePosition
1639  * @version Introduced in firmware 4.0.10.27
1640  * @param tool GoProfilePos object.
1641  * @return The profile feature.
1642  */
1643 GoFx(GoProfileFeature) GoProfilePosition_Feature(GoProfilePosition tool);
1644 
1645 /**
1646  * Returns a GoProfilePosition X measurement object.
1647  *
1648  * @public @memberof GoProfilePosition
1649  * @version Introduced in firmware 4.0.10.27
1650  * @param tool GoProfilePosition object.
1651  * @return A GoProfilePosition X measurement.(mm)
1652  */
1653 GoFx(GoProfilePositionX) GoProfilePosition_XMeasurement(GoProfilePosition tool);
1654 
1655 /**
1656  * Returns a GoProfilePosition Z measurement object.
1657  *
1658  * @public @memberof GoProfilePosition
1659  * @version Introduced in firmware 4.0.10.27
1660  * @param tool GoProfilePosition object.
1661  * @return A GoProfilePosition Z measurement.(mm)
1662  */
1663 GoFx(GoProfilePositionZ) GoProfilePosition_ZMeasurement(GoProfilePosition tool);
1664 
1665 /**
1666 * Returns a GoProfilePosition point feature object.
1667 *
1668 * @public @memberof GoProfilePosition
1669 * @version Introduced in firmware 4.0.10.27
1670 * @param tool GoProfilePosition object.
1671 * @return A GoProfilePosition point feature.
1672 */
1673 GoFx(GoProfilePositionPoint) GoProfilePosition_Point(GoProfilePosition tool);
1674 
1675 /**
1676  * @class GoProfileStrip
1677  * @extends GoProfileTool
1678  * @ingroup GoSdk-ProfileTools
1679  * @brief Represents a profile strip tool.
1680  */
1681 typedef GoProfileTool GoProfileStrip;
1682 
1683 /**
1684  * Sets the strip base type.
1685  *
1686  * @public @memberof GoProfileStrip
1687  * @version Introduced in firmware 4.0.10.27
1688  * @param tool GoProfileStrip object.
1689  * @param type The strip base type.
1690  * @return Operation status.
1691  */
1692 GoFx(kStatus) GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type);
1693 
1694 /**
1695  * Gets the strip base type.
1696  *
1697  * @public @memberof GoProfileStrip
1698  * @version Introduced in firmware 4.0.10.27
1699  * @param tool GoProfileStrip object.
1700  * @return The strip base type.
1701  */
1702 GoFx(GoProfileStripBaseType) GoProfileStrip_BaseType(GoProfileStrip tool);
1703 
1704 /**
1705  * Gets the left edge value.
1706  *
1707  * @public @memberof GoProfileStrip
1708  * @version Introduced in firmware 4.0.10.27
1709  * @param tool GoProfileStrip object.
1710  * @return The left edge value.
1711  */
1712 GoFx(GoProfileStripEdgeType) GoProfileStrip_LeftEdge(GoProfileStrip tool);
1713 
1714 /**
1715  * Sets the left edge.
1716  *
1717  * @public @memberof GoProfileStrip
1718  * @version Introduced in firmware 4.0.10.27
1719  * @param tool GoProfileStrip object.
1720  * @param leftEdge Left edge value.
1721  * @return Operation status.
1722  */
1723 GoFx(kStatus) GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge);
1724 
1725 /**
1726  * Gets the right edge value.
1727  *
1728  * @public @memberof GoProfileStrip
1729  * @version Introduced in firmware 4.0.10.27
1730  * @param tool GoProfileStrip object.
1731  * @return The right edge value.
1732  */
1733 GoFx(GoProfileStripEdgeType) GoProfileStrip_RightEdge(GoProfileStrip tool);
1734 
1735 /**
1736  * Sets the right edge.
1737  *
1738  * @public @memberof GoProfileStrip
1739  * @version Introduced in firmware 4.0.10.27
1740  * @param tool GoProfileStrip object.
1741  * @param rightEdge Right edge value.
1742  * @return Operation status.
1743  */
1744 GoFx(kStatus) GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge);
1745 
1746 /**
1747  * Gets the tilt enabled state.
1748  *
1749  * @public @memberof GoProfileStrip
1750  * @version Introduced in firmware 4.0.10.27
1751  * @param tool GoProfileStrip object.
1752  * @return kTRUE if tilt is enabled, kFALSE otherwise.
1753  */
1754 GoFx(kBool) GoProfileStrip_TiltEnabled(GoProfileStrip tool);
1755 
1756 /**
1757  * Enables or disables tilt.
1758  *
1759  * @public @memberof GoProfileStrip
1760  * @version Introduced in firmware 4.0.10.27
1761  * @param tool GoProfileStrip object.
1762  * @param enable kTRUE to enable tilt, kFALSE to disable it.
1763  * @return Operation status.
1764  */
1765 GoFx(kStatus) GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable);
1766 
1767 
1768 /**
1769  * Gets the support width.
1770  *
1771  * @public @memberof GoProfileStrip
1772  * @version Introduced in firmware 4.5.3.57
1773  * @param tool GoProfileStrip object.
1774  * @return The support width (in mm).
1775  */
1776 GoFx(k64f) GoProfileStrip_SupportWidth(GoProfileStrip tool);
1777 
1778 /**
1779  * Sets the support width.
1780  *
1781  * @public @memberof GoProfileStrip
1782  * @version Introduced in firmware 4.5.3.57
1783  * @param tool GoProfileStrip object.
1784  * @param value The support width (in mm).
1785  * @return Operation status.
1786  */
1787 GoFx(kStatus) GoProfileStrip_SetSupportWidth(GoProfileStrip tool, k64f value);
1788 
1789 
1790 /**
1791  * Gets the transition width limit minimum.
1792  *
1793  * @public @memberof GoProfileStrip
1794  * @version Introduced in firmware 4.5.3.57
1795  * @param tool GoProfileStrip object.
1796  * @return The minimum permissible transition width (in mm).
1797  */
1798 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMin(GoProfileStrip tool);
1799 
1800 /**
1801  * Gets the transition width limit maximum.
1802  *
1803  * @public @memberof GoProfileStrip
1804  * @version Introduced in firmware 4.5.3.57
1805  * @param tool GoProfileStrip object.
1806  * @return The maximum permissible transition width (in mm).
1807  */
1808 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMax(GoProfileStrip tool);
1809 
1810 /**
1811  * Gets the transition width.
1812  *
1813  * @public @memberof GoProfileStrip
1814  * @version Introduced in firmware 4.0.10.27
1815  * @param tool GoProfileStrip object.
1816  * @return The transition width (in mm).
1817  */
1818 GoFx(k64f) GoProfileStrip_TransitionWidth(GoProfileStrip tool);
1819 
1820 /**
1821  * Sets the transition width.
1822  *
1823  * @public @memberof GoProfileStrip
1824  * @version Introduced in firmware 4.0.10.27
1825  * @param tool GoProfileStrip object.
1826  * @param value The transition width (in mm).
1827  * @return Operation status.
1828  */
1829 GoFx(kStatus) GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value);
1830 
1831 /**
1832  * Gets the minimum width.
1833  *
1834  * @public @memberof GoProfileStrip
1835  * @version Introduced in firmware 4.0.10.27
1836  * @param tool GoProfileStrip object.
1837  * @return The minimum width (in mm).
1838  */
1839 GoFx(k64f) GoProfileStrip_MinWidth(GoProfileStrip tool);
1840 
1841 /**
1842  * Sets the minimum width.
1843  *
1844  * @public @memberof GoProfileStrip
1845  * @version Introduced in firmware 4.0.10.27
1846  * @param tool GoProfileStrip object.
1847  * @param value The minimum width (in mm).
1848  * @return Operation status.
1849  */
1850 GoFx(kStatus) GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value);
1851 
1852 /**
1853  * Gets the minimum height.
1854  *
1855  * @public @memberof GoProfileStrip
1856  * @version Introduced in firmware 4.0.10.27
1857  * @param tool GoProfileStrip object.
1858  * @return The minimum height (in mm).
1859  */
1860 GoFx(k64f) GoProfileStrip_MinHeight(GoProfileStrip tool);
1861 
1862 /**
1863  * Sets the transition height.
1864  *
1865  * @public @memberof GoProfileStrip
1866  * @version Introduced in firmware 4.0.10.27
1867  * @param tool GoProfileStrip object.
1868  * @param value The minimum height (in mm).
1869  * @return Operation status.
1870  */
1871 GoFx(kStatus) GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value);
1872 
1873 /**
1874  * Gets the maximum void width.
1875  *
1876  * @public @memberof GoProfileStrip
1877  * @version Introduced in firmware 4.0.10.27
1878  * @param tool GoProfileStrip object.
1879  * @return The maximum void width (in mm).
1880  */
1881 GoFx(k64f) GoProfileStrip_MaxVoidWidth(GoProfileStrip tool);
1882 
1883 /**
1884  * Sets the maximum void width.
1885  *
1886  * @public @memberof GoProfileStrip
1887  * @version Introduced in firmware 4.0.10.27
1888  * @param tool GoProfileStrip object.
1889  * @param value The maximum void width (in mm).
1890  * @return Operation status.
1891  */
1892 GoFx(kStatus) GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value);
1893 
1894 /**
1895  * Gets the profile strip tool region.
1896  *
1897  * @public @memberof GoProfileStrip
1898  * @version Introduced in firmware 4.0.10.27
1899  * @param tool GoProfileStrip object.
1900  * @return A GoProfileRegion object.
1901  */
1902 GoFx(GoProfileRegion) GoProfileStrip_Region(GoProfileStrip tool);
1903 
1904 /**
1905  * Indicates whether the region is enabled.
1906  *
1907  * @public @memberof GoProfileStrip
1908  * @version Introduced in firmware 4.4.4.14
1909  * @param tool GoProfileStrip object.
1910  * @return kTRUE if enabled and kFALSE otherwise.
1911  */
1912 GoFx(kBool) GoProfileStrip_RegionEnabled(GoProfileStrip tool);
1913 
1914 /**
1915  * Enables or disables the region.
1916  *
1917  * @public @memberof GoProfileStrip
1918  * @version Introduced in firmware 4.4.4.14
1919  * @param tool GoProfileStrip object.
1920  * @param enable kTRUE to enable the region and kFALSE to disable it.
1921  * @return Operation status.
1922  */
1923 GoFx(kStatus) GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable);
1924 
1925 /**
1926  * Adds an additional profile strip tool measurement.
1927  *
1928  * @public @memberof GoProfileStrip
1929  * @version Introduced in firmware 4.0.10.27
1930  * @param tool GoProfileStrip object.
1931  * @param type The measurement type to add. It must be a valid profile strip tool type.
1932  * @param measurement A reference to the new GoMeasurement handle. Can be kNULL if you do not wish to do anything immediate with the new measurement.
1933  * @return Operation status.
1934  */
1935 GoFx(kStatus) GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement* measurement);
1936 
1937 /**
1938  * Removes a measurement from the tool at the given index.
1939  *
1940  * @public @memberof GoProfileStrip
1941  * @version Introduced in firmware 4.0.10.27
1942  * @param tool GoProfileStrip object.
1943  * @param index The index with which to remove a measurement.
1944  * @return Operation status.
1945  */
1946 GoFx(kStatus) GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index);
1947 
1948 /**
1949  * Returns the measurement count for the given tool.
1950  *
1951  * @public @memberof GoProfileStrip
1952  * @version Introduced in firmware 4.0.10.27
1953  * @param tool GoProfileStrip object.
1954  * @return Tool measurement count.
1955  */
1956 GoFx(kSize) GoProfileStrip_MeasurementCount(GoProfileStrip tool);
1957 
1958 /**
1959  * Returns a measurement object at the given index.
1960  *
1961  * @public @memberof GoProfileStrip
1962  * @version Introduced in firmware 4.0.10.27
1963  * @param tool GoProfileStrip object.
1964  * @param index The index with which to return a measurement object.
1965  * @return A profile strip tool measurement or kNULL if the index is invalid.
1966  */
1967 GoFx(GoMeasurement) GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index);
1968 
1969 
1970 /**
1971  * @class GoProfileXLine
1972  * @extends GoProfileTool
1973  * @ingroup GoSdk-ProfileTools
1974  * @brief Represents a profile X-Line tool.
1975 */
1976 typedef GoProfileTool GoProfileXLine;
1977 
1978 /**
1979  * Returns the enabled state of the tool region.
1980  *
1981  * @public @memberof GoProfileXLine
1982  * @version Introduced in firmware 4.3.3.124
1983  * @param tool GoProfileXLine object.
1984  * @return kTRUE if enabled and kFALSE if disabled.
1985  */
1986 GoFx(kBool) GoProfileXLine_RegionEnabled(GoProfileXLine tool);
1987 
1988 /**
1989  * Enables or disables the tool region.
1990  *
1991  * @public @memberof GoProfileXLine
1992  * @version Introduced in firmware 4.3.3.124
1993  * @param tool GoProfileXLine object.
1994  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
1995  * @return Operation status.
1996  */
1997 GoFx(kStatus) GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable);
1998 
1999 /**
2000  * Gets the profile X-Line tool region.
2001  *
2002  * @public @memberof GoProfileXLine
2003  * @version Introduced in firmware 4.3.3.124
2004  * @param tool GoProfileXLine object.
2005  * @return A GoRegion3d object.
2006  */
2007 GoFx(GoProfileRegion) GoProfileXLine_Region(GoProfileXLine tool);
2008 
2009 /**
2010  * Sets the profile X-Line tool maximum tracking speed.
2011  *
2012  * @public @memberof GoProfileXLine
2013  * @version Introduced in firmware 4.3.3.124
2014  * @param tool GoProfileXLine object.
2015  * @param value The value to set.
2016  * @return Operation status.
2017  */
2018 GoFx(kStatus) GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value);
2019 
2020 /**
2021  * Gets the profile X-Line tool maximum tracking speed.
2022  *
2023  * @public @memberof GoProfileXLine
2024  * @version Introduced in firmware 4.3.3.124
2025  * @param tool GoProfileXLine object.
2026  * @return The maximum tracking speed.(mm/s)
2027  */
2028 GoFx(k64f) GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool);
2029 
2030 /**
2031  * Returns a GoProfileXLine Z measurement object.
2032  *
2033  * @public @memberof GoProfileXLine
2034  * @version Introduced in firmware 4.3.3.124
2035  * @param tool GoProfileXLine object.
2036  * @return A GoProfileXLine Z measurement. (mm)
2037  */
2038 GoFx(GoProfileXLineZ) GoProfileXLine_ZMeasurement(GoProfileXLine tool);
2039 
2040 /**
2041  * Returns a GoProfileXLine Validity measurement object.
2042  *
2043  * @public @memberof GoProfileXLine
2044  * @version Introduced in firmware 4.3.3.124
2045  * @param tool GoProfileXLine object.
2046  * @return A GoProfileXLine Validity measurement.
2047  */
2048 GoFx(GoProfileXLineZ) GoProfileXLine_ValidityMeasurement(GoProfileXLine tool);
2049 
2050 
2051 
2052 /**
2053  * @class GoProfileRoundCorner
2054  * @extends GoProfileTool
2055  * @ingroup GoSdk-ProfileTools
2056  * @brief Represents a profile round corner tool.
2057  */
2058 typedef GoProfileTool GoProfileRoundCorner;
2059 
2060 /**
2061  * Returns a GoProfileRoundCorner X measurement object.
2062  *
2063  * @public @memberof GoProfileRoundCorner
2064  * @version Introduced in firmware 4.0.10.27
2065  * @param tool GoProfileRoundCorner object.
2066  * @return A GoProfileRoundCorner X measurement.(mm)
2067  */
2068 GoFx(GoProfileRoundCornerX) GoProfileRoundCorner_XMeasurement(GoProfileRoundCorner tool);
2069 
2070 /**
2071  * Returns a GoProfileRoundCorner Z measurement object.
2072  *
2073  * @public @memberof GoProfileRoundCorner
2074  * @version Introduced in firmware 4.0.10.27
2075  * @param tool GoProfileRoundCorner object.
2076  * @return A GoProfileRoundCorner Z measurement.(mm)
2077  */
2078 GoFx(GoProfileRoundCornerZ) GoProfileRoundCorner_ZMeasurement(GoProfileRoundCorner tool);
2079 
2080 /**
2081  * Returns a GoProfileRoundCorner Angle measurement object.
2082  *
2083  * @public @memberof GoProfileRoundCorner
2084  * @version Introduced in firmware 4.0.10.27
2085  * @param tool GoProfileRoundCorner object.
2086  * @return A GoProfileRoundCorner Angle measurement.(degrees)
2087  */
2088 GoFx(GoProfileRoundCornerAngle) GoProfileRoundCorner_AngleMeasurement(GoProfileRoundCorner tool);
2089 
2090 /**
2091  * Gets the edge.
2092  *
2093  * @public @memberof GoProfileRoundCorner
2094  * @version Introduced in firmware 4.0.10.27
2095  * @param tool GoProfileRoundCorner object.
2096  * @return The edge.
2097  */
2098 GoFx(GoProfileEdge) GoProfileRoundCorner_Edge(GoProfileRoundCorner tool);
2099 
2100 /**
2101  * Sets the edge.
2102  *
2103  * @public @memberof GoProfileRoundCorner
2104  * @version Introduced in firmware 4.0.10.27
2105  * @param tool GoProfileRoundCorner object.
2106  * @param edge The edge.
2107  * @return Operation status.
2108  */
2109 GoFx(kStatus) GoProfileRoundCorner_SetEdge(GoProfileRoundCorner tool, GoProfileEdge edge);
2110 
2111 /**
2112  * Gets the reference direction.
2113  *
2114  * @public @memberof GoProfileRoundCorner
2115  * @version Introduced in firmware 4.0.10.27
2116  * @param tool GoProfileRoundCorner object.
2117  * @return The reference direction.
2118  */
2119 GoFx(GoProfileRoundCornerDirection) GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool);
2120 
2121 /**
2122  * Sets the reference direction.
2123  *
2124  * @public @memberof GoProfileRoundCorner
2125  * @version Introduced in firmware 4.0.10.27
2126  * @param tool GoProfileRoundCorner object.
2127  * @param direction The reference direction.
2128  * @return Operation status.
2129  */
2130 GoFx(kStatus) GoProfileRoundCorner_SetRefDirection(GoProfileRoundCorner tool, GoProfileRoundCornerDirection direction);
2131 
2132 /**
2133 *
2134 *
2135 * @public @memberof GoProfileRoundCorner
2136 * @version Introduced in firmware 4.0.10.27
2137 * @param tool GoProfileRoundCorner object.
2138 * @return A GoProfileRoundCornerPoint point feature
2139 */
2140 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_Point(GoProfileRoundCorner tool);
2141 
2142 /**
2143 * gets the round corner edge point
2144 *
2145 * @public @memberof GoProfileRoundCorner
2146 * @version Introduced in firmware 4.8.1.80
2147 * @param tool GoProfileRoundCorner object.
2148 * @return A GoProfileRoundCornerEdgePoint point feature
2149 */
2150 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_EdgePoint(GoProfileRoundCorner tool);
2151 
2152 /**
2153 * gets the round corner center point
2154 *
2155 * @public @memberof GoProfileRoundCorner
2156 * @version Introduced in firmware 4.8.1.80
2157 * @param tool GoProfileRoundCorner object.
2158 * @return A GoProfileRoundCornerCenterPoint point feature
2159 */
2160 GoFx(GoProfileRoundCornerCenterPoint) GoProfileRoundCorner_CenterPoint(GoProfileRoundCorner tool);
2161 
2162 kEndHeader()
2163 #include <GoSdk/Tools/GoProfileTools.x.h>
2164 
2165 #endif
GoProfileBoxWidth GoProfileBox_WidthMeasurement(GoProfileBox tool)
Returns a GoProfileBox Width measurement object.
GoProfileLineMinErrorZ GoProfileLine_MinErrorZMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum Z Error measurement object.
Represents a round corner point of a Profile Round tool.
kBool GoProfileTool_ZAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anc...
GoProfilePositionPoint GoProfilePosition_Point(GoProfilePosition tool)
Returns a GoProfilePosition point feature object.
kStatus GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable)
Enables or disables the tool region.
Represents a profile line tool.
kStatus GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value)
Sets the transition height.
Declares the base GoTool class.
GoProfileRegion GoProfileStrip_Region(GoProfileStrip tool)
Gets the profile strip tool region.
kStatus GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge)
Sets the right edge.
Represents an X value measurement for a Profile Circle Tool.
GoProfileBoxHeight GoProfileBox_HeightMeasurement(GoProfileBox tool)
Returns a GoProfileBox Height measurement object.
GoProfileIntersectZ GoProfileIntersect_ZMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Z measurement object.
GoProfileBridgeValueBridgeValue GoProfileBridgeValue_BridgeValueMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue bridge value measurement object.
GoProfileBoundingBoxCenterPoint GoProfileBox_CenterPoint(GoProfileBox tool)
Returns a GoProfileBox center point feature object.
Represents the base class for a tool measurement or script output.
Represents a corner point for a Profile Bounding Box tool.
GoProfileLineAngle GoProfileLine_AngleMeasurement(GoProfileLine tool)
Returns a GoProfileLine Angle measurement object.
kBool GoProfileBox_RegionEnabled(GoProfileBox tool)
Returns the enabled state of the tool region.
kBool GoProfilePosition_RegionEnabled(GoProfilePosition tool)
Indicates whether the region is enabled.
Represents a Z measurement for a Profile Bounding Box tool.
GoProfilePanelLeftFlushX GoProfilePanel_LeftFlushXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush X measurement object.
kStatus GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type)
Sets the reference line type.
Represents a round corner circle center point of a Profile Round tool.
kStatus GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable)
Enables or disables the region.
GoProfileRegion GoProfileGroove_Region(GoProfileGroove tool)
Gets the profile region.
kStatus GoProfileLine_EnableFittingRegions(GoProfileLine tool, kBool enable)
Enables or disables the fitting regions.
GoProfileLineLine GoProfileLine_Line(GoProfileLine tool)
Returns a GoProfileLine line feature object.
GoProfileIntersectBaseLine GoProfileIntersect_BaseLineFeature(GoProfileIntersect tool)
Returns a GoProfileIntersectBaseLine Feature object.
GoProfileCircleRadius GoProfileCircle_RadiusMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Radius measurement object.
GoProfileLineRegion GoProfileIntersect_RefLine(GoProfileIntersect tool)
Gets the reference profile line.
GoProfileBoxX GoProfileBox_XMeasurement(GoProfileBox tool)
Returns a GoProfileBox X measurement object.
kStatus GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max invalid percentage.
k64f GoProfileGroove_MaxWidth(GoProfileGroove tool)
Gets the groove width maximum.
kStatus GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width)
Sets the groove width maximum.
GoProfileRoundCornerPoint GoProfileRoundCorner_Point(GoProfileRoundCorner tool)
GoProfileEdge GoProfileRoundCorner_Edge(GoProfileRoundCorner tool)
Gets the edge.
kStatus GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth)
Sets the groove depth minimum.
GoProfilePanelLeftFlushZ GoProfilePanel_LeftFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush Z measurement object.
Represents a gap measurement for a Profile Panel Tool.
kStatus GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable)
Enables or disables the tool region.
kSize GoProfileTool_XAnchorOptionCount(GoProfileTool tool)
Gets the X-anchoring option list count.
Lists all measurement types.
kStatus GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile groove tool measurement.
Represents a profile dimension tool.
GoProfilePanelRightFlushZ GoProfilePanel_RightFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Flush Z measurement object.
GoProfileLineRegion GoProfileArea_LineRegion(GoProfileArea tool)
Gets the reference profile line.
kStatus GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value)
Sets the profile X-Line tool maximum tracking speed.
Represents a Left Surface Angle measurement for a Profile Panel tool.
GoDataStream GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index)
Gets the data stream option at the given index.
GoProfilePanelLeftGapZ GoProfilePanel_LeftGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap Z measurement object.
Represents a center X value measurement for a Profile Dimension Tool.
Represents a flush measurement for a Profile Panel Tool.
GoProfileRegion GoProfileBridgeValue_Region(GoProfileBridgeValue tool)
Gets the bridge value profile region.
Represents a profile bounding box tool.
GoProfileLineMaxErrorPoint GoProfileLine_MaxErrorPoint(GoProfileLine tool)
Returns a GoProfileLine min error point feature object.
GoProfileLineMinError GoProfileLine_MinErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum Error measurement object.
GoProfileCircleRadius GoProfileCircle_MinErrorXMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Min Error X measurement object.
Represents a point of a Profile Line tool.
kStatus GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable)
Enables or disables the region.
GoProfileFeature GoProfilePosition_Feature(GoProfilePosition tool)
Gets the profile feature.
ReprRepresents a center point for a Profile Bounding Box tool.
GoProfileBoundingBoxCornerPoint GoProfileBox_CornerPoint(GoProfileBox tool)
Returns a GoProfileBox corner point feature object.
kStatus GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape)
Sets the groove determination shape.
kStatus GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable)
Enables or disables the region.
Represents a Maximum Z Error measurement for a Profile Line Tool.
GoProfileLineMaxErrorZ GoProfileLine_MaxErrorZMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum Z Error measurement object.
GoProfileCircleRadius GoProfileCircle_MaxErrorXMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Max Error X measurement object.
kStatus GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side)
Sets the reference edge side.
Represents a point of intersection for a Profile Intersect tool.
GoProfileCircleRadius GoProfileCircle_MaxErrorMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Max Error measurement object.
Represents an standard deviation measurement for a Profile Bridge Value tool.
k64f GoProfileStrip_MinWidth(GoProfileStrip tool)
Gets the minimum width.
GoProfileRegion GoProfileCircle_Region(GoProfileCircle tool)
Gets the profile region.
k64f GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool)
Gets the profile X-Line tool window skip percentage.
GoMeasurement GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index)
Returns a measurement object at the given index.
kStatus GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index)
Removes a measurement from the tool at the given index.
GoProfileStripEdgeType GoProfileStrip_RightEdge(GoProfileStrip tool)
Gets the right edge value.
kStatus GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type)
Sets the profile area type.
GoProfileRegion GoProfileBox_Region(GoProfileBox tool)
Gets the profile bounding box region.
k32s GoProfileTool_ZAnchor(GoProfileTool tool)
Gets the current Z-anchoring source.
kSize GoProfileStrip_MeasurementCount(GoProfileStrip tool)
Returns the measurement count for the given tool.
Represents a profile intersect tool.
Represents an Z measurement for a Profile Round Corner tool.
Represents a Minimum Z Error measurement for a Profile Line Tool.
GoProfileIntersectLine GoProfileIntersect_LineFeature(GoProfileIntersect tool)
Returns a GoProfileIntersectLine Feature object.
kStatus GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source)
Sets the data source.
GoProfileBoxGlobalX GoProfileBox_GlobalXMeasurement(GoProfileBox tool)
Returns a GoProfileBox global X measurement object.
Represents a width value measurement for a Profile Dimension Tool.
kSize GoProfileTool_StreamOptionCount(GoProfileTool tool)
Gets the data stream option list count.
Represents a data stream which consists of a data step and ID.
Definition: GoSdkDef.h:1186
Represents a data source.
Represents an angle measurement for a Profile Bridge Value tool.
Represents a profile area tool.
kStatus GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value)
Sets the transition width.
k64f GoProfileGroove_MinDepth(GoProfileGroove tool)
Gets the groove depth minimum.
GoProfileCircleRadius GoProfileCircle_MinErrorZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Min Error Z measurement object.
GoProfilePanelFlush GoProfilePanel_FlushMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Flush measurement object.
GoProfileAreaCenterPoint GoProfileArea_CenterPoint(GoProfileArea tool)
Returns a GoProfileArea Center point feature object.
kBool GoProfileStrip_TiltEnabled(GoProfileStrip tool)
Gets the tilt enabled state.
Contains various helper functions.
GoProfileRoundCornerDirection GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool)
Gets the reference direction.
Represents an intersect X measurement for a Profile Intersect Tool.
Represents a profile panel tool.
GoProfileLineRegion GoProfileIntersect_Line(GoProfileIntersect tool)
Gets the non-reference profile line.
kBool GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool)
Returns the enabled state of normalization.
Represents a maximum error measurement for a Profile Line Tool.
GoProfileAreaType GoProfileArea_Type(GoProfileArea tool)
Gets the profile area type.
Represents a profile groove tool.
kBool GoProfileXLine_RegionEnabled(GoProfileXLine tool)
Returns the enabled state of the tool region.
GoProfileStripEdgeType GoProfileStrip_LeftEdge(GoProfileStrip tool)
Gets the left edge value.
k64f GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential maximum value limit.
Represents a centroid Z measurement for a Profile Area Tool.
GoProfileRoundCornerCenterPoint GoProfileRoundCorner_CenterPoint(GoProfileRoundCorner tool)
gets the round corner center point
Represents a Left Gap X measurement for a Profile Panel tool.
kStatus GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value)
Sets the maximum void width.
GoProfileAreaArea GoProfileArea_AreaMeasurement(GoProfileArea tool)
Returns a GoProfileArea Area measurement object.
k64f GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential minimum value limit.
GoProfileLineMinErrorPoint GoProfileLine_MinErrorPoint(GoProfileLine tool)
Returns a GoProfileLine Maximum Z Error measurement object.
kStatus GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable)
Enables or disables normalization.
kBool GoProfileTool_XAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anc...
Represents a profile circle tool.
GoProfilePanelRightGapZ GoProfilePanel_RightGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap Z measurement object.
GoProfileDimensionCenterPoint GoProfileDim_CenterPoint(GoProfileDim tool)
Returns a GoProfileDim Center point feature object.
GoProfilePanelLeftGapX GoProfilePanel_LeftGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap X measurement object.
Represents a Right Gap Z measurement for a Profile Panel tool.
GoProfileAreaCentroidX GoProfileArea_CentroidXMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid X measurement object.
k32s GoProfileTool_XAnchor(GoProfileTool tool)
Gets the current X-anchoring source.
Represents a Left Flush X measurement for a Profile Panel tool.
Represents an area measurement for a Profile Area tool.
GoProfileEdge GoProfilePanel_RightEdge(GoProfilePanel tool)
Gets the right profile edge.
Represents a height measurement for a Profile Bounding Box tool.
GoProfileIntersectIntersectPoint GoProfileIntersect_PointFeature(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
Represents a global angle measurement for a Profile Bounding Box tool.
Represents a minimum error measurement for a Profile Line Tool.
kBool GoProfileGroove_RegionEnabled(GoProfileGroove tool)
Indicates whether the region is enabled.
kStatus GoProfilePosition_EnableRegion(GoProfilePosition tool, kBool enable)
Enables or disables the region.
Represents an Z measurement for a Profile Position tool.
Essential SDK declarations.
GoProfileRoundCornerX GoProfileRoundCorner_XMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner X measurement object.
GoProfileBaseline GoProfileArea_Baseline(GoProfileArea tool)
Gets the profile area baseline.
kStatus GoProfileRoundCorner_SetRefDirection(GoProfileRoundCorner tool, GoProfileRoundCornerDirection direction)
Sets the reference direction.
GoProfileDimCenterX GoProfileDim_CenterXMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center X measurement object.
k32u GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the Z-anchoring option at the given index.
GoProfileIntersectX GoProfileIntersect_XMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect X measurement object.
GoProfilePositionZ GoProfilePosition_ZMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition Z measurement object.
kStatus GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id)
Sets the Z-anchoring source.
GoProfileBoxGlobalAngle GoProfileBox_GlobalAngleMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Angle measurement object.
k64f GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential.
Represents a percentile measurement for a Profile Line Tool.
GoProfilePanelSide GoProfilePanel_RefEdgeSide(GoProfilePanel tool)
Gets the reference edge side.
Represents a profile strip tool.
kStatus GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable)
Enables or disables the region.
GoProfileLineStdDev GoProfileLine_StdDevMeasurement(GoProfileLine tool)
Returns a GoProfileLine Standard Deviation measurement object.
GoProfileStripBaseType GoProfileStrip_BaseType(GoProfileStrip tool)
Gets the strip base type.
GoProfileBridgeValueWindow GoProfileBridgeValue_WindowMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue window measurement object.
Represents a center point of a Profile Area tool.
Represents the base tool class.
Represents a point of a Profile Position tool.
GoProfileDimWidth GoProfileDim_WidthMeasurement(GoProfileDim tool)
Returns a GoProfileDim Width measurement object.
Represents an X measurement for a Profile Bounding Box tool.
GoDataStream GoProfileTool_Stream(GoProfileTool tool)
Gets the data stream.
kStatus GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable)
Enables or disables the tool region.
GoProfileAreaCentroidZ GoProfileArea_CentroidZMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid Z measurement object.
kBool GoProfileLine_FittingRegionsEnabled(GoProfileLine tool)
Indicates whether the fitting regions are enabled.
Represents a profile bridge value tool.
Represents a height value measurement for a Profile Dimension Tool.
Represents a center point of a Profile Circle tool.
k64f GoProfileStrip_MaxVoidWidth(GoProfileStrip tool)
Gets the maximum void width.
GoProfileBaseline GoProfileIntersect_RefLineType(GoProfileIntersect tool)
Gets the reference profile line type.
GoProfileLinePercentile GoProfileLine_PercentileMeasurement(GoProfileLine tool)
Returns a GoProfileLine Percentile measurement object.
kBool GoProfileStrip_RegionEnabled(GoProfileStrip tool)
Indicates whether the region is enabled.
Represents a Z value measurement for a Profile Circle Tool.
GoProfileEdge GoProfilePanel_LeftEdge(GoProfilePanel tool)
Gets the left profile edge.
k32u GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the X-anchoring option at the given index.
Represents a global Y measurement for a Profile Bounding Box tool.
k64f GoProfileStrip_SupportWidth(GoProfileStrip tool)
Gets the support width.
GoProfileFeature GoProfileDim_Feature(GoProfileDim tool)
Gets the non-reference profile feature.
GoProfileRoundCornerZ GoProfileRoundCorner_ZMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner Z measurement object.
kBool GoProfileArea_BaselineUsed(GoProfileArea tool)
Returns a boolean representing whether the profile area baseline is used.
GoDataSource GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index)
Gets the data source option at the given index.
GoProfileFeature GoProfileDim_RefFeature(GoProfileDim tool)
Gets the reference profile feature.
GoProfileRegion GoProfileArea_Region(GoProfileArea tool)
Gets the profile region.
k64f GoProfileStrip_MinHeight(GoProfileStrip tool)
Gets the minimum height.
k64f GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool)
Gets the profile X-Line tool window size percentage.
kStatus GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile strip tool measurement.
GoMeasurement GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index)
Returns a measurement object at the given index.
kStatus GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max differential.
GoProfileLineOffset GoProfileLine_OffsetMeasurement(GoProfileLine tool)
Returns a GoProfileLine Offset measurement object.
kStatus GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type)
Sets the strip base type.
Represents a base line feature of a Profile Intersect tool tool.
Represents an Angle measurement for a Profile Line Tool.
GoProfilePanelGap GoProfilePanel_GapMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Gap measurement object.
Represents a profile X-Line tool.
kBool GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool)
Returns the enabled state of the tool region.
Represents a Right Flush Z measurement for a Profile Panel tool.
GoProfileGrooveShape GoProfileGroove_Shape(GoProfileGroove tool)
Gets the current groove determination shape.
Represents an X measurement for a Profile Round Corner tool.
Represents a point of maximum error for a Profile Line tool.
GoProfileCircleRadius GoProfileCircle_MinErrorMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Min Error measurement object.
k64f GoProfileStrip_TransitionWidthLimitMin(GoProfileStrip tool)
Gets the transition width limit minimum.
kStatus GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value)
Sets the minimum width.
GoProfilePanelLeftSurfaceAngle GoProfilePanel_LeftSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Surface Angle measurement object.
GoProfileCircleCenterPoint GoProfileCircle_CenterPoint(GoProfileCircle tool)
Returns a GoProfileCircle center point feature object.
GoProfileRoundCornerPoint GoProfileRoundCorner_EdgePoint(GoProfileRoundCorner tool)
gets the round corner edge point
GoProfileRegion GoProfileXLine_Region(GoProfileXLine tool)
Gets the profile X-Line tool region.
kSize GoProfileTool_SourceOptionCount(GoProfileTool tool)
Gets the data source option list count.
GoProfileCircleRadius GoProfileCircle_StdDevMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle StdDev measurement object.
GoProfilePositionX GoProfilePosition_XMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition X measurement object.
Represents a standard deviation measurement for a Profile Line Tool.
Represents a center Z value measurement for a Profile Dimension Tool.
GoProfileBridgeValueAngle GoProfileBridgeValue_AngleMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue angle measurement object.
kStatus GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index)
Removes a measurement from the tool at the given index.
kStatus GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window skip percentage.
GoProfileXLineZ GoProfileXLine_ZMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Z measurement object.
GoProfileIntersectAngle GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
Represents a centroid X measurement for a Profile Area Tool.
kBool GoProfileArea_TypeUsed(GoProfileArea tool)
Gets the boolean representing whether the area type is used.
GoProfileLineMaxError GoProfileLine_MaxErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum Error measurement object.
k64f GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool)
Gets the profile X-Line tool max invalid percentage.
kStatus GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable)
Enables or disables the region.
Represents a Maximum X Error measurement for a Profile Line Tool.
Represents a Left Gap Z measurement for a Profile Panel tool.
kStatus GoProfileRoundCorner_SetEdge(GoProfileRoundCorner tool, GoProfileEdge edge)
Sets the edge.
kStatus GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width)
Sets the groove width minimum.
GoProfileBoxZ GoProfileBox_ZMeasurement(GoProfileBox tool)
Returns a GoProfileBox Z measurement object.
kStatus GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream)
Sets the data stream.
kStatus GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge)
Sets the left edge.
GoProfileLineMinErrorX GoProfileLine_MinErrorXMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum X Error measurement object.
kBool GoProfileArea_RegionEnabled(GoProfileArea tool)
Indicates whether the region is enabled.
GoDataSource GoProfileTool_Source(GoProfileTool tool)
Gets the data source.
GoProfileCircleRadius GoProfileCircle_MaxErrorZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Max Error Z measurement object.
Represents an intersect angle measurement for a Profile Intersect Tool.
k64f GoProfileStrip_TransitionWidth(GoProfileStrip tool)
Gets the transition width.
Represents a radius value measurement for a Profile Circle Tool.
Represents an Minimum X Error measurement for a Profile Line Tool.
Represents a Right Gap X measurement for a Profile Panel tool.
Represents an Z measurement for a Profile X-Line tool.
Represents a Left Flush Z measurement for a Profile Panel tool.
Represents a width measurement for a Profile Bounding Box tool.
GoProfileDimHeight GoProfileDim_HeightMeasurement(GoProfileDim tool)
Returns a GoProfileDim Height measurement object.
GoProfileBoxGlobalY GoProfileBox_GlobalYMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Y measurement object.
k64f GoProfileStrip_TransitionWidthLimitMax(GoProfileStrip tool)
Gets the transition width limit maximum.
kStatus GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width)
Sets the maximum gap width.
GoProfileRoundCornerAngle GoProfileRoundCorner_AngleMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner Angle measurement object.
GoProfileBridgeValueStdDev GoProfileBridgeValue_StdDevMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue standard deviation measurement object.
k64f GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool)
Gets the profile X-Line tool maximum tracking speed.
Represents an offset measurement for a Profile Line Tool.
kStatus GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id)
Sets the X-anchoring source.
GoProfileDimDistance GoProfileDim_DistanceMeasurement(GoProfileDim tool)
Returns a GoProfileDim Distance measurement object.
Represents an intersect Z measurement for a Profile Intersect Tool.
Represents an X measurement for a Profile Position tool.
GoProfileLineMaxErrorX GoProfileLine_MaxErrorXMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum X Error measurement object.
Represents an window measurement for a Profile Bridge Value tool.
GoProfileCircleX GoProfileCircle_XMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle X measurement object.
GoProfileCircleZ GoProfileCircle_ZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Z measurement object.
kBool GoProfileLine_RegionEnabled(GoProfileLine tool)
Indicates whether the region is enabled.
k64f GoProfilePanel_MaxGapWidth(GoProfilePanel tool)
Gets the maximum gap width.
kSize GoProfileGroove_MeasurementCount(GoProfileGroove tool)
Returns the measurement count for the given tool.
GoProfileDimCenterZ GoProfileDim_CenterZMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center Z measurement object.
Represents a bridge value measurement for a Profile Bridge Value tool.
kStatus GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable)
Enables or disables tilt.
Represents a line for a Profile Intersect tool.
Represents a point of minimum error for a Profile Line tool.
kBool GoProfileCircle_RegionEnabled(GoProfileCircle tool)
Indicates whether the region is enabled.
Represents a base profile tool.
kStatus GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type)
Sets the profile area type.
Represents a Right Surface Angle measurement for a Profile Panel tool.
kStatus GoProfileStrip_SetSupportWidth(GoProfileStrip tool, k64f value)
Sets the support width.
kSize GoProfileTool_ZAnchorOptionCount(GoProfileTool tool)
Gets the Z-anchoring option list count.
Represents a global X measurement for a Profile Bounding Box tool.
Represents a profile round corner tool.
kStatus GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window size percentage.
k64f GoProfileGroove_MinWidth(GoProfileGroove tool)
Gets the groove width minimum value.
Represents an Angle measurement for a Profile Round Corner tool.
GoProfilePanelRightGapX GoProfilePanel_RightGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap X measurement object.
Represents a center point of a Profile Dimension tool.
Represents a profile position tool.
Represents a distance value measurement for a Profile Dimension Tool.
GoProfileXLineZ GoProfileXLine_ValidityMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Validity measurement object.
GoProfilePanelRightSurfaceAngle GoProfilePanel_RightSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Surface Angle measurement object.