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-2018 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>
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  * @param tool GoProfileCircle object.
783  * @return A GoProfileCircleRadius StdDev measurement (mm).
784  */
785 GoFx(GoProfileCircleRadius) GoProfileCircle_StdDevMeasurement(GoProfileCircle tool);
786 
787 /**
788  * Returns a GoProfileCircle Min Error measurement object.
789  *
790  * @public @memberof GoProfileCircle
791  * @param tool GoProfileCircle object.
792  * @return A GoProfileCircleRadius Min Error measurement (mm).
793  */
795 
796 /**
797  * Returns a GoProfileCircle Min Error X measurement object.
798  *
799  * @public @memberof GoProfileCircle
800  * @param tool GoProfileCircle object.
801  * @return A GoProfileCircleRadius Min Error X measurement (mm).
802  */
804 
805 /**
806  * Returns a GoProfileCircle Min Error Z measurement object.
807  *
808  * @public @memberof GoProfileCircle
809  * @param tool GoProfileCircle object.
810  * @return A GoProfileCircleRadius Min Error Z measurement (mm).
811  */
813 
814 /**
815  * Returns a GoProfileCircle Max Error measurement object.
816  *
817  * @public @memberof GoProfileCircle
818  * @param tool GoProfileCircle object.
819  * @return A GoProfileCircleRadius Max Error measurement (mm).
820  */
822 
823 /**
824  * Returns a GoProfileCircle Max Error X measurement object.
825  *
826  * @public @memberof GoProfileCircle
827  * @param tool GoProfileCircle object.
828  * @return A GoProfileCircleRadius Max Error X measurement (mm).
829  */
831 
832 /**
833  * Returns a GoProfileCircle Max Error Z measurement object.
834  *
835  * @public @memberof GoProfileCircle
836  * @param tool GoProfileCircle object.
837  * @return A GoProfileCircleRadius Max Error Z measurement (mm).
838  */
840 
841 
842 /**
843 * Returns a GoProfileCircle center point feature object.
844 *
845 * @public @memberof GoProfileCircle
846 * @version Introduced in firmware 4.0.10.27
847 * @param tool GoProfileCircle object.
848 * @return A GoProfileCircleCenterPoint center point feature .
849 */
850 GoFx(GoProfileCircleCenterPoint) GoProfileCircle_CenterPoint(GoProfileCircle tool);
851 
852 /**
853  * @class GoProfileDim
854  * @extends GoProfileTool
855  * @ingroup GoSdk-ProfileTools
856  * @brief Represents a profile dimension tool.
857  */
858 typedef GoProfileTool GoProfileDim;
859 
860 
861 /**
862  * Gets the reference profile feature.
863  *
864  * @public @memberof GoProfileDim
865  * @version Introduced in firmware 4.0.10.27
866  * @param tool GoProfileDim object.
867  * @return The reference profile feature object.
868  */
869 GoFx(GoProfileFeature) GoProfileDim_RefFeature(GoProfileDim tool);
870 
871 /**
872  * Gets the non-reference profile feature.
873  *
874  * @public @memberof GoProfileDim
875  * @version Introduced in firmware 4.0.10.27
876  * @param tool GoProfileDim object.
877  * @return The profile feature object.
878  */
879 GoFx(GoProfileFeature) GoProfileDim_Feature(GoProfileDim tool);
880 
881 /**
882  * Returns a GoProfileDim Width measurement object.
883  *
884  * @public @memberof GoProfileDim
885  * @version Introduced in firmware 4.0.10.27
886  * @param tool GoProfileDim object.
887  * @return A GoProfileDimWidth measurement.(mm)
888  */
889 GoFx(GoProfileDimWidth) GoProfileDim_WidthMeasurement(GoProfileDim tool);
890 
891 /**
892  * Returns a GoProfileDim Height measurement object.
893  *
894  * @public @memberof GoProfileDim
895  * @version Introduced in firmware 4.0.10.27
896  * @param tool GoProfileDim object.
897  * @return A GoProfileDimHeight measurement.(mm)
898  */
899 GoFx(GoProfileDimHeight) GoProfileDim_HeightMeasurement(GoProfileDim tool);
900 
901 /**
902  * Returns a GoProfileDim Distance measurement object.
903  *
904  * @public @memberof GoProfileDim
905  * @version Introduced in firmware 4.0.10.27
906  * @param tool GoProfileDim object.
907  * @return A GoProfileDimDistance measurement.(mm)
908  */
910 
911 /**
912  * Returns a GoProfileDim Center X measurement object.
913  *
914  * @public @memberof GoProfileDim
915  * @version Introduced in firmware 4.0.10.27
916  * @param tool GoProfileDim object.
917  * @return A GoProfileDimCenterX measurement.
918  */
920 
921 /**
922  * Returns a GoProfileDim Center Z measurement object.
923  *
924  * @public @memberof GoProfileDim
925  * @version Introduced in firmware 4.0.10.27
926  * @param tool GoProfileDim object.
927  * @return A GoProfileDimCenterZ measurement.
928  */
930 
931 /**
932 * Returns a GoProfileDim Center point feature object.
933 *
934 * @public @memberof GoProfileDim
935 * @version Introduced in firmware 4.0.10.27
936 * @param tool GoProfileDim object.
937 * @return A GoProfileDimensionCenterPoint Center point feature.
938 */
940 
941 /**
942  * @class GoProfileGroove
943  * @extends GoProfileTool
944  * @ingroup GoSdk-ProfileTools
945  * @brief Represents a profile groove tool.
946  */
947 typedef GoProfileTool GoProfileGroove;
948 
949 /**
950  * Adds an additional profile groove tool measurement.
951  *
952  * @public @memberof GoProfileGroove
953  * @version Introduced in firmware 4.0.10.27
954  * @param tool GoProfileGroove object.
955  * @param type The measurement type to add. It must be a valid profile groove tool type.
956  * @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.
957  * @return Operation status.
958  */
959 GoFx(kStatus) GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement* measurement);
960 
961 /**
962  * Removes a measurement from the tool at the given index.
963  *
964  * @public @memberof GoProfileGroove
965  * @version Introduced in firmware 4.0.10.27
966  * @param tool GoProfileGroove object.
967  * @param index The index with which to remove a measurement.
968  * @return Operation status.
969  */
970 GoFx(kStatus) GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index);
971 
972 /**
973  * Returns the measurement count for the given tool.
974  *
975  * @public @memberof GoProfileGroove
976  * @version Introduced in firmware 4.0.10.27
977  * @param tool GoProfileGroove object.
978  * @return Tool measurement count.
979  */
980 GoFx(kSize) GoProfileGroove_MeasurementCount(GoProfileGroove tool);
981 
982 /**
983  * Returns a measurement object at the given index.
984  *
985  * @public @memberof GoProfileGroove
986  * @version Introduced in firmware 4.0.10.27
987  * @param tool GoProfileGroove object.
988  * @param index The index with which to return a measurement object.
989  * @return A profile groove tool measurement or kNULL if the index is invalid.
990  */
991 GoFx(GoMeasurement) GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index);
992 
993 /**
994  * Gets the current groove determination shape.
995  *
996  * @public @memberof GoProfileGroove
997  * @version Introduced in firmware 4.0.10.27
998  * @param tool GoProfileGroove object.
999  * @return The profile groove shape.
1000  */
1001 GoFx(GoProfileGrooveShape) GoProfileGroove_Shape(GoProfileGroove tool);
1002 
1003 /**
1004  * Sets the groove determination shape.
1005  *
1006  * @public @memberof GoProfileGroove
1007  * @version Introduced in firmware 4.0.10.27
1008  * @param tool GoProfileGroove object.
1009  * @param shape The intended profile groove shape.
1010  * @return Operation status.
1011  */
1012 GoFx(kStatus) GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape);
1013 
1014 /**
1015  * Gets the groove depth minimum.
1016  *
1017  * @public @memberof GoProfileGroove
1018  * @version Introduced in firmware 4.0.10.27
1019  * @param tool GoProfileGroove object.
1020  * @return The groove depth minimum value.(mm)
1021  */
1022 GoFx(k64f) GoProfileGroove_MinDepth(GoProfileGroove tool);
1023 
1024 /**
1025  * Sets the groove depth minimum.
1026  *
1027  * @public @memberof GoProfileGroove
1028  * @version Introduced in firmware 4.0.10.27
1029  * @param tool GoProfileGroove object.
1030  * @param depth The minimum groove depth value to set.(mm)
1031  * @return Operation status.
1032  */
1033 GoFx(kStatus) GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth);
1034 
1035 /**
1036  * Gets the groove width maximum.
1037  *
1038  * @public @memberof GoProfileGroove
1039  * @version Introduced in firmware 4.0.10.27
1040  * @param tool GoProfileGroove object.
1041  * @return The groove width maximum value.(mm)
1042  */
1043 GoFx(k64f) GoProfileGroove_MaxWidth(GoProfileGroove tool);
1044 
1045 /**
1046  * Sets the groove width maximum.
1047  *
1048  * @public @memberof GoProfileGroove
1049  * @version Introduced in firmware 4.0.10.27
1050  * @param tool GoProfileGroove object.
1051  * @param width The maximum groove width value to set.(mm)
1052  * @return Operation status.
1053  */
1054 GoFx(kStatus) GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width);
1055 
1056 /**
1057  * Gets the groove width minimum value.
1058  *
1059  * @public @memberof GoProfileGroove
1060  * @version Introduced in firmware 4.0.10.27
1061  * @param tool GoProfileGroove object.
1062  * @return The groove width minimum.(mm)
1063  */
1064 GoFx(k64f) GoProfileGroove_MinWidth(GoProfileGroove tool);
1065 
1066 /**
1067  * Sets the groove width minimum.
1068  *
1069  * @public @memberof GoProfileGroove
1070  * @version Introduced in firmware 4.0.10.27
1071  * @param tool GoProfileGroove object.
1072  * @param width The minimum groove width value to set.(mm)
1073  * @return Operation status.
1074  */
1075 GoFx(kStatus) GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width);
1076 
1077 /**
1078  * Gets the profile region.
1079  *
1080  * @public @memberof GoProfileGroove
1081  * @version Introduced in firmware 4.0.10.27
1082  * @param tool GoProfileGroove object.
1083  * @return The profile region.
1084  */
1085 GoFx(GoProfileRegion) GoProfileGroove_Region(GoProfileGroove tool);
1086 
1087 /**
1088  * Indicates whether the region is enabled.
1089  *
1090  * @public @memberof GoProfileGroove
1091  * @version Introduced in firmware 4.4.4.14
1092  * @param tool GoProfileGroove object.
1093  * @return kTRUE if enabled and kFALSE otherwise.
1094  */
1095 GoFx(kBool) GoProfileGroove_RegionEnabled(GoProfileGroove tool);
1096 
1097 /**
1098  * Enables or disables the region.
1099  *
1100  * @public @memberof GoProfileGroove
1101  * @version Introduced in firmware 4.4.4.14
1102  * @param tool GoProfileGroove object.
1103  * @param enable kTRUE to enable the region and kFALSE to disable it.
1104  * @return Operation status.
1105  */
1106 GoFx(kStatus) GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable);
1107 
1108 
1109 /**
1110  * @class GoProfileIntersect
1111  * @extends GoProfileTool
1112  * @ingroup GoSdk-ProfileTools
1113  * @brief Represents a profile intersect tool.
1114  */
1115 typedef GoProfileTool GoProfileIntersect;
1116 
1117 
1118 /**
1119  * Gets the reference profile line type.
1120  *
1121  * @public @memberof GoProfileIntersect
1122  * @version Introduced in firmware 4.0.10.27
1123  * @param tool GoProfileIntersect object.
1124  * @return The profile line type.
1125  */
1126 GoFx(GoProfileBaseline) GoProfileIntersect_RefLineType(GoProfileIntersect tool);
1127 
1128 /**
1129  * Sets the reference line type.
1130  *
1131  * @public @memberof GoProfileIntersect
1132  * @version Introduced in firmware 4.0.10.27
1133  * @param tool GoProfileIntersect object.
1134  * @param type The line type to set.
1135  * @return
1136  */
1137 GoFx(kStatus) GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type);
1138 
1139 /**
1140  * Gets the reference profile line.
1141  *
1142  * @public @memberof GoProfileIntersect
1143  * @version Introduced in firmware 4.0.10.27
1144  * @param tool GoProfileIntersect object.
1145  * @return The reference profile line.
1146  */
1147 GoFx(GoProfileLineRegion) GoProfileIntersect_RefLine(GoProfileIntersect tool);
1148 
1149 /**
1150  * Gets the non-reference profile line.
1151  *
1152  * @public @memberof GoProfileIntersect
1153  * @version Introduced in firmware 4.0.10.27
1154  * @param tool GoProfileIntersect object.
1155  * @return The non-reference profile line.
1156  */
1157 GoFx(GoProfileLineRegion) GoProfileIntersect_Line(GoProfileIntersect tool);
1158 
1159 /**
1160  * Returns a GoProfileIntersect X measurement object.
1161  *
1162  * @public @memberof GoProfileIntersect
1163  * @version Introduced in firmware 4.0.10.27
1164  * @param tool GoProfileIntersect object.
1165  * @return A GoProfileIntersect X measurement. (mm)
1166  */
1167 GoFx(GoProfileIntersectX) GoProfileIntersect_XMeasurement(GoProfileIntersect tool);
1168 
1169 /**
1170  * Returns a GoProfileIntersect Z measurement object.
1171  *
1172  * @public @memberof GoProfileIntersect
1173  * @version Introduced in firmware 4.0.10.27
1174  * @param tool GoProfileIntersect object.
1175  * @return A GoProfileIntersect Z measurement.(mm)
1176  */
1177 GoFx(GoProfileIntersectZ) GoProfileIntersect_ZMeasurement(GoProfileIntersect tool);
1178 
1179 /**
1180  * Returns a GoProfileIntersect Angle measurement object.
1181  *
1182  * @public @memberof GoProfileIntersect
1183  * @version Introduced in firmware 4.0.10.27
1184  * @param tool GoProfileIntersect object.
1185  * @return A GoProfileIntersect Angle measurement.(degrees)
1186  */
1187 GoFx(GoProfileIntersectAngle) GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool);
1188 
1189 /**
1190 * Returns a GoProfileIntersect Angle measurement object.
1191 *
1192 * @public @memberof GoProfileIntersect
1193 * @version Introduced in firmware 4.0.10.27
1194 * @param tool GoProfileIntersect object.
1195 * @return A GoProfileIntersect Angle measurement.(degrees)
1196 */
1198 
1199 /**
1200 * Returns a GoProfileIntersectLine Feature object.
1201 *
1202 * @public @memberof GoProfileIntersect
1203 * @version Introduced in firmware 4.6.4.10
1204 * @param tool GoProfileIntersect object.
1205 * @return A GoProfileIntersectLine feature object.
1206 */
1207 GoFx(GoProfileIntersectLine) GoProfileIntersect_LineFeature(GoProfileIntersect tool);
1208 
1209 /**
1210 * Returns a GoProfileIntersectBaseLine Feature object.
1211 *
1212 * @public @memberof GoProfileIntersect
1213 * @version Introduced in firmware 4.6.4.10
1214 * @param tool GoProfileIntersect object.
1215 * @return A GoProfileIntersectBaseLine feature object.
1216 */
1217 GoFx(GoProfileIntersectBaseLine) GoProfileIntersect_BaseLineFeature(GoProfileIntersect tool);
1218 
1219 
1220 /**
1221  * @class GoProfileLine
1222  * @extends GoProfileTool
1223  * @ingroup GoSdk-ProfileTools
1224  * @brief Represents a profile line tool.
1225  */
1226 typedef GoProfileTool GoProfileLine;
1227 
1228 /**
1229  * Gets the measurement region.
1230  *
1231  * @public @memberof GoProfileDev
1232  * @version Introduced in firmware 4.0.10.27
1233  * @param tool GoProfileDev object.
1234  * @return The profile Line Measurement region.
1235  */
1236 GoFx(GoProfileRegion) GoProfileLine_Region(GoProfileLine tool);
1237 
1238 /**
1239  * Indicates whether the region is enabled.
1240  *
1241  * @public @memberof GoProfileLine
1242  * @version Introduced in firmware 4.4.4.14
1243  * @param tool GoProfileLine object.
1244  * @return kTRUE if enabled and kFALSE otherwise.
1245  */
1246 GoFx(kBool) GoProfileLine_RegionEnabled(GoProfileLine tool);
1247 
1248 /**
1249  * Enables or disables the region.
1250  *
1251  * @public @memberof GoProfileLine
1252  * @version Introduced in firmware 4.4.4.14
1253  * @param tool GoProfileLine object.
1254  * @param enable kTRUE to enable the region and kFALSE to disable it.
1255  * @return Operation status.
1256  */
1257 GoFx(kStatus) GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable);
1258 
1259 /**
1260 * Gets the fitting regions.
1261 *
1262 * @public @memberof GoProfileDev
1263 * @version Introduced in firmware 4.6.0.95
1264 * @param tool GoProfileLine object.
1265 * @return The profile Line fitting regions.
1266 */
1267 GoFx(GoProfileLineRegion) GoProfileLine_FittingRegions(GoProfileLine tool);
1268 
1269 /**
1270 * Indicates whether the fitting regions are enabled.
1271 *
1272 * @public @memberof GoProfileLine
1273 * @version Introduced in firmware 4.6.0.147
1274 * @param tool GoProfileLine object.
1275 * @return kTRUE if enabled and kFALSE otherwise.
1276 */
1277 GoFx(kBool) GoProfileLine_FittingRegionsEnabled(GoProfileLine tool);
1278 
1279 /**
1280 * Enables or disables the fitting regions.
1281 *
1282 * @public @memberof GoProfileLine
1283 * @version Introduced in firmware 4.6.0.147
1284 * @param tool GoProfileLine object.
1285 * @param enable Boolean enable or disable fitting regions.
1286 * @return kTRUE if enabled and kFALSE otherwise.
1287 */
1288 GoFx(kStatus) GoProfileLine_EnableFittingRegions(GoProfileLine tool, kBool enable);
1289 
1290 /**
1291  * Returns a GoProfileLine Standard Deviation measurement object.
1292  *
1293  * @public @memberof GoProfileLine
1294  * @version Introduced in firmware 4.0.10.27
1295  * @param tool GoProfileLine object.
1296  * @return A GoProfileLine Standard Deviation measurement.
1297  */
1298 GoFx(GoProfileLineStdDev) GoProfileLine_StdDevMeasurement(GoProfileLine tool);
1299 
1300 /**
1301  * Returns a GoProfileLine Maximum Error measurement object.
1302  *
1303  * @public @memberof GoProfileLine
1304  * @version Introduced in firmware 4.0.10.27
1305  * @param tool GoProfileLine object.
1306  * @return A GoProfileLine Maximum Error measurement.
1307  */
1309 
1310 /**
1311  * Returns a GoProfileLine Minimum Error measurement object.
1312  *
1313  * @public @memberof GoProfileLine
1314  * @version Introduced in firmware 4.0.10.27
1315  * @param tool GoProfileLine object.
1316  * @return A GoProfileLine Minimum Error measurement.
1317  */
1319 
1320 /**
1321  * Returns a GoProfileLine Percentile measurement object.
1322  *
1323  * @public @memberof GoProfileLine
1324  * @version Introduced in firmware 4.0.10.27
1325  * @param tool GoProfileLine object.
1326  * @return A GoProfileLine Percentile measurement.
1327  */
1329 
1330 /**
1331  * Returns a GoProfileLine Offset measurement object.
1332  *
1333  * @public @memberof GoProfileLine
1334  * @version Introduced in firmware 4.6.0.49
1335  * @param tool GoProfileLine object.
1336  * @return A GoProfileLine Offset measurement.
1337  */
1338 GoFx(GoProfileLineOffset) GoProfileLine_OffsetMeasurement(GoProfileLine tool);
1339 
1340 /**
1341  * Returns a GoProfileLine Angle measurement object.
1342  *
1343  * @public @memberof GoProfileLine
1344  * @version Introduced in firmware 4.6.0.49
1345  * @param tool GoProfileLine object.
1346  * @return A GoProfileLine Angle measurement.
1347  */
1348 GoFx(GoProfileLineAngle) GoProfileLine_AngleMeasurement(GoProfileLine tool);
1349 
1350 /**
1351  * Returns a GoProfileLine Minimum X Error measurement object.
1352  *
1353  * @public @memberof GoProfileLine
1354  * @version Introduced in firmware 4.6.0.49
1355  * @param tool GoProfileLine object.
1356  * @return A GoProfileLine Minimum X Error measurement.
1357  */
1359 
1360 /**
1361  * Returns a GoProfileLine Minimum Z Error measurement object.
1362  *
1363  * @public @memberof GoProfileLine
1364  * @version Introduced in firmware 4.6.0.49
1365  * @param tool GoProfileLine object.
1366  * @return A GoProfileLine Minimum Z Error measurement.
1367  */
1369 
1370 /**
1371  * Returns a GoProfileLine Maximum X Error measurement object.
1372  *
1373  * @public @memberof GoProfileLine
1374  * @version Introduced in firmware 4.6.0.49
1375  * @param tool GoProfileLine object.
1376  * @return A GoProfileLine Maximum X Error measurement.
1377  */
1379 
1380 /**
1381  * Returns a GoProfileLine Maximum Z Error measurement object.
1382  *
1383  * @public @memberof GoProfileLine
1384  * @version Introduced in firmware 4.6.0.49
1385  * @param tool GoProfileLine object.
1386  * @return A GoProfileLine Maximum Z Error measurement.
1387  */
1389 
1390 /**
1391 * Returns a GoProfileLine line feature object.
1392 *
1393 * @public @memberof GoProfileLine
1394 * @version Introduced in firmware 4.6.0.49
1395 * @param tool GoProfileLine object.
1396 * @return A GoProfileLineLine line feature.
1397 */
1398 GoFx(GoProfileLineLine) GoProfileLine_Line(GoProfileLine tool);
1399 
1400 /**
1401 * Returns a GoProfileLine Maximum Z Error measurement object.
1402 *
1403 * @public @memberof GoProfileLine
1404 * @version Introduced in firmware 4.6.0.49
1405 * @param tool GoProfileLineMinErrorPoint object.
1406 * @return A GoProfileLineMinErrorPoint min error point feature.
1407 */
1409 
1410 /**
1411 * Returns a GoProfileLine min error point feature object.
1412 *
1413 * @public @memberof GoProfileLine
1414 * @version Introduced in firmware 4.6.0.49
1415 * @param tool GoProfileLineMaxErrorPoint object.
1416 * @return A GoProfileLineMaxErrorPoint min error point feature.
1417 */
1419 
1420 /**
1421  * @class GoProfilePanel
1422  * @extends GoProfileTool
1423  * @ingroup GoSdk-ProfileTools
1424  * @brief Represents a profile panel tool.
1425  */
1426 typedef GoProfileTool GoProfilePanel;
1427 
1428 /**
1429  * Gets the maximum gap width.
1430  *
1431  * @public @memberof GoProfilePanel
1432  * @version Introduced in firmware 4.0.10.27
1433  * @param tool GoProfilePanel object.
1434  * @return The maximum gap width.(mm)
1435  */
1436 GoFx(k64f) GoProfilePanel_MaxGapWidth(GoProfilePanel tool);
1437 
1438 /**
1439  * Sets the maximum gap width.
1440  *
1441  * @public @memberof GoProfilePanel
1442  * @version Introduced in firmware 4.0.10.27
1443  * @param tool GoProfilePanel object.
1444  * @param width The maximum gap width value to set.(mm)
1445  * @return Operation status.
1446  */
1447 GoFx(kStatus) GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width);
1448 
1449 /**
1450  * Gets the reference edge side.
1451  *
1452  * @public @memberof GoProfilePanel
1453  * @version Introduced in firmware 4.0.10.27
1454  * @param tool GoProfilePanel object.
1455  * @return The reference edge side.
1456  */
1457 GoFx(GoProfilePanelSide) GoProfilePanel_RefEdgeSide(GoProfilePanel tool);
1458 
1459 /**
1460  * Sets the reference edge side.
1461  *
1462  * @public @memberof GoProfilePanel
1463  * @version Introduced in firmware 4.0.10.27
1464  * @param tool GoProfilePanel object.
1465  * @param side The reference edge side.
1466  * @return Operation status.
1467  */
1468 GoFx(kStatus) GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side);
1469 
1470 /**
1471  * Gets the left profile edge.
1472  *
1473  * @public @memberof GoProfilePanel
1474  * @version Introduced in firmware 4.0.10.27
1475  * @param tool GoProfilePanel object.
1476  * @return The left profile edge.
1477  */
1478 GoFx(GoProfileEdge) GoProfilePanel_LeftEdge(GoProfilePanel tool);
1479 
1480 /**
1481  * Gets the right profile edge.
1482  *
1483  * @public @memberof GoProfilePanel
1484  * @version Introduced in firmware 4.0.10.27
1485  * @param tool GoProfilePanel object.
1486  * @return The right profile edge.
1487  */
1488 GoFx(GoProfileEdge) GoProfilePanel_RightEdge(GoProfilePanel tool);
1489 
1490 /**
1491  * Returns a GoProfilePanel Gap measurement object.
1492  *
1493  * @public @memberof GoProfilePanel
1494  * @version Introduced in firmware 4.0.10.27
1495  * @param tool GoProfilePanel object.
1496  * @return A GoProfilePanel Gap measurement.
1497  */
1498 GoFx(GoProfilePanelGap) GoProfilePanel_GapMeasurement(GoProfilePanel tool);
1499 
1500 /**
1501  * Returns a GoProfilePanel Flush measurement object.
1502  *
1503  * @public @memberof GoProfilePanel
1504  * @version Introduced in firmware 4.0.10.27
1505  * @param tool GoProfilePanel object.
1506  * @return A GoProfilePanel Flush measurement.
1507  */
1508 GoFx(GoProfilePanelFlush) GoProfilePanel_FlushMeasurement(GoProfilePanel tool);
1509 
1510 /**
1511 * Returns a GoProfilePanel Left Gap X measurement object.
1512 *
1513 * @public @memberof GoProfilePanel
1514 * @version Introduced in firmware 4.0.10.27
1515 * @param tool GoProfilePanel object.
1516 * @return A GoProfilePanel Left Gap X measurement.
1517 */
1518 GoFx(GoProfilePanelGap) GoProfilePanel_LeftGapXMeasurement(GoProfilePanel tool);
1519 
1520 /**
1521 * Returns a GoProfilePanel Left Gap Z measurement object.
1522 *
1523 * @public @memberof GoProfilePanel
1524 * @version Introduced in firmware 4.0.10.27
1525 * @param tool GoProfilePanel object.
1526 * @return A GoProfilePanel Left Gap Z measurement.
1527 */
1528 GoFx(GoProfilePanelGap) GoProfilePanel_LeftGapZMeasurement(GoProfilePanel tool);
1529 
1530 /**
1531 * Returns a GoProfilePanel Left Flush X measurement object.
1532 *
1533 * @public @memberof GoProfilePanel
1534 * @version Introduced in firmware 4.0.10.27
1535 * @param tool GoProfilePanel object.
1536 * @return A GoProfilePanel Left Flush X measurement.
1537 */
1538 GoFx(GoProfilePanelGap) GoProfilePanel_LeftFlushXMeasurement(GoProfilePanel tool);
1539 
1540 /**
1541 * Returns a GoProfilePanel Left Flush Z measurement object.
1542 *
1543 * @public @memberof GoProfilePanel
1544 * @version Introduced in firmware 4.0.10.27
1545 * @param tool GoProfilePanel object.
1546 * @return A GoProfilePanel Left Flush Z measurement.
1547 */
1548 GoFx(GoProfilePanelGap) GoProfilePanel_LeftFlushZMeasurement(GoProfilePanel tool);
1549 
1550 /**
1551 * Returns a GoProfilePanel Left Surface Angle measurement object.
1552 *
1553 * @public @memberof GoProfilePanel
1554 * @version Introduced in firmware 4.0.10.27
1555 * @param tool GoProfilePanel object.
1556 * @return A GoProfilePanel Left Surface Angle measurement.
1557 */
1559 
1560 /**
1561 * Returns a GoProfilePanel Right Gap X measurement object.
1562 *
1563 * @public @memberof GoProfilePanel
1564 * @version Introduced in firmware 4.0.10.27
1565 * @param tool GoProfilePanel object.
1566 * @return A GoProfilePanel Right Gap X measurement.
1567 */
1568 GoFx(GoProfilePanelGap) GoProfilePanel_RightGapXMeasurement(GoProfilePanel tool);
1569 
1570 /**
1571 * Returns a GoProfilePanel Right Gap Z measurement object.
1572 *
1573 * @public @memberof GoProfilePanel
1574 * @version Introduced in firmware 4.0.10.27
1575 * @param tool GoProfilePanel object.
1576 * @return A GoProfilePanel Right Gap Z measurement.
1577 */
1578 GoFx(GoProfilePanelGap) GoProfilePanel_RightGapZMeasurement(GoProfilePanel tool);
1579 
1580 /**
1581 * Returns a GoProfilePanel Right Flush X measurement object.
1582 *
1583 * @public @memberof GoProfilePanel
1584 * @version Introduced in firmware 4.0.10.27
1585 * @param tool GoProfilePanel object.
1586 * @return A GoProfilePanel Right Flush X measurement.
1587 */
1588 GoFx(GoProfilePanelGap) GoProfilePanel_GapPoint(GoProfilePanel tool);
1589 
1590 /**
1591 * Returns a GoProfilePanel Right Flush Z measurement object.
1592 *
1593 * @public @memberof GoProfilePanel
1594 * @version Introduced in firmware 4.0.10.27
1595 * @param tool GoProfilePanel object.
1596 * @return A GoProfilePanel Right Flush Z measurement.
1597 */
1598 GoFx(GoProfilePanelGap) GoProfilePanel_RightFlushZMeasurement(GoProfilePanel tool);
1599 
1600 /**
1601 * Returns a GoProfilePanel Right Surface Angle measurement object.
1602 *
1603 * @public @memberof GoProfilePanel
1604 * @version Introduced in firmware 4.0.10.27
1605 * @param tool GoProfilePanel object.
1606 * @return A GoProfilePanel Right Surface Angle measurement.
1607 */
1609 
1610 /**
1611 * Returns a GoProfilePanel Left gap point featuret object.
1612 *
1613 * @public @memberof GoProfilePanel
1614 * @version Introduced in firmware 4.0.10.27
1615 * @param tool GoProfilePanel object.
1616 * @return A GoProfilePanel Left gap point featuret.
1617 */
1618 GoFx(GoProfilePanelLeftGapPoint) GoProfilePanel_LeftGapPoint(GoProfilePanel tool);
1619 
1620 /**
1621 * Returns a GoProfilePanel left flush point feature object.
1622 *
1623 * @public @memberof GoProfilePanel
1624 * @version Introduced in firmware 4.0.10.27
1625 * @param tool GoProfilePanel object.
1626 * @return A GoProfilePanelLeftFlushPoint Right Surface Angle measurement.
1627 */
1629 
1630 /**
1631 * Returns a GoProfilePanel right gap point feature object.
1632 *
1633 * @public @memberof GoProfilePanel
1634 * @version Introduced in firmware 4.0.10.27
1635 * @param tool GoProfilePanel object.
1636 * @return A GoProfilePanelRightGapPoint right gap point feature object.
1637 */
1639 
1640 /**
1641 * Returns a GoProfilePanel right flush point feature object.
1642 *
1643 * @public @memberof GoProfilePanel
1644 * @version Introduced in firmware 4.0.10.27
1645 * @param tool GoProfilePanel object.
1646 * @return A GoProfilePanelRightGapPoint right flush point feature.
1647 */
1649 
1650 /**
1651  * @class GoProfilePosition
1652  * @extends GoProfileTool
1653  * @ingroup GoSdk-ProfileTools
1654  * @brief Represents a profile position tool.
1655  */
1656 typedef GoProfileTool GoProfilePosition;
1657 
1658 /**
1659 * Indicates whether the region is enabled.
1660 *
1661 * @public @memberof GoProfilePosition
1662  * @version Introduced in firmware 4.8.2.76
1663 * @param tool GoProfilePosition object.
1664 * @return kTRUE if enabled and kFALSE otherwise.
1665 */
1666 GoFx(kBool) GoProfilePosition_RegionEnabled(GoProfilePosition tool);
1667 
1668 /**
1669 * Enables or disables the region.
1670 *
1671 * @public @memberof GoProfilePosition
1672  * @version Introduced in firmware 4.8.2.76
1673 * @param tool GoProfilePosition object.
1674 * @param enable kTRUE to enable the region and kFALSE to disable it.
1675 * @return Operation status.
1676 */
1677 GoFx(kStatus) GoProfilePosition_EnableRegion(GoProfilePosition tool, kBool enable);
1678 /**
1679  * Gets the profile feature.
1680  *
1681  * @public @memberof GoProfilePosition
1682  * @version Introduced in firmware 4.0.10.27
1683  * @param tool GoProfilePos object.
1684  * @return The profile feature.
1685  */
1686 GoFx(GoProfileFeature) GoProfilePosition_Feature(GoProfilePosition tool);
1687 
1688 /**
1689  * Returns a GoProfilePosition X measurement object.
1690  *
1691  * @public @memberof GoProfilePosition
1692  * @version Introduced in firmware 4.0.10.27
1693  * @param tool GoProfilePosition object.
1694  * @return A GoProfilePosition X measurement.(mm)
1695  */
1696 GoFx(GoProfilePositionX) GoProfilePosition_XMeasurement(GoProfilePosition tool);
1697 
1698 /**
1699  * Returns a GoProfilePosition Z measurement object.
1700  *
1701  * @public @memberof GoProfilePosition
1702  * @version Introduced in firmware 4.0.10.27
1703  * @param tool GoProfilePosition object.
1704  * @return A GoProfilePosition Z measurement.(mm)
1705  */
1706 GoFx(GoProfilePositionZ) GoProfilePosition_ZMeasurement(GoProfilePosition tool);
1707 
1708 /**
1709 * Returns a GoProfilePosition point feature object.
1710 *
1711 * @public @memberof GoProfilePosition
1712 * @version Introduced in firmware 4.0.10.27
1713 * @param tool GoProfilePosition object.
1714 * @return A GoProfilePosition point feature.
1715 */
1716 GoFx(GoProfilePositionPoint) GoProfilePosition_Point(GoProfilePosition tool);
1717 
1718 /**
1719  * @class GoProfileStrip
1720  * @extends GoProfileTool
1721  * @ingroup GoSdk-ProfileTools
1722  * @brief Represents a profile strip tool.
1723  */
1724 typedef GoProfileTool GoProfileStrip;
1725 
1726 /**
1727  * Sets the strip base type.
1728  *
1729  * @public @memberof GoProfileStrip
1730  * @version Introduced in firmware 4.0.10.27
1731  * @param tool GoProfileStrip object.
1732  * @param type The strip base type.
1733  * @return Operation status.
1734  */
1735 GoFx(kStatus) GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type);
1736 
1737 /**
1738  * Gets the strip base type.
1739  *
1740  * @public @memberof GoProfileStrip
1741  * @version Introduced in firmware 4.0.10.27
1742  * @param tool GoProfileStrip object.
1743  * @return The strip base type.
1744  */
1745 GoFx(GoProfileStripBaseType) GoProfileStrip_BaseType(GoProfileStrip tool);
1746 
1747 /**
1748  * Gets the left edge value.
1749  *
1750  * @public @memberof GoProfileStrip
1751  * @version Introduced in firmware 4.0.10.27
1752  * @param tool GoProfileStrip object.
1753  * @return The left edge value.
1754  */
1755 GoFx(GoProfileStripEdgeType) GoProfileStrip_LeftEdge(GoProfileStrip tool);
1756 
1757 /**
1758  * Sets the left edge.
1759  *
1760  * @public @memberof GoProfileStrip
1761  * @version Introduced in firmware 4.0.10.27
1762  * @param tool GoProfileStrip object.
1763  * @param leftEdge Left edge value.
1764  * @return Operation status.
1765  */
1766 GoFx(kStatus) GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge);
1767 
1768 /**
1769  * Gets the right edge value.
1770  *
1771  * @public @memberof GoProfileStrip
1772  * @version Introduced in firmware 4.0.10.27
1773  * @param tool GoProfileStrip object.
1774  * @return The right edge value.
1775  */
1776 GoFx(GoProfileStripEdgeType) GoProfileStrip_RightEdge(GoProfileStrip tool);
1777 
1778 /**
1779  * Sets the right edge.
1780  *
1781  * @public @memberof GoProfileStrip
1782  * @version Introduced in firmware 4.0.10.27
1783  * @param tool GoProfileStrip object.
1784  * @param rightEdge Right edge value.
1785  * @return Operation status.
1786  */
1787 GoFx(kStatus) GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge);
1788 
1789 /**
1790  * Gets the tilt enabled state.
1791  *
1792  * @public @memberof GoProfileStrip
1793  * @version Introduced in firmware 4.0.10.27
1794  * @param tool GoProfileStrip object.
1795  * @return kTRUE if tilt is enabled, kFALSE otherwise.
1796  */
1797 GoFx(kBool) GoProfileStrip_TiltEnabled(GoProfileStrip tool);
1798 
1799 /**
1800  * Enables or disables tilt.
1801  *
1802  * @public @memberof GoProfileStrip
1803  * @version Introduced in firmware 4.0.10.27
1804  * @param tool GoProfileStrip object.
1805  * @param enable kTRUE to enable tilt, kFALSE to disable it.
1806  * @return Operation status.
1807  */
1808 GoFx(kStatus) GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable);
1809 
1810 
1811 /**
1812  * Gets the support width.
1813  *
1814  * @public @memberof GoProfileStrip
1815  * @version Introduced in firmware 4.5.3.57
1816  * @param tool GoProfileStrip object.
1817  * @return The support width (in mm).
1818  */
1819 GoFx(k64f) GoProfileStrip_SupportWidth(GoProfileStrip tool);
1820 
1821 /**
1822  * Sets the support width.
1823  *
1824  * @public @memberof GoProfileStrip
1825  * @version Introduced in firmware 4.5.3.57
1826  * @param tool GoProfileStrip object.
1827  * @param value The support width (in mm).
1828  * @return Operation status.
1829  */
1830 GoFx(kStatus) GoProfileStrip_SetSupportWidth(GoProfileStrip tool, k64f value);
1831 
1832 
1833 /**
1834  * Gets the transition width limit minimum.
1835  *
1836  * @public @memberof GoProfileStrip
1837  * @version Introduced in firmware 4.5.3.57
1838  * @param tool GoProfileStrip object.
1839  * @return The minimum permissible transition width (in mm).
1840  */
1841 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMin(GoProfileStrip tool);
1842 
1843 /**
1844  * Gets the transition width limit maximum.
1845  *
1846  * @public @memberof GoProfileStrip
1847  * @version Introduced in firmware 4.5.3.57
1848  * @param tool GoProfileStrip object.
1849  * @return The maximum permissible transition width (in mm).
1850  */
1851 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMax(GoProfileStrip tool);
1852 
1853 /**
1854  * Gets the transition width.
1855  *
1856  * @public @memberof GoProfileStrip
1857  * @version Introduced in firmware 4.0.10.27
1858  * @param tool GoProfileStrip object.
1859  * @return The transition width (in mm).
1860  */
1861 GoFx(k64f) GoProfileStrip_TransitionWidth(GoProfileStrip tool);
1862 
1863 /**
1864  * Sets the transition width.
1865  *
1866  * @public @memberof GoProfileStrip
1867  * @version Introduced in firmware 4.0.10.27
1868  * @param tool GoProfileStrip object.
1869  * @param value The transition width (in mm).
1870  * @return Operation status.
1871  */
1872 GoFx(kStatus) GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value);
1873 
1874 /**
1875  * Gets the minimum width.
1876  *
1877  * @public @memberof GoProfileStrip
1878  * @version Introduced in firmware 4.0.10.27
1879  * @param tool GoProfileStrip object.
1880  * @return The minimum width (in mm).
1881  */
1882 GoFx(k64f) GoProfileStrip_MinWidth(GoProfileStrip tool);
1883 
1884 /**
1885  * Sets the minimum width.
1886  *
1887  * @public @memberof GoProfileStrip
1888  * @version Introduced in firmware 4.0.10.27
1889  * @param tool GoProfileStrip object.
1890  * @param value The minimum width (in mm).
1891  * @return Operation status.
1892  */
1893 GoFx(kStatus) GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value);
1894 
1895 /**
1896  * Gets the minimum height.
1897  *
1898  * @public @memberof GoProfileStrip
1899  * @version Introduced in firmware 4.0.10.27
1900  * @param tool GoProfileStrip object.
1901  * @return The minimum height (in mm).
1902  */
1903 GoFx(k64f) GoProfileStrip_MinHeight(GoProfileStrip tool);
1904 
1905 /**
1906  * Sets the transition height.
1907  *
1908  * @public @memberof GoProfileStrip
1909  * @version Introduced in firmware 4.0.10.27
1910  * @param tool GoProfileStrip object.
1911  * @param value The minimum height (in mm).
1912  * @return Operation status.
1913  */
1914 GoFx(kStatus) GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value);
1915 
1916 /**
1917  * Gets the maximum void width.
1918  *
1919  * @public @memberof GoProfileStrip
1920  * @version Introduced in firmware 4.0.10.27
1921  * @param tool GoProfileStrip object.
1922  * @return The maximum void width (in mm).
1923  */
1924 GoFx(k64f) GoProfileStrip_MaxVoidWidth(GoProfileStrip tool);
1925 
1926 /**
1927  * Sets the maximum void width.
1928  *
1929  * @public @memberof GoProfileStrip
1930  * @version Introduced in firmware 4.0.10.27
1931  * @param tool GoProfileStrip object.
1932  * @param value The maximum void width (in mm).
1933  * @return Operation status.
1934  */
1935 GoFx(kStatus) GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value);
1936 
1937 /**
1938  * Gets the profile strip tool region.
1939  *
1940  * @public @memberof GoProfileStrip
1941  * @version Introduced in firmware 4.0.10.27
1942  * @param tool GoProfileStrip object.
1943  * @return A GoProfileRegion object.
1944  */
1945 GoFx(GoProfileRegion) GoProfileStrip_Region(GoProfileStrip tool);
1946 
1947 /**
1948  * Indicates whether the region is enabled.
1949  *
1950  * @public @memberof GoProfileStrip
1951  * @version Introduced in firmware 4.4.4.14
1952  * @param tool GoProfileStrip object.
1953  * @return kTRUE if enabled and kFALSE otherwise.
1954  */
1955 GoFx(kBool) GoProfileStrip_RegionEnabled(GoProfileStrip tool);
1956 
1957 /**
1958  * Enables or disables the region.
1959  *
1960  * @public @memberof GoProfileStrip
1961  * @version Introduced in firmware 4.4.4.14
1962  * @param tool GoProfileStrip object.
1963  * @param enable kTRUE to enable the region and kFALSE to disable it.
1964  * @return Operation status.
1965  */
1966 GoFx(kStatus) GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable);
1967 
1968 /**
1969  * Adds an additional profile strip tool measurement.
1970  *
1971  * @public @memberof GoProfileStrip
1972  * @version Introduced in firmware 4.0.10.27
1973  * @param tool GoProfileStrip object.
1974  * @param type The measurement type to add. It must be a valid profile strip tool type.
1975  * @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.
1976  * @return Operation status.
1977  */
1978 GoFx(kStatus) GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement* measurement);
1979 
1980 /**
1981  * Removes a measurement from the tool at the given index.
1982  *
1983  * @public @memberof GoProfileStrip
1984  * @version Introduced in firmware 4.0.10.27
1985  * @param tool GoProfileStrip object.
1986  * @param index The index with which to remove a measurement.
1987  * @return Operation status.
1988  */
1989 GoFx(kStatus) GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index);
1990 
1991 /**
1992  * Returns the measurement count for the given tool.
1993  *
1994  * @public @memberof GoProfileStrip
1995  * @version Introduced in firmware 4.0.10.27
1996  * @param tool GoProfileStrip object.
1997  * @return Tool measurement count.
1998  */
1999 GoFx(kSize) GoProfileStrip_MeasurementCount(GoProfileStrip tool);
2000 
2001 /**
2002  * Returns a measurement object at the given index.
2003  *
2004  * @public @memberof GoProfileStrip
2005  * @version Introduced in firmware 4.0.10.27
2006  * @param tool GoProfileStrip object.
2007  * @param index The index with which to return a measurement object.
2008  * @return A profile strip tool measurement or kNULL if the index is invalid.
2009  */
2010 GoFx(GoMeasurement) GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index);
2011 
2012 
2013 /**
2014  * @class GoProfileXLine
2015  * @extends GoProfileTool
2016  * @ingroup GoSdk-ProfileTools
2017  * @brief Represents a profile X-Line tool.
2018 */
2019 typedef GoProfileTool GoProfileXLine;
2020 
2021 /**
2022  * Returns the enabled state of the tool region.
2023  *
2024  * @public @memberof GoProfileXLine
2025  * @version Introduced in firmware 4.3.3.124
2026  * @param tool GoProfileXLine object.
2027  * @return kTRUE if enabled and kFALSE if disabled.
2028  */
2029 GoFx(kBool) GoProfileXLine_RegionEnabled(GoProfileXLine tool);
2030 
2031 /**
2032  * Enables or disables the tool region.
2033  *
2034  * @public @memberof GoProfileXLine
2035  * @version Introduced in firmware 4.3.3.124
2036  * @param tool GoProfileXLine object.
2037  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
2038  * @return Operation status.
2039  */
2040 GoFx(kStatus) GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable);
2041 
2042 /**
2043  * Gets the profile X-Line tool region.
2044  *
2045  * @public @memberof GoProfileXLine
2046  * @version Introduced in firmware 4.3.3.124
2047  * @param tool GoProfileXLine object.
2048  * @return A GoRegion3d object.
2049  */
2050 GoFx(GoProfileRegion) GoProfileXLine_Region(GoProfileXLine tool);
2051 
2052 /**
2053  * Sets the profile X-Line tool maximum tracking speed.
2054  *
2055  * @public @memberof GoProfileXLine
2056  * @version Introduced in firmware 4.3.3.124
2057  * @param tool GoProfileXLine object.
2058  * @param value The value to set.
2059  * @return Operation status.
2060  */
2061 GoFx(kStatus) GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value);
2062 
2063 /**
2064  * Gets the profile X-Line tool maximum tracking speed.
2065  *
2066  * @public @memberof GoProfileXLine
2067  * @version Introduced in firmware 4.3.3.124
2068  * @param tool GoProfileXLine object.
2069  * @return The maximum tracking speed.(mm/s)
2070  */
2071 GoFx(k64f) GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool);
2072 
2073 /**
2074  * Returns a GoProfileXLine Z measurement object.
2075  *
2076  * @public @memberof GoProfileXLine
2077  * @version Introduced in firmware 4.3.3.124
2078  * @param tool GoProfileXLine object.
2079  * @return A GoProfileXLine Z measurement. (mm)
2080  */
2081 GoFx(GoProfileXLineZ) GoProfileXLine_ZMeasurement(GoProfileXLine tool);
2082 
2083 /**
2084  * Returns a GoProfileXLine Validity measurement object.
2085  *
2086  * @public @memberof GoProfileXLine
2087  * @version Introduced in firmware 4.3.3.124
2088  * @param tool GoProfileXLine object.
2089  * @return A GoProfileXLine Validity measurement.
2090  */
2091 GoFx(GoProfileXLineZ) GoProfileXLine_ValidityMeasurement(GoProfileXLine tool);
2092 
2093 
2094 
2095 /**
2096  * @class GoProfileRoundCorner
2097  * @extends GoProfileTool
2098  * @ingroup GoSdk-ProfileTools
2099  * @brief Represents a profile round corner tool.
2100  */
2101 typedef GoProfileTool GoProfileRoundCorner;
2102 
2103 /**
2104  * Returns a GoProfileRoundCorner X measurement object.
2105  *
2106  * @public @memberof GoProfileRoundCorner
2107  * @version Introduced in firmware 4.0.10.27
2108  * @param tool GoProfileRoundCorner object.
2109  * @return A GoProfileRoundCorner X measurement.(mm)
2110  */
2111 GoFx(GoProfileRoundCornerX) GoProfileRoundCorner_XMeasurement(GoProfileRoundCorner tool);
2112 
2113 /**
2114  * Returns a GoProfileRoundCorner Z measurement object.
2115  *
2116  * @public @memberof GoProfileRoundCorner
2117  * @version Introduced in firmware 4.0.10.27
2118  * @param tool GoProfileRoundCorner object.
2119  * @return A GoProfileRoundCorner Z measurement.(mm)
2120  */
2121 GoFx(GoProfileRoundCornerZ) GoProfileRoundCorner_ZMeasurement(GoProfileRoundCorner tool);
2122 
2123 /**
2124  * Returns a GoProfileRoundCorner Angle measurement object.
2125  *
2126  * @public @memberof GoProfileRoundCorner
2127  * @version Introduced in firmware 4.0.10.27
2128  * @param tool GoProfileRoundCorner object.
2129  * @return A GoProfileRoundCorner Angle measurement.(degrees)
2130  */
2131 GoFx(GoProfileRoundCornerAngle) GoProfileRoundCorner_AngleMeasurement(GoProfileRoundCorner tool);
2132 
2133 /**
2134  * Gets the edge.
2135  *
2136  * @public @memberof GoProfileRoundCorner
2137  * @version Introduced in firmware 4.0.10.27
2138  * @param tool GoProfileRoundCorner object.
2139  * @return The edge.
2140  */
2141 GoFx(GoProfileEdge) GoProfileRoundCorner_Edge(GoProfileRoundCorner tool);
2142 
2143 /**
2144  * Sets the edge.
2145  *
2146  * @public @memberof GoProfileRoundCorner
2147  * @version Introduced in firmware 4.0.10.27
2148  * @param tool GoProfileRoundCorner object.
2149  * @param edge The edge.
2150  * @return Operation status.
2151  */
2152 GoFx(kStatus) GoProfileRoundCorner_SetEdge(GoProfileRoundCorner tool, GoProfileEdge edge);
2153 
2154 /**
2155  * Gets the reference direction.
2156  *
2157  * @public @memberof GoProfileRoundCorner
2158  * @version Introduced in firmware 4.0.10.27
2159  * @param tool GoProfileRoundCorner object.
2160  * @return The reference direction.
2161  */
2162 GoFx(GoProfileRoundCornerDirection) GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool);
2163 
2164 /**
2165  * Sets the reference direction.
2166  *
2167  * @public @memberof GoProfileRoundCorner
2168  * @version Introduced in firmware 4.0.10.27
2169  * @param tool GoProfileRoundCorner object.
2170  * @param direction The reference direction.
2171  * @return Operation status.
2172  */
2173 GoFx(kStatus) GoProfileRoundCorner_SetRefDirection(GoProfileRoundCorner tool, GoProfileRoundCornerDirection direction);
2174 
2175 /**
2176 * gets the round corner point
2177 *
2178 * @public @memberof GoProfileRoundCorner
2179 * @version Introduced in firmware 4.0.10.27
2180 * @param tool GoProfileRoundCorner object.
2181 * @return A GoProfileRoundCornerPoint point feature
2182 */
2183 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_Point(GoProfileRoundCorner tool);
2184 
2185 /**
2186 * gets the round corner edge point
2187 *
2188 * @public @memberof GoProfileRoundCorner
2189 * @version Introduced in firmware 4.8.1.80
2190 * @param tool GoProfileRoundCorner object.
2191 * @return A GoProfileRoundCornerEdgePoint point feature
2192 */
2193 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_EdgePoint(GoProfileRoundCorner tool);
2194 
2195 /**
2196 * gets the round corner center point
2197 *
2198 * @public @memberof GoProfileRoundCorner
2199 * @version Introduced in firmware 4.8.1.80
2200 * @param tool GoProfileRoundCorner object.
2201 * @return A GoProfileRoundCornerCenterPoint point feature
2202 */
2203 GoFx(GoProfileRoundCornerCenterPoint) GoProfileRoundCorner_CenterPoint(GoProfileRoundCorner tool);
2204 
2205 kEndHeader()
2206 #include <GoSdk/Tools/GoProfileTools.x.h>
2207 
2208 #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.
GoProfilePanelRightGapPoint GoProfilePanel_RightGapPoint(GoProfilePanel tool)
Returns a GoProfilePanel right gap point feature object.
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.
Represents a right flush point of a Profile Panel tool.
GoProfilePanelGap GoProfilePanel_LeftSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Surface Angle measurement object.
kBool GoProfilePosition_RegionEnabled(GoProfilePosition tool)
Indicates whether the region is enabled.
Represents a Z measurement for a Profile Bounding Box tool.
kStatus GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type)
Sets the reference line type.
Represents a left flush point of a Profile Panel tool.
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)
gets the round corner point
GoProfileEdge GoProfileRoundCorner_Edge(GoProfileRoundCorner tool)
Gets the edge.
kStatus GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth)
Sets the groove depth minimum.
GoProfilePanelGap GoProfilePanel_RightGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap 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.
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 right gap point of a Profile Panel tool.
GoDataStream GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index)
Gets the data stream option at the given index.
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:1184
Represents a data source.
GoProfilePanelGap GoProfilePanel_LeftGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap Z measurement object.
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.
GoProfilePanelGap GoProfilePanel_LeftFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush Z measurement object.
GoProfileRoundCornerDirection GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool)
Gets the reference direction.
Represents an intersect X measurement for a Profile Intersect Tool.
Represents a profile edge used in various profile tools.
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 left gap point of a Profile Panel tool.
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
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.
Represents a profile region used in various profile tools.
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.
GoProfileDimensionCenterPoint GoProfileDim_CenterPoint(GoProfileDim tool)
Returns a GoProfileDim Center point feature object.
GoProfilePanelGap GoProfilePanel_GapPoint(GoProfilePanel tool)
Returns a GoProfilePanel Right Flush X measurement object.
GoProfileAreaCentroidX GoProfileArea_CentroidXMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid X measurement object.
k32s GoProfileTool_XAnchor(GoProfileTool tool)
Gets the current X-anchoring source.
Represents an area measurement for a Profile Area tool.
Selects which reference direction to use for the round corner 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.
Represents a profile edge type.
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.
GoProfilePanelGap GoProfilePanel_LeftGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap X measurement object.
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.
Represents a profile strip tool base type.
GoProfilePanelRightFlushPoint GoProfilePanel_RightFlushPoint(GoProfilePanel tool)
Returns a GoProfilePanel right flush point feature object.
Represents a profile feature used in various profile tools.
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 profile strip tool edge type.
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.
GoProfileGrooveShape GoProfileGroove_Shape(GoProfileGroove tool)
Gets the current groove determination shape.
GoProfilePanelLeftGapPoint GoProfilePanel_LeftGapPoint(GoProfilePanel tool)
Returns a GoProfilePanel Left gap point featuret object.
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.
GoProfilePanelLeftFlushPoint GoProfilePanel_LeftFlushPoint(GoProfilePanel tool)
Returns a GoProfilePanel left flush point feature object.
kStatus GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value)
Sets the minimum width.
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.
Declares shared profile tool configuration classes.
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.
GoProfilePanelGap GoProfilePanel_RightFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Flush Z measurement object.
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.
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.
GoProfilePanelGap GoProfilePanel_RightSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Surface Angle measurement object.
Represents an Z measurement for a Profile X-Line 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.
Determines how to calculate profile area.
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.
GoProfilePanelGap GoProfilePanel_LeftFlushXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush X measurement object.
Determines whether to use a line based on a Profile Line fit, or based on the x-axis.
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.
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.
Represents a center point of a Profile Dimension tool.
Represents a profile position tool.
GoProfilePanelGap GoProfilePanel_RightGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap X measurement object.
Represents a distance value measurement for a Profile Dimension Tool.
GoProfileXLineZ GoProfileXLine_ValidityMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Validity measurement object.