Gocator API

- Home
- Types
- Files

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 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_PROFILE_TOOLS_H
11 #define GO_PROFILE_TOOLS_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoTool.h>
15 #include <GoSdk/Tools/GoProfileToolUtils.h>
16 #include <GoSdk/GoUtils.h>
17
18 kBeginHeader()
19
20 /**
21 * @class GoProfileTool
22 * @extends GoTool
23 * @ingroup GoSdk-ProfileTools
24 * @brief Represents a base profile tool.
25 */
26 typedef GoTool GoProfileTool;
27
28
29 /**
30 * Sets the data stream. Note that stream validation will only occur if tool
31 * is in the tool options list.
32 *
33 * @public @memberof GoProfileTool
34 * @version Introduced in firmware 4.4.4.14
35 * @param tool GoProfileTool object.
36 * @param stream GoDataStream value.
37 * @return Operation status.
38 * @see GoProfileTool_StreamOptionCount, GoProfileTool_StreamOptionAt
39 */
40 GoFx(kStatus) GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream);
41
42 /**
43 * Gets the data stream.
44 *
45 * @public @memberof GoProfileTool
46 * @version Introduced in firmware 4.4.4.14
47 * @param tool GoProfileTool object.
48 * @return The current profile tool data stream value.
49 */
50 GoFx(GoDataStream) GoProfileTool_Stream(GoProfileTool tool);
51
52 /**
53 * Gets the data stream option list count.
54 *
55 * @public @memberof GoProfileTool
56 * @version Introduced in firmware 4.4.4.14
57 * @param tool GoProfileTool object.
58 * @return The current profile tool data stream option list count.
59 */
60 GoFx(kSize) GoProfileTool_StreamOptionCount(GoProfileTool tool);
61
62 /**
63 * Gets the data stream option at the given index.
64 *
65 * @public @memberof GoProfileTool
66 * @version Introduced in firmware 4.4.4.14
67 * @param tool GoProfileTool object.
68 * @param index The index of the option list to access.
69 * @return The profile tool data stream option at the given index, or k32U_MAX if an invalid index is given.
70 */
71 GoFx(GoDataStream) GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index);
72
73 /**
74 * Sets the data source. Note that source validation will only occur if tool
75 * is in the tool options list.
76 *
77 * @public @memberof GoProfileTool
78 * @version Introduced in firmware 4.0.10.27
79 * @param tool GoProfileTool object.
80 * @param source GoDataSource object.
81 * @return Operation status.
82 * @see GoTools_ToolOptionCount, GoTools_ToolOptionAt
83 */
84 GoFx(kStatus) GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source);
85
86 /**
87 * Gets the data source.
88 *
89 * @public @memberof GoProfileTool
90 * @version Introduced in firmware 4.0.10.27
91 * @param tool GoProfileTool object.
92 * @return The current profile tool data source.
93 */
94 GoFx(GoDataSource) GoProfileTool_Source(GoProfileTool tool);
95
96 /**
97 * Gets the data source option list count.
98 *
99 * @public @memberof GoProfileTool
100 * @version Introduced in firmware 4.0.10.27
101 * @param tool GoProfileTool object.
102 * @return The current profile tool data source option list count.
103 */
104 GoFx(kSize) GoProfileTool_SourceOptionCount(GoProfileTool tool);
105
106 /**
107 * Gets the data source option at the given index.
108 *
109 * @public @memberof GoProfileTool
110 * @version Introduced in firmware 4.0.10.27
111 * @param tool GoProfileTool object.
112 * @param index The index of the option list to access.
113 * @return The profile tool data source option at the given index, or k32U_MAX if an invalid index is given.
114 */
115 GoFx(GoDataSource) GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index);
116
117 /**
118 * Gets the X-anchoring option list count.
119 *
120 * @public @memberof GoProfileTool
121 * @version Introduced in firmware 4.0.10.27
122 * @param tool GoProfileTool object.
123 * @return The X-anchoring option list count.
124 */
125 GoFx(kSize) GoProfileTool_XAnchorOptionCount(GoProfileTool tool);
126
127 /**
128 * Gets the X-anchoring option at the given index.
129 *
130 * @public @memberof GoProfileTool
131 * @version Introduced in firmware 4.0.10.27
132 * @param tool GoProfileTool object.
133 * @param index The index of the option list to access.
134 * @return The X-anchoring option at the given index or k32U_MAX if invalid.
135 */
136 GoFx(k32u) GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index);
137
138 /**
139 * Gets the current X-anchoring source.
140 *
141 * @public @memberof GoProfileTool
142 * @version Introduced in firmware 4.0.10.27
143 * @param tool GoProfileTool object.
144 * @return The X-anchoring source or -1 if no source is currently set.
145 */
146 GoFx(k32s) GoProfileTool_XAnchor(GoProfileTool tool);
147
148 /**
149 * Sets the X-anchoring source.
150 *
151 * @public @memberof GoProfileTool
152 * @version Introduced in firmware 4.0.10.27
153 * @param tool GoProfileTool object.
154 * @param id The measurement ID of a valid X-anchoring source.
155 * @return Operation status.
156 */
157 GoFx(kStatus) GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id);
158
159 /**
160 * Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.
161 *
162 * @public @memberof GoProfileTool
163 * @version Introduced in firmware 4.0.10.27
164 * @param tool GoProfileTool object.
165 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
166 */
167 GoFx(kBool) GoProfileTool_XAnchorEnabled(GoProfileTool tool);
168
169 /**
170 * Gets the Z-anchoring option list count.
171 *
172 * @public @memberof GoProfileTool
173 * @version Introduced in firmware 4.0.10.27
174 * @param tool GoProfileTool object.
175 * @return The X-anchoring option list count.
176 */
177 GoFx(kSize) GoProfileTool_ZAnchorOptionCount(GoProfileTool tool);
178
179 /**
180 * Gets the Z-anchoring option at the given index.
181 *
182 * @public @memberof GoProfileTool
183 * @version Introduced in firmware 4.0.10.27
184 * @param tool GoProfileTool object.
185 * @param index The index of the option list to access.
186 * @return The Z-anchoring option at the given index or k32U_MAX if invalid.
187 */
188 GoFx(k32u) GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index);
189
190 /**
191 * Gets the current Z-anchoring source.
192 *
193 * @public @memberof GoProfileTool
194 * @version Introduced in firmware 4.0.10.27
195 * @param tool GoProfileTool object.
196 * @return The Z-anchoring source or -1 if no source is currently set.
197 */
198 GoFx(k32s) GoProfileTool_ZAnchor(GoProfileTool tool);
199
200 /**
201 * Sets the Z-anchoring source.
202 *
203 * @public @memberof GoProfileTool
204 * @version Introduced in firmware 4.0.10.27
205 * @param tool GoProfileTool object.
206 * @param id The measurement ID of a valid Z-anchoring source.
207 * @return Operation status.
208 */
209 GoFx(kStatus) GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id);
210
211 /**
212 * Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.
213 *
214 * @public @memberof GoProfileTool
215 * @version Introduced in firmware 4.0.10.27
216 * @param tool GoProfileTool object.
217 * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
218 */
219 GoFx(kBool) GoProfileTool_ZAnchorEnabled(GoProfileTool tool);
220
221
222 /**
223 * @class GoProfileArea
224 * @extends GoProfileTool
225 * @ingroup GoSdk-ProfileTools
226 * @brief Represents a profile area tool.
227 */
228 typedef GoProfileTool GoProfileArea;
229
230 /**
231 * Gets the profile area baseline.
232 *
233 * @public @memberof GoProfileArea
234 * @version Introduced in firmware 4.0.10.27
235 * @param tool GoProfileArea object.
236 * @return The profile area baseline.
237 */
238 GoFx(GoProfileBaseline) GoProfileArea_Baseline(GoProfileArea tool);
239
240 /**
241 * Sets the profile area type.
242 *
243 * @public @memberof GoProfileArea
244 * @version Introduced in firmware 4.0.10.27
245 * @param tool GoProfileArea object.
246 * @param type The baseline type to set.
247 * @return Operation status.
248 */
249 GoFx(kStatus) GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type);
250
251 /**
252 * Returns a boolean representing whether the profile area baseline is used.
253 *
254 * @public @memberof GoProfileArea
255 * @version Introduced in firmware 4.0.10.27
256 * @param tool GoProfileArea object.
257 * @return kTRUE if the baseline is used; kFALSE otherwise.
258 */
259 GoFx(kBool) GoProfileArea_BaselineUsed(GoProfileArea tool);
260
261 /**
262 * Gets the reference profile line.
263 *
264 * @public @memberof GoProfileArea
265 * @version Introduced in firmware 4.0.10.27
266 * @param tool GoProfileArea object.
267 * @return The reference profile line.
268 */
269 GoFx(GoProfileLineRegion) GoProfileArea_LineRegion(GoProfileArea tool);
270
271 /**
272 * Gets the profile area type.
273 *
274 * @public @memberof GoProfileArea
275 * @version Introduced in firmware 4.0.10.27
276 * @param tool GoProfileArea object.
277 * @return The profile area type.
278 */
279 GoFx(GoProfileAreaType) GoProfileArea_Type(GoProfileArea tool);
280
281 /**
282 * Gets the boolean representing whether the area type is used.
283 *
284 * @public @memberof GoProfileArea
285 * @version Introduced in firmware 4.0.10.27
286 * @param tool GoProfileArea object.
287 * @return kTRUE if profile area type is used; kFALSE otherwise.
288 */
289 GoFx(kBool) GoProfileArea_TypeUsed(GoProfileArea tool);
290
291 /**
292 * Sets the profile area type.
293 *
294 * @public @memberof GoProfileArea
295 * @version Introduced in firmware 4.0.10.27
296 * @param tool GoProfileArea object.
297 * @param type GoProfileAreaType object.
298 * @return Operation status.
299 */
300 GoFx(kStatus) GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type);
301
302 /**
303 * Gets the profile region.
304 *
305 * @public @memberof GoProfileArea
306 * @version Introduced in firmware 4.0.10.27
307 * @param tool GoProfileArea object.
308 * @return The profile region.
309 */
310 GoFx(GoProfileRegion) GoProfileArea_Region(GoProfileArea tool);
311
312 /**
313 * Indicates whether the region is enabled.
314 *
315 * @public @memberof GoProfileArea
316 * @version Introduced in firmware 4.4.4.14
317 * @param tool GoProfileArea object.
318 * @return kTRUE if enabled and kFALSE otherwise.
319 */
320 GoFx(kBool) GoProfileArea_RegionEnabled(GoProfileArea tool);
321
322 /**
323 * Enables or disables the region.
324 *
325 * @public @memberof GoProfileArea
326 * @version Introduced in firmware 4.4.4.14
327 * @param tool GoProfileArea object.
328 * @param enable kTRUE to enable the region and kFALSE to disable it.
329 * @return Operation status.
330 */
331 GoFx(kStatus) GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable);
332
333 /**
334 * Returns a GoProfileArea Area measurement object.
335 *
336 * @public @memberof GoProfileArea
337 * @version Introduced in firmware 4.0.10.27
338 * @param tool GoProfileArea object.
339 * @return A GoProfileAreaArea measurement.
340 */
341 GoFx(GoProfileAreaArea) GoProfileArea_AreaMeasurement(GoProfileArea tool);
342
343 /**
344 * Returns a GoProfileArea Centroid X measurement object.
345 *
346 * @public @memberof GoProfileArea
347 * @version Introduced in firmware 4.0.10.27
348 * @param tool GoProfileArea object.
349 * @return A GoProfileAreaCentroidX measurement.
350 */
351 GoFx(GoProfileAreaCentroidX) GoProfileArea_CentroidXMeasurement(GoProfileArea tool);
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 */
361 GoFx(GoProfileAreaCentroidZ) GoProfileArea_CentroidZMeasurement(GoProfileArea tool);
362
363
364 /**
365 * @class GoProfileBox
366 * @extends GoProfileTool
367 * @ingroup GoSdk-ProfileTools
368 * @brief Represents a profile bounding box tool.
369 */
370 typedef GoProfileTool GoProfileBox;
371
372 /**
373 * Returns the enabled state of the tool region.
374 *
375 * @public @memberof GoProfileBox
376 * @version Introduced in firmware 4.2.4.7
377 * @param tool GoProfileBox object.
378 * @return kTRUE if enabled and kFALSE if disabled.
379 */
380 GoFx(kBool) GoProfileBox_RegionEnabled(GoProfileBox tool);
381
382 /**
383 * Enables or disables the tool region.
384 *
385 * @public @memberof GoProfileBox
386 * @version Introduced in firmware 4.2.4.7
387 * @param tool GoProfileBox object.
388 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
389 * @return Operation status.
390 */
391 GoFx(kStatus) GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable);
392
393 /**
394 * Gets the profile bounding box region.
395 *
396 * @public @memberof GoProfileBox
397 * @version Introduced in firmware 4.2.4.7
398 * @param tool GoProfileBox object.
399 * @return A GoRegion3d object.
400 */
401 GoFx(GoProfileRegion) GoProfileBox_Region(GoProfileBox tool);
402
403 /**
404 * Returns a GoProfileBox X measurement object.
405 *
406 * @public @memberof GoProfileBox
407 * @version Introduced in firmware 4.2.4.7
408 * @param tool GoProfileBox object.
409 * @return A GoProfileBox X measurement.
410 */
411 GoFx(GoProfileBoxX) GoProfileBox_XMeasurement(GoProfileBox tool);
412
413 /**
414 * Returns a GoProfileBox Z measurement object.
415 *
416 * @public @memberof GoProfileBox
417 * @version Introduced in firmware 4.2.4.7
418 * @param tool GoProfileBox object.
419 * @return A GoProfileBox Z measurement.
420 */
421 GoFx(GoProfileBoxZ) GoProfileBox_ZMeasurement(GoProfileBox tool);
422
423 /**
424 * Returns a GoProfileBox Width measurement object.
425 *
426 * @public @memberof GoProfileBox
427 * @version Introduced in firmware 4.2.4.7
428 * @param tool GoProfileBox object.
429 * @return A GoProfileBox Width measurement.
430 */
431 GoFx(GoProfileBoxWidth) GoProfileBox_WidthMeasurement(GoProfileBox tool);
432
433 /**
434 * Returns a GoProfileBox Height measurement object.
435 *
436 * @public @memberof GoProfileBox
437 * @version Introduced in firmware 4.2.4.7
438 * @param tool GoProfileBox object.
439 * @return A GoProfileBox Height measurement.
440 */
441 GoFx(GoProfileBoxHeight) GoProfileBox_HeightMeasurement(GoProfileBox tool);
442
443 /**
444 * Returns a GoProfileBox global X measurement object.
445 *
446 * @public @memberof GoProfileBox
447 * @version Introduced in firmware 4.2.4.7
448 * @param tool GoProfileBox object.
449 * @return A GoProfileBox global X measurement.
450 */
451 GoFx(GoProfileBoxGlobalX) GoProfileBox_GlobalXMeasurement(GoProfileBox tool);
452
453 /**
454 * Returns a GoProfileBox global Y measurement object.
455 *
456 * @public @memberof GoProfileBox
457 * @version Introduced in firmware 4.4.4.14
458 * @param tool GoProfileBox object.
459 * @return A GoProfileBox global Y measurement.
460 */
461 GoFx(GoProfileBoxGlobalY) GoProfileBox_GlobalYMeasurement(GoProfileBox tool);
462
463 /**
464 * Returns a GoProfileBox global Angle measurement object.
465 *
466 * @public @memberof GoProfileBox
467 * @version Introduced in firmware 4.4.4.14
468 * @param tool GoProfileBox object.
469 * @return A GoProfileBox global angle measurement.
470 */
471 GoFx(GoProfileBoxGlobalAngle) GoProfileBox_GlobalAngleMeasurement(GoProfileBox tool);
472
473 /**
474 * @class GoProfileBridgeValue
475 * @extends GoProfileTool
476 * @ingroup GoSdk-ProfileTools
477 * @brief Represents a profile bridge value tool.
478 */
479 typedef GoProfileTool GoProfileBridgeValue;
480
481 /**
482 * Returns the enabled state of the tool region.
483 *
484 * @public @memberof GoProfileBridgeValue
485 * @version Introduced in firmware 4.3.3.124
486 * @param tool GoProfileBridgeValue object.
487 * @return kTRUE if enabled and kFALSE if disabled.
488 */
489 GoFx(kBool) GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool);
490
491 /**
492 * Enables or disables the tool region.
493 *
494 * @public @memberof GoProfileBridgeValue
495 * @version Introduced in firmware 4.3.3.124
496 * @param tool GoProfileBridgeValue object.
497 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
498 * @return Operation status.
499 */
500 GoFx(kStatus) GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable);
501
502 /**
503 * Gets the bridge value profile region.
504 *
505 * @public @memberof GoProfileBridgeValue
506 * @version Introduced in firmware 4.3.3.124
507 * @param tool GoProfileArea object.
508 * @return The profile region.
509 */
510 GoFx(GoProfileRegion) GoProfileBridgeValue_Region(GoProfileBridgeValue tool);
511
512
513 /**
514 * Returns the enabled state of normalization.
515 *
516 * @public @memberof GoProfileBridgeValue
517 * @version Introduced in firmware 4.3.3.124
518 * @param tool GoProfileBridgeValue object.
519 * @return kTRUE if enabled and kFALSE if disabled.
520 */
521 GoFx(kBool) GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool);
522
523 /**
524 * Enables or disables normalization.
525 *
526 * @public @memberof GoProfileBridgeValue
527 * @version Introduced in firmware 4.3.3.124
528 * @param tool GoProfileBridgeValue object.
529 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
530 * @return Operation status.
531 */
532 GoFx(kStatus) GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable);
533
534 /**
535 * Sets the profile X-Line tool window size percentage.
536 *
537 * @public @memberof GoProfileBridgeValue
538 * @version Introduced in firmware 4.3.3.124
539 * @param tool GoProfileBridgeValue object.
540 * @param value The value to set.
541 * @return Operation status.
542 */
543 GoFx(kStatus) GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value);
544
545 /**
546 * Gets the profile X-Line tool window size percentage.
547 *
548 * @public @memberof GoProfileBridgeValue
549 * @version Introduced in firmware 4.3.3.124
550 * @param tool GoProfileBridgeValue object.
551 * @return The window size.
552 */
553 GoFx(k64f) GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool);
554
555 /**
556 * Sets the profile X-Line tool window skip percentage.
557 *
558 * @public @memberof GoProfileBridgeValue
559 * @version Introduced in firmware 4.3.3.124
560 * @param tool GoProfileBridgeValue object.
561 * @param value The value to set.
562 * @return Operation status.
563 */
564 GoFx(kStatus) GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value);
565
566 /**
567 * Gets the profile X-Line tool window skip percentage.
568 *
569 * @public @memberof GoProfileBridgeValue
570 * @version Introduced in firmware 4.3.3.124
571 * @param tool GoProfileBridgeValue object.
572 * @return The window size.
573 */
574 GoFx(k64f) GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool);
575
576 /**
577 * Sets the profile X-Line tool max invalid percentage.
578 *
579 * @public @memberof GoProfileBridgeValue
580 * @version Introduced in firmware 4.3.3.124
581 * @param tool GoProfileBridgeValue object.
582 * @param value The value to set.
583 * @return Operation status.
584 */
585 GoFx(kStatus) GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value);
586
587 /**
588 * Gets the profile X-Line tool max invalid percentage.
589 *
590 * @public @memberof GoProfileBridgeValue
591 * @version Introduced in firmware 4.3.3.124
592 * @param tool GoProfileBridgeValue object.
593 * @return The window size.
594 */
595 GoFx(k64f) GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool);
596
597 /**
598 * Sets the profile X-Line tool max differential.
599 *
600 * @public @memberof GoProfileBridgeValue
601 * @version Introduced in firmware 4.3.3.124
602 * @param tool GoProfileBridgeValue object.
603 * @param value The value to set.
604 * @return Operation status.
605 */
606 GoFx(kStatus) GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value);
607
608 /**
609 * Gets the profile X-Line tool max differential.
610 *
611 * @public @memberof GoProfileBridgeValue
612 * @version Introduced in firmware 4.3.3.124
613 * @param tool GoProfileBridgeValue object.
614 * @return The max differential.
615 */
616 GoFx(k64f) GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool);
617
618 /**
619 * Gets the profile X-Line tool max differential maximum value limit.
620 *
621 * @public @memberof GoProfileBridgeValue
622 * @version Introduced in firmware 4.3.3.124
623 * @param tool GoProfileBridgeValue object.
624 * @return The max differential maximum value limit.
625 */
626 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool);
627
628 /**
629 * Gets the profile X-Line tool max differential minimum value limit.
630 * NOTE: A value of 0 will result in an automated differential determination.
631 *
632 * @public @memberof GoProfileBridgeValue
633 * @version Introduced in firmware 4.3.3.124
634 * @param tool GoProfileBridgeValue object.
635 * @return The max differential minimum value limit.
636 */
637 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool);
638
639 /**
640 * Returns a GoProfileBridgeValue bridge value measurement object.
641 *
642 * @public @memberof GoProfileBridgeValue
643 * @version Introduced in firmware 4.3.3.124
644 * @param tool GoProfileBridgeValue object.
645 * @return A GoProfileBridgeValue bridge value measurement.
646 */
647 GoFx(GoProfileBridgeValueBridgeValue) GoProfileBridgeValue_BridgeValueMeasurement(GoProfileBridgeValue tool);
648
649 /**
650 * Returns a GoProfileBridgeValue angle measurement object.
651 *
652 * @public @memberof GoProfileBridgeValue
653 * @version Introduced in firmware 4.3.3.124
654 * @param tool GoProfileBridgeValue object.
655 * @return A GoProfileBridgeValue angle measurement.
656 */
657 GoFx(GoProfileBridgeValueAngle) GoProfileBridgeValue_AngleMeasurement(GoProfileBridgeValue tool);
658
659
660 /**
661 * @class GoProfileCircle
662 * @extends GoProfileTool
663 * @ingroup GoSdk-ProfileTools
664 * @brief Represents a profile circle tool.
665 */
666 typedef GoProfileTool GoProfileCircle;
667
668 /**
669 * Gets the profile region.
670 *
671 * @public @memberof GoProfileCircle
672 * @version Introduced in firmware 4.0.10.27
673 * @param tool GoProfileCircle object.
674 * @return The profile region.
675 */
676 GoFx(GoProfileRegion) GoProfileCircle_Region(GoProfileCircle tool);
677
678 /**
679 * Indicates whether the region is enabled.
680 *
681 * @public @memberof GoProfileCircle
682 * @version Introduced in firmware 4.4.4.14
683 * @param tool GoProfileCircle object.
684 * @return kTRUE if enabled and kFALSE otherwise.
685 */
686 GoFx(kBool) GoProfileCircle_RegionEnabled(GoProfileCircle tool);
687
688 /**
689 * Enables or disables the region.
690 *
691 * @public @memberof GoProfileCircle
692 * @version Introduced in firmware 4.4.4.14
693 * @param tool GoProfileCircle object.
694 * @param enable kTRUE to enable the region and kFALSE to disable it.
695 * @return Operation status.
696 */
697 GoFx(kStatus) GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable);
698
699 /**
700 * Returns a GoProfileCircle X measurement object.
701 *
702 * @public @memberof GoProfileCircle
703 * @version Introduced in firmware 4.0.10.27
704 * @param tool GoProfileCircle object.
705 * @return A GoProfileCircleX measurement.
706 */
707 GoFx(GoProfileCircleX) GoProfileCircle_XMeasurement(GoProfileCircle tool);
708
709 /**
710 * Returns a GoProfileCircle Z measurement object.
711 *
712 * @public @memberof GoProfileCircle
713 * @version Introduced in firmware 4.0.10.27
714 * @param tool GoProfileCircle object.
715 * @return A GoProfileCircleZ measurement.
716 */
717 GoFx(GoProfileCircleZ) GoProfileCircle_ZMeasurement(GoProfileCircle tool);
718
719 /**
720 * Returns a GoProfileCircle Radius measurement object.
721 *
722 * @public @memberof GoProfileCircle
723 * @version Introduced in firmware 4.0.10.27
724 * @param tool GoProfileCircle object.
725 * @return A GoProfileCircle Radius measurement.
726 */
727 GoFx(GoProfileCircleRadius) GoProfileCircle_RadiusMeasurement(GoProfileCircle tool);
728
729
730 /**
731 * @class GoProfileDim
732 * @extends GoProfileTool
733 * @ingroup GoSdk-ProfileTools
734 * @brief Represents a profile dimension tool.
735 */
736 typedef GoProfileTool GoProfileDim;
737
738
739 /**
740 * Gets the reference profile feature.
741 *
742 * @public @memberof GoProfileDim
743 * @version Introduced in firmware 4.0.10.27
744 * @param tool GoProfileDim object.
745 * @return The reference profile feature object.
746 */
747 GoFx(GoProfileFeature) GoProfileDim_RefFeature(GoProfileDim tool);
748
749 /**
750 * Gets the non-reference profile feature.
751 *
752 * @public @memberof GoProfileDim
753 * @version Introduced in firmware 4.0.10.27
754 * @param tool GoProfileDim object.
755 * @return The profile feature object.
756 */
757 GoFx(GoProfileFeature) GoProfileDim_Feature(GoProfileDim tool);
758
759 /**
760 * Returns a GoProfileDim Width measurement object.
761 *
762 * @public @memberof GoProfileDim
763 * @version Introduced in firmware 4.0.10.27
764 * @param tool GoProfileDim object.
765 * @return A GoProfileDimWidth measurement.
766 */
767 GoFx(GoProfileDimWidth) GoProfileDim_WidthMeasurement(GoProfileDim tool);
768
769 /**
770 * Returns a GoProfileDim Height measurement object.
771 *
772 * @public @memberof GoProfileDim
773 * @version Introduced in firmware 4.0.10.27
774 * @param tool GoProfileDim object.
775 * @return A GoProfileDimHeight measurement.
776 */
777 GoFx(GoProfileDimHeight) GoProfileDim_HeightMeasurement(GoProfileDim tool);
778
779 /**
780 * Returns a GoProfileDim Distance measurement object.
781 *
782 * @public @memberof GoProfileDim
783 * @version Introduced in firmware 4.0.10.27
784 * @param tool GoProfileDim object.
785 * @return A GoProfileDimDistance measurement.
786 */
787 GoFx(GoProfileDimDistance) GoProfileDim_DistanceMeasurement(GoProfileDim tool);
788
789 /**
790 * Returns a GoProfileDim Center X measurement object.
791 *
792 * @public @memberof GoProfileDim
793 * @version Introduced in firmware 4.0.10.27
794 * @param tool GoProfileDim object.
795 * @return A GoProfileDimCenterX measurement.
796 */
797 GoFx(GoProfileDimCenterX) GoProfileDim_CenterXMeasurement(GoProfileDim tool);
798
799 /**
800 * Returns a GoProfileDim Center Z measurement object.
801 *
802 * @public @memberof GoProfileDim
803 * @version Introduced in firmware 4.0.10.27
804 * @param tool GoProfileDim object.
805 * @return A GoProfileDimCenterZ measurement.
806 */
807 GoFx(GoProfileDimCenterZ) GoProfileDim_CenterZMeasurement(GoProfileDim tool);
808
809
810 /**
811 * @class GoProfileGroove
812 * @extends GoProfileTool
813 * @ingroup GoSdk-ProfileTools
814 * @brief Represents a profile groove tool.
815 */
816 typedef GoProfileTool GoProfileGroove;
817
818 /**
819 * Adds an additional profile groove tool measurement.
820 *
821 * @public @memberof GoProfileGroove
822 * @version Introduced in firmware 4.0.10.27
823 * @param tool GoProfileGroove object.
824 * @param type The measurement type to add. It must be a valid profile groove tool type.
825 * @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.
826 * @return Operation status.
827 */
828 GoFx(kStatus) GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement* measurement);
829
830 /**
831 * Removes a measurement from the tool at the given index.
832 *
833 * @public @memberof GoProfileGroove
834 * @version Introduced in firmware 4.0.10.27
835 * @param tool GoProfileGroove object.
836 * @param index The index with which to remove a measurement.
837 * @return Operation status.
838 */
839 GoFx(kStatus) GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index);
840
841 /**
842 * Returns the measurement count for the given tool.
843 *
844 * @public @memberof GoProfileGroove
845 * @version Introduced in firmware 4.0.10.27
846 * @param tool GoProfileGroove object.
847 * @return Tool measurement count.
848 */
849 GoFx(kSize) GoProfileGroove_MeasurementCount(GoProfileGroove tool);
850
851 /**
852 * Returns a measurement object at the given index.
853 *
854 * @public @memberof GoProfileGroove
855 * @version Introduced in firmware 4.0.10.27
856 * @param tool GoProfileGroove object.
857 * @param index The index with which to return a measurement object.
858 * @return A profile groove tool measurement or kNULL if the index is invalid.
859 */
860 GoFx(GoMeasurement) GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index);
861
862 /**
863 * Gets the current groove determination shape.
864 *
865 * @public @memberof GoProfileGroove
866 * @version Introduced in firmware 4.0.10.27
867 * @param tool GoProfileGroove object.
868 * @return The profile groove shape.
869 */
870 GoFx(GoProfileGrooveShape) GoProfileGroove_Shape(GoProfileGroove tool);
871
872 /**
873 * Sets the groove determination shape.
874 *
875 * @public @memberof GoProfileGroove
876 * @version Introduced in firmware 4.0.10.27
877 * @param tool GoProfileGroove object.
878 * @param shape The intended profile groove shape.
879 * @return Operation status.
880 */
881 GoFx(kStatus) GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape);
882
883 /**
884 * Gets the groove depth minimum.
885 *
886 * @public @memberof GoProfileGroove
887 * @version Introduced in firmware 4.0.10.27
888 * @param tool GoProfileGroove object.
889 * @return The groove depth minimum value.
890 */
891 GoFx(k64f) GoProfileGroove_MinDepth(GoProfileGroove tool);
892
893 /**
894 * Sets the groove depth minimum.
895 *
896 * @public @memberof GoProfileGroove
897 * @version Introduced in firmware 4.0.10.27
898 * @param tool GoProfileGroove object.
899 * @param depth The minimum groove depth value to set.
900 * @return Operation status.
901 */
902 GoFx(kStatus) GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth);
903
904 /**
905 * Gets the groove width maximum.
906 *
907 * @public @memberof GoProfileGroove
908 * @version Introduced in firmware 4.0.10.27
909 * @param tool GoProfileGroove object.
910 * @return The groove width maximum value.
911 */
912 GoFx(k64f) GoProfileGroove_MaxWidth(GoProfileGroove tool);
913
914 /**
915 * Sets the groove width maximum.
916 *
917 * @public @memberof GoProfileGroove
918 * @version Introduced in firmware 4.0.10.27
919 * @param tool GoProfileGroove object.
920 * @param width The maximum groove width value to set.
921 * @return Operation status.
922 */
923 GoFx(kStatus) GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width);
924
925 /**
926 * Gets the groove width minimum value.
927 *
928 * @public @memberof GoProfileGroove
929 * @version Introduced in firmware 4.0.10.27
930 * @param tool GoProfileGroove object.
931 * @return The groove width minimum.
932 */
933 GoFx(k64f) GoProfileGroove_MinWidth(GoProfileGroove tool);
934
935 /**
936 * Sets the groove width minimum.
937 *
938 * @public @memberof GoProfileGroove
939 * @version Introduced in firmware 4.0.10.27
940 * @param tool GoProfileGroove object.
941 * @param width The minimum groove width value to set.
942 * @return Operation status.
943 */
944 GoFx(kStatus) GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width);
945
946 /**
947 * Gets the profile region.
948 *
949 * @public @memberof GoProfileGroove
950 * @version Introduced in firmware 4.0.10.27
951 * @param tool GoProfileGroove object.
952 * @return The profile region.
953 */
954 GoFx(GoProfileRegion) GoProfileGroove_Region(GoProfileGroove tool);
955
956 /**
957 * Indicates whether the region is enabled.
958 *
959 * @public @memberof GoProfileGroove
960 * @version Introduced in firmware 4.4.4.14
961 * @param tool GoProfileGroove object.
962 * @return kTRUE if enabled and kFALSE otherwise.
963 */
964 GoFx(kBool) GoProfileGroove_RegionEnabled(GoProfileGroove tool);
965
966 /**
967 * Enables or disables the region.
968 *
969 * @public @memberof GoProfileGroove
970 * @version Introduced in firmware 4.4.4.14
971 * @param tool GoProfileGroove object.
972 * @param enable kTRUE to enable the region and kFALSE to disable it.
973 * @return Operation status.
974 */
975 GoFx(kStatus) GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable);
976
977
978 /**
979 * @class GoProfileIntersect
980 * @extends GoProfileTool
981 * @ingroup GoSdk-ProfileTools
982 * @brief Represents a profile intersect tool.
983 */
984 typedef GoProfileTool GoProfileIntersect;
985
986
987 /**
988 * Gets the reference profile line type.
989 *
990 * @public @memberof GoProfileIntersect
991 * @version Introduced in firmware 4.0.10.27
992 * @param tool GoProfileIntersect object.
993 * @return The profile line type.
994 */
995 GoFx(GoProfileBaseline) GoProfileIntersect_RefLineType(GoProfileIntersect tool);
996
997 /**
998 * Sets the reference line type.
999 *
1000 * @public @memberof GoProfileIntersect
1001 * @version Introduced in firmware 4.0.10.27
1002 * @param tool GoProfileIntersect object.
1003 * @param type The line type to set.
1004 * @return
1005 */
1006 GoFx(kStatus) GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type);
1007
1008 /**
1009 * Gets the reference profile line.
1010 *
1011 * @public @memberof GoProfileIntersect
1012 * @version Introduced in firmware 4.0.10.27
1013 * @param tool GoProfileIntersect object.
1014 * @return The reference profile line.
1015 */
1016 GoFx(GoProfileLineRegion) GoProfileIntersect_RefLine(GoProfileIntersect tool);
1017
1018 /**
1019 * Gets the non-reference profile line.
1020 *
1021 * @public @memberof GoProfileIntersect
1022 * @version Introduced in firmware 4.0.10.27
1023 * @param tool GoProfileIntersect object.
1024 * @return The non-reference profile line.
1025 */
1026 GoFx(GoProfileLineRegion) GoProfileIntersect_Line(GoProfileIntersect tool);
1027
1028 /**
1029 * Returns a GoProfileIntersect X measurement object.
1030 *
1031 * @public @memberof GoProfileIntersect
1032 * @version Introduced in firmware 4.0.10.27
1033 * @param tool GoProfileIntersect object.
1034 * @return A GoProfileIntersect X measurement.
1035 */
1036 GoFx(GoProfileIntersectX) GoProfileIntersect_XMeasurement(GoProfileIntersect tool);
1037
1038 /**
1039 * Returns a GoProfileIntersect Z measurement object.
1040 *
1041 * @public @memberof GoProfileIntersect
1042 * @version Introduced in firmware 4.0.10.27
1043 * @param tool GoProfileIntersect object.
1044 * @return A GoProfileIntersect Z measurement.
1045 */
1046 GoFx(GoProfileIntersectZ) GoProfileIntersect_ZMeasurement(GoProfileIntersect tool);
1047
1048 /**
1049 * Returns a GoProfileIntersect Angle measurement object.
1050 *
1051 * @public @memberof GoProfileIntersect
1052 * @version Introduced in firmware 4.0.10.27
1053 * @param tool GoProfileIntersect object.
1054 * @return A GoProfileIntersect Angle measurement.
1055 */
1056 GoFx(GoProfileIntersectAngle) GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool);
1057
1058
1059 /**
1060 * @class GoProfileLine
1061 * @extends GoProfileTool
1062 * @ingroup GoSdk-ProfileTools
1063 * @brief Represents a profile line tool.
1064 */
1065 typedef GoProfileTool GoProfileLine;
1066
1067 /**
1068 * Gets the profile region.
1069 *
1070 * @public @memberof GoProfileDev
1071 * @version Introduced in firmware 4.0.10.27
1072 * @param tool GoProfileDev object.
1073 * @return The profile region.
1074 */
1075 GoFx(GoProfileRegion) GoProfileLine_Region(GoProfileLine tool);
1076
1077 /**
1078 * Indicates whether the region is enabled.
1079 *
1080 * @public @memberof GoProfileLine
1081 * @version Introduced in firmware 4.4.4.14
1082 * @param tool GoProfileLine object.
1083 * @return kTRUE if enabled and kFALSE otherwise.
1084 */
1085 GoFx(kBool) GoProfileLine_RegionEnabled(GoProfileLine tool);
1086
1087 /**
1088 * Enables or disables the region.
1089 *
1090 * @public @memberof GoProfileLine
1091 * @version Introduced in firmware 4.4.4.14
1092 * @param tool GoProfileLine object.
1093 * @param enable kTRUE to enable the region and kFALSE to disable it.
1094 * @return Operation status.
1095 */
1096 GoFx(kStatus) GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable);
1097
1098 /**
1099 * Returns a GoProfileLine Standard Deviation measurement object.
1100 *
1101 * @public @memberof GoProfileLine
1102 * @version Introduced in firmware 4.0.10.27
1103 * @param tool GoProfileLine object.
1104 * @return A GoProfileLine Standard Deviation measurement.
1105 */
1106 GoFx(GoProfileLineStdDev) GoProfileLine_StdDevMeasurement(GoProfileLine tool);
1107
1108 /**
1109 * Returns a GoProfileLine Maximum Error measurement object.
1110 *
1111 * @public @memberof GoProfileLine
1112 * @version Introduced in firmware 4.0.10.27
1113 * @param tool GoProfileLine object.
1114 * @return A GoProfileLine Maximum Error measurement.
1115 */
1116 GoFx(GoProfileLineMaxError) GoProfileLine_MaxErrorMeasurement(GoProfileLine tool);
1117
1118 /**
1119 * Returns a GoProfileLine Minimum Error measurement object.
1120 *
1121 * @public @memberof GoProfileLine
1122 * @version Introduced in firmware 4.0.10.27
1123 * @param tool GoProfileLine object.
1124 * @return A GoProfileLine Minimum Error measurement.
1125 */
1126 GoFx(GoProfileLineMinError) GoProfileLine_MinErrorMeasurement(GoProfileLine tool);
1127
1128 /**
1129 * Returns a GoProfileLine Percentile measurement object.
1130 *
1131 * @public @memberof GoProfileLine
1132 * @version Introduced in firmware 4.0.10.27
1133 * @param tool GoProfileLine object.
1134 * @return A GoProfileLine Percentile measurement.
1135 */
1136 GoFx(GoProfileLinePercentile) GoProfileLine_PercentileMeasurement(GoProfileLine tool);
1137
1138
1139 /**
1140 * @class GoProfilePanel
1141 * @extends GoProfileTool
1142 * @ingroup GoSdk-ProfileTools
1143 * @brief Represents a profile panel tool.
1144 */
1145 typedef GoProfileTool GoProfilePanel;
1146
1147 /**
1148 * Gets the maximum gap width.
1149 *
1150 * @public @memberof GoProfilePanel
1151 * @version Introduced in firmware 4.0.10.27
1152 * @param tool GoProfilePanel object.
1153 * @return The maximum gap width.
1154 */
1155 GoFx(k64f) GoProfilePanel_MaxGapWidth(GoProfilePanel tool);
1156
1157 /**
1158 * Sets the maximum gap width.
1159 *
1160 * @public @memberof GoProfilePanel
1161 * @version Introduced in firmware 4.0.10.27
1162 * @param tool GoProfilePanel object.
1163 * @param width The maximum gap width value to set.
1164 * @return Operation status.
1165 */
1166 GoFx(kStatus) GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width);
1167
1168 /**
1169 * Gets the reference edge side.
1170 *
1171 * @public @memberof GoProfilePanel
1172 * @version Introduced in firmware 4.0.10.27
1173 * @param tool GoProfilePanel object.
1174 * @return The reference edge side.
1175 */
1176 GoFx(GoProfilePanelSide) GoProfilePanel_RefEdgeSide(GoProfilePanel tool);
1177
1178 /**
1179 * Sets the reference edge side.
1180 *
1181 * @public @memberof GoProfilePanel
1182 * @version Introduced in firmware 4.0.10.27
1183 * @param tool GoProfilePanel object.
1184 * @param side The reference edge side.
1185 * @return Operation status.
1186 */
1187 GoFx(kStatus) GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side);
1188
1189 /**
1190 * Gets the left profile edge.
1191 *
1192 * @public @memberof GoProfilePanel
1193 * @version Introduced in firmware 4.0.10.27
1194 * @param tool GoProfilePanel object.
1195 * @return The left profile edge.
1196 */
1197 GoFx(GoProfileEdge) GoProfilePanel_LeftEdge(GoProfilePanel tool);
1198
1199 /**
1200 * Gets the right profile edge.
1201 *
1202 * @public @memberof GoProfilePanel
1203 * @version Introduced in firmware 4.0.10.27
1204 * @param tool GoProfilePanel object.
1205 * @return The right profile edge.
1206 */
1207 GoFx(GoProfileEdge) GoProfilePanel_RightEdge(GoProfilePanel tool);
1208
1209 /**
1210 * Returns a GoProfilePanel Gap measurement object.
1211 *
1212 * @public @memberof GoProfilePanel
1213 * @version Introduced in firmware 4.0.10.27
1214 * @param tool GoProfilePanel object.
1215 * @return A GoProfilePanel Gap measurement.
1216 */
1217 GoFx(GoProfilePanelGap) GoProfilePanel_GapMeasurement(GoProfilePanel tool);
1218
1219 /**
1220 * Returns a GoProfilePanel Flush measurement object.
1221 *
1222 * @public @memberof GoProfilePanel
1223 * @version Introduced in firmware 4.0.10.27
1224 * @param tool GoProfilePanel object.
1225 * @return A GoProfilePanel Flush measurement.
1226 */
1227 GoFx(GoProfilePanelFlush) GoProfilePanel_FlushMeasurement(GoProfilePanel tool);
1228
1229
1230 /**
1231 * @class GoProfilePosition
1232 * @extends GoProfileTool
1233 * @ingroup GoSdk-ProfileTools
1234 * @brief Represents a profile position tool.
1235 */
1236 typedef GoProfileTool GoProfilePosition;
1237
1238 /**
1239 * Gets the profile feature.
1240 *
1241 * @public @memberof GoProfilePosition
1242 * @version Introduced in firmware 4.0.10.27
1243 * @param tool GoProfilePos object.
1244 * @return The profile feature.
1245 */
1246 GoFx(GoProfileFeature) GoProfilePosition_Feature(GoProfilePosition tool);
1247
1248 /**
1249 * Returns a GoProfilePosition X measurement object.
1250 *
1251 * @public @memberof GoProfilePosition
1252 * @version Introduced in firmware 4.0.10.27
1253 * @param tool GoProfilePosition object.
1254 * @return A GoProfilePosition X measurement.
1255 */
1256 GoFx(GoProfilePositionX) GoProfilePosition_XMeasurement(GoProfilePosition tool);
1257
1258 /**
1259 * Returns a GoProfilePosition Z measurement object.
1260 *
1261 * @public @memberof GoProfilePosition
1262 * @version Introduced in firmware 4.0.10.27
1263 * @param tool GoProfilePosition object.
1264 * @return A GoProfilePosition Z measurement.
1265 */
1266 GoFx(GoProfilePositionZ) GoProfilePosition_ZMeasurement(GoProfilePosition tool);
1267
1268
1269 /**
1270 * @class GoProfileStrip
1271 * @extends GoProfileTool
1272 * @ingroup GoSdk-ProfileTools
1273 * @brief Represents a profile strip tool.
1274 */
1275 typedef GoProfileTool GoProfileStrip;
1276
1277 /**
1278 * Sets the strip base type.
1279 *
1280 * @public @memberof GoProfileStrip
1281 * @version Introduced in firmware 4.0.10.27
1282 * @param tool GoProfileStrip object.
1283 * @param type The strip base type.
1284 * @return Operation status.
1285 */
1286 GoFx(kStatus) GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type);
1287
1288 /**
1289 * Gets the strip base type.
1290 *
1291 * @public @memberof GoProfileStrip
1292 * @version Introduced in firmware 4.0.10.27
1293 * @param tool GoProfileStrip object.
1294 * @return The strip base type.
1295 */
1296 GoFx(GoProfileStripBaseType) GoProfileStrip_BaseType(GoProfileStrip tool);
1297
1298 /**
1299 * Gets the left edge value.
1300 *
1301 * @public @memberof GoProfileStrip
1302 * @version Introduced in firmware 4.0.10.27
1303 * @param tool GoProfileStrip object.
1304 * @return The left edge value.
1305 */
1306 GoFx(GoProfileStripEdgeType) GoProfileStrip_LeftEdge(GoProfileStrip tool);
1307
1308 /**
1309 * Sets the left edge.
1310 *
1311 * @public @memberof GoProfileStrip
1312 * @version Introduced in firmware 4.0.10.27
1313 * @param tool GoProfileStrip object.
1314 * @param leftEdge Left edge value.
1315 * @return Operation status.
1316 */
1317 GoFx(kStatus) GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge);
1318
1319 /**
1320 * Gets the right edge value.
1321 *
1322 * @public @memberof GoProfileStrip
1323 * @version Introduced in firmware 4.0.10.27
1324 * @param tool GoProfileStrip object.
1325 * @return The right edge value.
1326 */
1327 GoFx(GoProfileStripEdgeType) GoProfileStrip_RightEdge(GoProfileStrip tool);
1328
1329 /**
1330 * Sets the right edge.
1331 *
1332 * @public @memberof GoProfileStrip
1333 * @version Introduced in firmware 4.0.10.27
1334 * @param tool GoProfileStrip object.
1335 * @param rightEdge Right edge value.
1336 * @return Operation status.
1337 */
1338 GoFx(kStatus) GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge);
1339
1340 /**
1341 * Gets the tilt enabled state.
1342 *
1343 * @public @memberof GoProfileStrip
1344 * @version Introduced in firmware 4.0.10.27
1345 * @param tool GoProfileStrip object.
1346 * @return kTRUE if tilt is enabled, kFALSE otherwise.
1347 */
1348 GoFx(kBool) GoProfileStrip_TiltEnabled(GoProfileStrip tool);
1349
1350 /**
1351 * Enables or disables tilt.
1352 *
1353 * @public @memberof GoProfileStrip
1354 * @version Introduced in firmware 4.0.10.27
1355 * @param tool GoProfileStrip object.
1356 * @param enable kTRUE to enable tilt, kFALSE to disable it.
1357 * @return Operation status.
1358 */
1359 GoFx(kStatus) GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable);
1360
1361 /**
1362 * Gets the transition width.
1363 *
1364 * @public @memberof GoProfileStrip
1365 * @version Introduced in firmware 4.0.10.27
1366 * @param tool GoProfileStrip object.
1367 * @return The transition width (in mm).
1368 */
1369 GoFx(k64f) GoProfileStrip_TransitionWidth(GoProfileStrip tool);
1370
1371 /**
1372 * Sets the transition width.
1373 *
1374 * @public @memberof GoProfileStrip
1375 * @version Introduced in firmware 4.0.10.27
1376 * @param tool GoProfileStrip object.
1377 * @param value The transition width (in mm).
1378 * @return Operation status.
1379 */
1380 GoFx(kStatus) GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value);
1381
1382 /**
1383 * Gets the minimum width.
1384 *
1385 * @public @memberof GoProfileStrip
1386 * @version Introduced in firmware 4.0.10.27
1387 * @param tool GoProfileStrip object.
1388 * @return The minimum width (in mm).
1389 */
1390 GoFx(k64f) GoProfileStrip_MinWidth(GoProfileStrip tool);
1391
1392 /**
1393 * Sets the minimum width.
1394 *
1395 * @public @memberof GoProfileStrip
1396 * @version Introduced in firmware 4.0.10.27
1397 * @param tool GoProfileStrip object.
1398 * @param value The minimum width (in mm).
1399 * @return Operation status.
1400 */
1401 GoFx(kStatus) GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value);
1402
1403 /**
1404 * Gets the minimum height.
1405 *
1406 * @public @memberof GoProfileStrip
1407 * @version Introduced in firmware 4.0.10.27
1408 * @param tool GoProfileStrip object.
1409 * @return The minimum height (in mm).
1410 */
1411 GoFx(k64f) GoProfileStrip_MinHeight(GoProfileStrip tool);
1412
1413 /**
1414 * Sets the transition height.
1415 *
1416 * @public @memberof GoProfileStrip
1417 * @version Introduced in firmware 4.0.10.27
1418 * @param tool GoProfileStrip object.
1419 * @param value The minimum height (in mm).
1420 * @return Operation status.
1421 */
1422 GoFx(kStatus) GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value);
1423
1424 /**
1425 * Gets the maximum void width.
1426 *
1427 * @public @memberof GoProfileStrip
1428 * @version Introduced in firmware 4.0.10.27
1429 * @param tool GoProfileStrip object.
1430 * @return The maximum void width (in mm).
1431 */
1432 GoFx(k64f) GoProfileStrip_MaxVoidWidth(GoProfileStrip tool);
1433
1434 /**
1435 * Sets the maximum void width.
1436 *
1437 * @public @memberof GoProfileStrip
1438 * @version Introduced in firmware 4.0.10.27
1439 * @param tool GoProfileStrip object.
1440 * @param value The maximum void width (in mm).
1441 * @return Operation status.
1442 */
1443 GoFx(kStatus) GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value);
1444
1445 /**
1446 * Gets the profile strip tool region.
1447 *
1448 * @public @memberof GoProfileStrip
1449 * @version Introduced in firmware 4.0.10.27
1450 * @param tool GoProfileStrip object.
1451 * @return A GoProfileRegion object.
1452 */
1453 GoFx(GoProfileRegion) GoProfileStrip_Region(GoProfileStrip tool);
1454
1455 /**
1456 * Indicates whether the region is enabled.
1457 *
1458 * @public @memberof GoProfileStrip
1459 * @version Introduced in firmware 4.4.4.14
1460 * @param tool GoProfileStrip object.
1461 * @return kTRUE if enabled and kFALSE otherwise.
1462 */
1463 GoFx(kBool) GoProfileStrip_RegionEnabled(GoProfileStrip tool);
1464
1465 /**
1466 * Enables or disables the region.
1467 *
1468 * @public @memberof GoProfileStrip
1469 * @version Introduced in firmware 4.4.4.14
1470 * @param tool GoProfileStrip object.
1471 * @param enable kTRUE to enable the region and kFALSE to disable it.
1472 * @return Operation status.
1473 */
1474 GoFx(kStatus) GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable);
1475
1476 /**
1477 * Adds an additional profile strip tool measurement.
1478 *
1479 * @public @memberof GoProfileStrip
1480 * @version Introduced in firmware 4.0.10.27
1481 * @param tool GoProfileStrip object.
1482 * @param type The measurement type to add. It must be a valid profile strip tool type.
1483 * @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.
1484 * @return Operation status.
1485 */
1486 GoFx(kStatus) GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement* measurement);
1487
1488 /**
1489 * Removes a measurement from the tool at the given index.
1490 *
1491 * @public @memberof GoProfileStrip
1492 * @version Introduced in firmware 4.0.10.27
1493 * @param tool GoProfileStrip object.
1494 * @param index The index with which to remove a measurement.
1495 * @return Operation status.
1496 */
1497 GoFx(kStatus) GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index);
1498
1499 /**
1500 * Returns the measurement count for the given tool.
1501 *
1502 * @public @memberof GoProfileStrip
1503 * @version Introduced in firmware 4.0.10.27
1504 * @param tool GoProfileStrip object.
1505 * @return Tool measurement count.
1506 */
1507 GoFx(kSize) GoProfileStrip_MeasurementCount(GoProfileStrip tool);
1508
1509 /**
1510 * Returns a measurement object at the given index.
1511 *
1512 * @public @memberof GoProfileStrip
1513 * @version Introduced in firmware 4.0.10.27
1514 * @param tool GoProfileStrip object.
1515 * @param index The index with which to return a measurement object.
1516 * @return A profile strip tool measurement or kNULL if the index is invalid.
1517 */
1518 GoFx(GoMeasurement) GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index);
1519
1520
1521 /**
1522 * @class GoProfileXLine
1523 * @extends GoProfileTool
1524 * @ingroup GoSdk-ProfileTools
1525 * @brief Represents a profile X-Line tool.
1526 */
1527 typedef GoProfileTool GoProfileXLine;
1528
1529 /**
1530 * Returns the enabled state of the tool region.
1531 *
1532 * @public @memberof GoProfileXLine
1533 * @version Introduced in firmware 4.3.3.124
1534 * @param tool GoProfileXLine object.
1535 * @return kTRUE if enabled and kFALSE if disabled.
1536 */
1537 GoFx(kBool) GoProfileXLine_RegionEnabled(GoProfileXLine tool);
1538
1539 /**
1540 * Enables or disables the tool region.
1541 *
1542 * @public @memberof GoProfileXLine
1543 * @version Introduced in firmware 4.3.3.124
1544 * @param tool GoProfileXLine object.
1545 * @param enable kTRUE to enable the tool region, kFALSE to disable it.
1546 * @return Operation status.
1547 */
1548 GoFx(kStatus) GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable);
1549
1550 /**
1551 * Gets the profile X-Line tool region.
1552 *
1553 * @public @memberof GoProfileXLine
1554 * @version Introduced in firmware 4.3.3.124
1555 * @param tool GoProfileXLine object.
1556 * @return A GoRegion3d object.
1557 */
1558 GoFx(GoProfileRegion) GoProfileXLine_Region(GoProfileXLine tool);
1559
1560 /**
1561 * Sets the profile X-Line tool maximum tracking speed.
1562 *
1563 * @public @memberof GoProfileXLine
1564 * @version Introduced in firmware 4.3.3.124
1565 * @param tool GoProfileXLine object.
1566 * @param value The value to set.
1567 * @return Operation status.
1568 */
1569 GoFx(kStatus) GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value);
1570
1571 /**
1572 * Gets the profile X-Line tool maximum tracking speed.
1573 *
1574 * @public @memberof GoProfileXLine
1575 * @version Introduced in firmware 4.3.3.124
1576 * @param tool GoProfileXLine object.
1577 * @return The maximum tracking speed.
1578 */
1579 GoFx(k64f) GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool);
1580
1581 /**
1582 * Returns a GoProfileXLine Z measurement object.
1583 *
1584 * @public @memberof GoProfileXLine
1585 * @version Introduced in firmware 4.3.3.124
1586 * @param tool GoProfileXLine object.
1587 * @return A GoProfileXLine Z measurement.
1588 */
1589 GoFx(GoProfileXLineZ) GoProfileXLine_ZMeasurement(GoProfileXLine tool);
1590
1591 /**
1592 * Returns a GoProfileXLine Validity measurement object.
1593 *
1594 * @public @memberof GoProfileXLine
1595 * @version Introduced in firmware 4.3.3.124
1596 * @param tool GoProfileXLine object.
1597 * @return A GoProfileXLine Validity measurement.
1598 */
1599 GoFx(GoProfileXLineZ) GoProfileXLine_ValidityMeasurement(GoProfileXLine tool);
1600
1601 kEndHeader()
1602 #include <GoSdk/Tools/GoProfileTools.x.h>
1603
1604 #endif
GoProfileBox::GoProfileBox_WidthMeasurement
GoProfileBoxWidth GoProfileBox_WidthMeasurement(GoProfileBox tool)
Returns a GoProfileBox Width measurement object.
GoProfileTool::GoProfileTool_ZAnchorEnabled
kBool GoProfileTool_ZAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anc...
GoProfileXLine::GoProfileXLine_EnableRegion
kStatus GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable)
Enables or disables the tool region.
GoProfileLine
Represents a profile line tool.
k32u
GoProfileStrip::GoProfileStrip_SetMinHeight
kStatus GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value)
Sets the transition height.
GoTool.h
Declares the base GoTool class.
GoProfileStrip::GoProfileStrip_Region
GoProfileRegion GoProfileStrip_Region(GoProfileStrip tool)
Gets the profile strip tool region.
GoProfileStrip::GoProfileStrip_SetRightEdge
kStatus GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge)
Sets the right edge.
GoProfileCircleX
Represents an X value measurement for a Profile Circle Tool.
GoProfileBox::GoProfileBox_HeightMeasurement
GoProfileBoxHeight GoProfileBox_HeightMeasurement(GoProfileBox tool)
Returns a GoProfileBox Height measurement object.
GoProfileIntersect::GoProfileIntersect_ZMeasurement
GoProfileIntersectZ GoProfileIntersect_ZMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Z measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_BridgeValueMeasurement
GoProfileBridgeValueBridgeValue GoProfileBridgeValue_BridgeValueMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue bridge value measurement object.
GoMeasurement
Represents the base class for a tool measurement or script output.
GoProfileBox::GoProfileBox_RegionEnabled
kBool GoProfileBox_RegionEnabled(GoProfileBox tool)
Returns the enabled state of the tool region.
GoProfileBoxZ
Represents a Z measurement for a Profile Bounding Box tool.
GoProfileIntersect::GoProfileIntersect_SetRefLineType
kStatus GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type)
Sets the reference line type.
GoProfileStrip::GoProfileStrip_EnableRegion
kStatus GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable)
Enables or disables the region.
GoProfileGroove::GoProfileGroove_Region
GoProfileRegion GoProfileGroove_Region(GoProfileGroove tool)
Gets the profile region.
GoProfileCircle::GoProfileCircle_RadiusMeasurement
GoProfileCircleRadius GoProfileCircle_RadiusMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Radius measurement object.
GoProfileIntersect::GoProfileIntersect_RefLine
GoProfileLineRegion GoProfileIntersect_RefLine(GoProfileIntersect tool)
Gets the reference profile line.
GoProfileBox::GoProfileBox_XMeasurement
GoProfileBoxX GoProfileBox_XMeasurement(GoProfileBox tool)
Returns a GoProfileBox X measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_SetMaxInvalid
kStatus GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max invalid percentage.
GoProfileGroove::GoProfileGroove_MaxWidth
k64f GoProfileGroove_MaxWidth(GoProfileGroove tool)
Gets the groove width maximum.
GoProfileGroove::GoProfileGroove_SetMaxWidth
kStatus GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width)
Sets the groove width maximum.
GoProfileGroove::GoProfileGroove_SetMinDepth
kStatus GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth)
Sets the groove depth minimum.
GoProfilePanelGap
Represents a gap measurement for a Profile Panel Tool.
GoProfileBridgeValue::GoProfileBridgeValue_EnableRegion
kStatus GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable)
Enables or disables the tool region.
GoProfileTool::GoProfileTool_XAnchorOptionCount
kSize GoProfileTool_XAnchorOptionCount(GoProfileTool tool)
Gets the X-anchoring option list count.
GoMeasurementType
Lists all measurement types.
GoProfileGroove::GoProfileGroove_AddMeasurement
kStatus GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile groove tool measurement.
GoProfileDim
Represents a profile dimension tool.
GoProfileArea::GoProfileArea_LineRegion
GoProfileLineRegion GoProfileArea_LineRegion(GoProfileArea tool)
Gets the reference profile line.
GoProfileXLine::GoProfileXLine_SetMaxTrackingSpeed
kStatus GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value)
Sets the profile X-Line tool maximum tracking speed.
GoProfileTool::GoProfileTool_StreamOptionAt
GoDataStream GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index)
Gets the data stream option at the given index.
GoProfileDimCenterX
Represents a center X value measurement for a Profile Dimension Tool.
GoProfilePanelFlush
Represents a flush measurement for a Profile Panel Tool.
GoProfileBridgeValue::GoProfileBridgeValue_Region
GoProfileRegion GoProfileBridgeValue_Region(GoProfileBridgeValue tool)
Gets the bridge value profile region.
GoProfileBox
Represents a profile bounding box tool.
GoProfileLine::GoProfileLine_MinErrorMeasurement
GoProfileLineMinError GoProfileLine_MinErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum Error measurement object.
GoProfileGroove::GoProfileGroove_EnableRegion
kStatus GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable)
Enables or disables the region.
GoProfilePosition::GoProfilePosition_Feature
GoProfileFeature GoProfilePosition_Feature(GoProfilePosition tool)
Gets the profile feature.
GoProfileGroove::GoProfileGroove_SetShape
kStatus GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape)
Sets the groove determination shape.
GoProfileArea::GoProfileArea_EnableRegion
kStatus GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable)
Enables or disables the region.
GoProfilePanel::GoProfilePanel_SetRefEdgeSide
kStatus GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side)
Sets the reference edge side.
kSize
GoProfileStrip::GoProfileStrip_MinWidth
k64f GoProfileStrip_MinWidth(GoProfileStrip tool)
Gets the minimum width.
GoProfileCircle::GoProfileCircle_Region
GoProfileRegion GoProfileCircle_Region(GoProfileCircle tool)
Gets the profile region.
GoProfileBridgeValue::GoProfileBridgeValue_WindowSkip
k64f GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool)
Gets the profile X-Line tool window skip percentage.
GoProfileGroove::GoProfileGroove_MeasurementAt
GoMeasurement GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index)
Returns a measurement object at the given index.
GoProfileStrip::GoProfileStrip_RemoveMeasurement
kStatus GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index)
Removes a measurement from the tool at the given index.
GoProfileStrip::GoProfileStrip_RightEdge
GoProfileStripEdgeType GoProfileStrip_RightEdge(GoProfileStrip tool)
Gets the right edge value.
GoProfileArea::GoProfileArea_SetType
kStatus GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type)
Sets the profile area type.
GoProfileBox::GoProfileBox_Region
GoProfileRegion GoProfileBox_Region(GoProfileBox tool)
Gets the profile bounding box region.
GoProfileTool::GoProfileTool_ZAnchor
k32s GoProfileTool_ZAnchor(GoProfileTool tool)
Gets the current Z-anchoring source.
GoProfileStrip::GoProfileStrip_MeasurementCount
kSize GoProfileStrip_MeasurementCount(GoProfileStrip tool)
Returns the measurement count for the given tool.
GoProfileIntersect
Represents a profile intersect tool.
GoProfileTool::GoProfileTool_SetSource
kStatus GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source)
Sets the data source.
GoProfileBox::GoProfileBox_GlobalXMeasurement
GoProfileBoxGlobalX GoProfileBox_GlobalXMeasurement(GoProfileBox tool)
Returns a GoProfileBox global X measurement object.
GoProfileDimWidth
Represents a width value measurement for a Profile Dimension Tool.
GoProfileTool::GoProfileTool_StreamOptionCount
kSize GoProfileTool_StreamOptionCount(GoProfileTool tool)
Gets the data stream option list count.
GoDataStream
Represents a data stream which consists of a data step and ID.
Definition: GoSdkDef.h:955
GoDataSource
Represents a data source.
GoProfileBridgeValueAngle
Represents an angle measurement for a Profile Bridge Value tool.
GoProfileArea
Represents a profile area tool.
GoProfileStrip::GoProfileStrip_SetTransitionWidth
kStatus GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value)
Sets the transition width.
GoProfileGroove::GoProfileGroove_MinDepth
k64f GoProfileGroove_MinDepth(GoProfileGroove tool)
Gets the groove depth minimum.
GoProfilePanel::GoProfilePanel_FlushMeasurement
GoProfilePanelFlush GoProfilePanel_FlushMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Flush measurement object.
GoProfileStrip::GoProfileStrip_TiltEnabled
kBool GoProfileStrip_TiltEnabled(GoProfileStrip tool)
Gets the tilt enabled state.
GoUtils.h
Contains various helper functions.
GoProfileIntersectX
Represents an intersect X measurement for a Profile Intersect Tool.
GoProfileEdge
Represents a profile edge used in various profile tools.
GoProfilePanel
Represents a profile panel tool.
GoProfileIntersect::GoProfileIntersect_Line
GoProfileLineRegion GoProfileIntersect_Line(GoProfileIntersect tool)
Gets the non-reference profile line.
GoProfileBridgeValue::GoProfileBridgeValue_NormalizeEnabled
kBool GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool)
Returns the enabled state of normalization.
GoProfileLineMaxError
Represents a maximum error measurement for a Profile Line Tool.
GoProfileArea::GoProfileArea_Type
GoProfileAreaType GoProfileArea_Type(GoProfileArea tool)
Gets the profile area type.
GoProfileGroove
Represents a profile groove tool.
GoProfileXLine::GoProfileXLine_RegionEnabled
kBool GoProfileXLine_RegionEnabled(GoProfileXLine tool)
Returns the enabled state of the tool region.
GoProfileStrip::GoProfileStrip_LeftEdge
GoProfileStripEdgeType GoProfileStrip_LeftEdge(GoProfileStrip tool)
Gets the left edge value.
GoProfileBridgeValue::GoProfileBridgeValue_MaxDifferentialLimitMax
k64f GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential maximum value limit.
GoProfileAreaCentroidZ
Represents a centroid Z measurement for a Profile Area Tool.
GoProfileStrip::GoProfileStrip_SetMaxVoidWidth
kStatus GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value)
Sets the maximum void width.
GoProfileArea::GoProfileArea_AreaMeasurement
GoProfileAreaArea GoProfileArea_AreaMeasurement(GoProfileArea tool)
Returns a GoProfileArea Area measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_MaxDifferentialLimitMin
k64f GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential minimum value limit.
GoProfileRegion
Represents a profile region used in various profile tools.
GoProfileBridgeValue::GoProfileBridgeValue_EnableNormalize
kStatus GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable)
Enables or disables normalization.
GoProfileTool::GoProfileTool_XAnchorEnabled
kBool GoProfileTool_XAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anc...
GoProfileCircle
Represents a profile circle tool.
GoProfileArea::GoProfileArea_CentroidXMeasurement
GoProfileAreaCentroidX GoProfileArea_CentroidXMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid X measurement object.
GoProfileTool::GoProfileTool_XAnchor
k32s GoProfileTool_XAnchor(GoProfileTool tool)
Gets the current X-anchoring source.
GoProfileAreaArea
Represents an area measurement for a Profile Area tool.
GoProfilePanel::GoProfilePanel_RightEdge
GoProfileEdge GoProfilePanel_RightEdge(GoProfilePanel tool)
Gets the right profile edge.
GoProfileBoxHeight
Represents a height measurement for a Profile Bounding Box tool.
GoProfileBoxGlobalAngle
Represents a global angle measurement for a Profile Bounding Box tool.
GoProfileLineMinError
Represents a minimum error measurement for a Profile Line Tool.
GoProfileGrooveShape
Represents a profile edge type.
GoProfileGroove::GoProfileGroove_RegionEnabled
kBool GoProfileGroove_RegionEnabled(GoProfileGroove tool)
Indicates whether the region is enabled.
GoProfilePositionZ
Represents an Z measurement for a Profile Position tool.
GoSdkDef.h
Essential SDK declarations.
GoProfileArea::GoProfileArea_Baseline
GoProfileBaseline GoProfileArea_Baseline(GoProfileArea tool)
Gets the profile area baseline.
GoProfileDim::GoProfileDim_CenterXMeasurement
GoProfileDimCenterX GoProfileDim_CenterXMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center X measurement object.
GoProfileTool::GoProfileTool_ZAnchorOptionAt
k32u GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the Z-anchoring option at the given index.
GoProfileIntersect::GoProfileIntersect_XMeasurement
GoProfileIntersectX GoProfileIntersect_XMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect X measurement object.
GoProfilePosition::GoProfilePosition_ZMeasurement
GoProfilePositionZ GoProfilePosition_ZMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition Z measurement object.
GoProfileTool::GoProfileTool_SetZAnchor
kStatus GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id)
Sets the Z-anchoring source.
GoProfileBox::GoProfileBox_GlobalAngleMeasurement
GoProfileBoxGlobalAngle GoProfileBox_GlobalAngleMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Angle measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_MaxDifferential
k64f GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential.
GoProfileLinePercentile
Represents a percentile measurement for a Profile Line Tool.
GoProfilePanel::GoProfilePanel_RefEdgeSide
GoProfilePanelSide GoProfilePanel_RefEdgeSide(GoProfilePanel tool)
Gets the reference edge side.
GoProfileStrip
Represents a profile strip tool.
GoProfileCircle::GoProfileCircle_EnableRegion
kStatus GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable)
Enables or disables the region.
GoProfileLine::GoProfileLine_StdDevMeasurement
GoProfileLineStdDev GoProfileLine_StdDevMeasurement(GoProfileLine tool)
Returns a GoProfileLine Standard Deviation measurement object.
GoProfileStrip::GoProfileStrip_BaseType
GoProfileStripBaseType GoProfileStrip_BaseType(GoProfileStrip tool)
Gets the strip base type.
GoTool
Represents the base tool class.
GoProfileDim::GoProfileDim_WidthMeasurement
GoProfileDimWidth GoProfileDim_WidthMeasurement(GoProfileDim tool)
Returns a GoProfileDim Width measurement object.
GoProfileBoxX
Represents an X measurement for a Profile Bounding Box tool.
GoProfileTool::GoProfileTool_Stream
GoDataStream GoProfileTool_Stream(GoProfileTool tool)
Gets the data stream.
GoProfileBox::GoProfileBox_EnableRegion
kStatus GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable)
Enables or disables the tool region.
GoProfileArea::GoProfileArea_CentroidZMeasurement
GoProfileAreaCentroidZ GoProfileArea_CentroidZMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid Z measurement object.
GoProfileBridgeValue
Represents a profile bridge value tool.
GoProfileDimHeight
Represents a height value measurement for a Profile Dimension Tool.
GoProfileStripBaseType
Represents a profile strip tool base type.
GoProfileFeature
Represents a profile feature used in various profile tools.
GoProfileStrip::GoProfileStrip_MaxVoidWidth
k64f GoProfileStrip_MaxVoidWidth(GoProfileStrip tool)
Gets the maximum void width.
k32s
GoProfileIntersect::GoProfileIntersect_RefLineType
GoProfileBaseline GoProfileIntersect_RefLineType(GoProfileIntersect tool)
Gets the reference profile line type.
GoProfileLine::GoProfileLine_PercentileMeasurement
GoProfileLinePercentile GoProfileLine_PercentileMeasurement(GoProfileLine tool)
Returns a GoProfileLine Percentile measurement object.
GoProfileStrip::GoProfileStrip_RegionEnabled
kBool GoProfileStrip_RegionEnabled(GoProfileStrip tool)
Indicates whether the region is enabled.
GoProfileStripEdgeType
Represents a profile strip tool edge type.
GoProfileCircleZ
Represents a Z value measurement for a Profile Circle Tool.
GoProfilePanel::GoProfilePanel_LeftEdge
GoProfileEdge GoProfilePanel_LeftEdge(GoProfilePanel tool)
Gets the left profile edge.
GoProfileTool::GoProfileTool_XAnchorOptionAt
k32u GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the X-anchoring option at the given index.
GoProfileBoxGlobalY
Represents a global Y measurement for a Profile Bounding Box tool.
GoProfileDim::GoProfileDim_Feature
GoProfileFeature GoProfileDim_Feature(GoProfileDim tool)
Gets the non-reference profile feature.
GoProfileArea::GoProfileArea_BaselineUsed
kBool GoProfileArea_BaselineUsed(GoProfileArea tool)
Returns a boolean representing whether the profile area baseline is used.
GoProfileTool::GoProfileTool_SourceOptionAt
GoDataSource GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index)
Gets the data source option at the given index.
GoProfileDim::GoProfileDim_RefFeature
GoProfileFeature GoProfileDim_RefFeature(GoProfileDim tool)
Gets the reference profile feature.
GoProfileArea::GoProfileArea_Region
GoProfileRegion GoProfileArea_Region(GoProfileArea tool)
Gets the profile region.
GoProfileStrip::GoProfileStrip_MinHeight
k64f GoProfileStrip_MinHeight(GoProfileStrip tool)
Gets the minimum height.
GoProfileBridgeValue::GoProfileBridgeValue_WindowSize
k64f GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool)
Gets the profile X-Line tool window size percentage.
GoProfileStrip::GoProfileStrip_AddMeasurement
kStatus GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile strip tool measurement.
GoProfileStrip::GoProfileStrip_MeasurementAt
GoMeasurement GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index)
Returns a measurement object at the given index.
GoProfileBridgeValue::GoProfileBridgeValue_SetMaxDifferential
kStatus GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max differential.
GoProfileStrip::GoProfileStrip_SetBaseType
kStatus GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type)
Sets the strip base type.
GoProfilePanel::GoProfilePanel_GapMeasurement
GoProfilePanelGap GoProfilePanel_GapMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Gap measurement object.
GoProfileXLine
Represents a profile X-Line tool.
GoProfileBridgeValue::GoProfileBridgeValue_RegionEnabled
kBool GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool)
Returns the enabled state of the tool region.
GoProfileGroove::GoProfileGroove_Shape
GoProfileGrooveShape GoProfileGroove_Shape(GoProfileGroove tool)
Gets the current groove determination shape.
GoProfileStrip::GoProfileStrip_SetMinWidth
kStatus GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value)
Sets the minimum width.
GoProfileXLine::GoProfileXLine_Region
GoProfileRegion GoProfileXLine_Region(GoProfileXLine tool)
Gets the profile X-Line tool region.
GoProfileTool::GoProfileTool_SourceOptionCount
kSize GoProfileTool_SourceOptionCount(GoProfileTool tool)
Gets the data source option list count.
GoProfileToolUtils.h
Declares shared profile tool configuration classes.
GoProfilePosition::GoProfilePosition_XMeasurement
GoProfilePositionX GoProfilePosition_XMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition X measurement object.
GoProfileLineStdDev
Represents a standard deviation measurement for a Profile Line Tool.
GoProfileDimCenterZ
Represents a center Z value measurement for a Profile Dimension Tool.
GoProfileBridgeValue::GoProfileBridgeValue_AngleMeasurement
GoProfileBridgeValueAngle GoProfileBridgeValue_AngleMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue angle measurement object.
GoProfileGroove::GoProfileGroove_RemoveMeasurement
kStatus GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index)
Removes a measurement from the tool at the given index.
GoProfileBridgeValue::GoProfileBridgeValue_SetWindowSkip
kStatus GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window skip percentage.
GoProfileXLine::GoProfileXLine_ZMeasurement
GoProfileXLineZ GoProfileXLine_ZMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Z measurement object.
GoProfileIntersect::GoProfileIntersect_AngleMeasurement
GoProfileIntersectAngle GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
GoProfileAreaCentroidX
Represents a centroid X measurement for a Profile Area Tool.
GoProfileArea::GoProfileArea_TypeUsed
kBool GoProfileArea_TypeUsed(GoProfileArea tool)
Gets the boolean representing whether the area type is used.
GoProfileLine::GoProfileLine_MaxErrorMeasurement
GoProfileLineMaxError GoProfileLine_MaxErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum Error measurement object.
GoProfileBridgeValue::GoProfileBridgeValue_MaxInvalid
k64f GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool)
Gets the profile X-Line tool max invalid percentage.
GoProfileLine::GoProfileLine_EnableRegion
kStatus GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable)
Enables or disables the region.
kObject
GoProfileGroove::GoProfileGroove_SetMinWidth
kStatus GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width)
Sets the groove width minimum.
GoProfileBox::GoProfileBox_ZMeasurement
GoProfileBoxZ GoProfileBox_ZMeasurement(GoProfileBox tool)
Returns a GoProfileBox Z measurement object.
kStatus
GoProfileTool::GoProfileTool_SetStream
kStatus GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream)
Sets the data stream.
GoProfileStrip::GoProfileStrip_SetLeftEdge
kStatus GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge)
Sets the left edge.
GoProfileArea::GoProfileArea_RegionEnabled
kBool GoProfileArea_RegionEnabled(GoProfileArea tool)
Indicates whether the region is enabled.
GoProfileTool::GoProfileTool_Source
GoDataSource GoProfileTool_Source(GoProfileTool tool)
Gets the data source.
GoProfileIntersectAngle
Represents an intersect angle measurement for a Profile Intersect Tool.
GoProfileStrip::GoProfileStrip_TransitionWidth
k64f GoProfileStrip_TransitionWidth(GoProfileStrip tool)
Gets the transition width.
GoProfileCircleRadius
Represents a radius value measurement for a Profile Circle Tool.
GoProfileXLineZ
Represents an Z measurement for a Profile X-Line tool.
GoProfileBoxWidth
Represents a width measurement for a Profile Bounding Box tool.
GoProfileDim::GoProfileDim_HeightMeasurement
GoProfileDimHeight GoProfileDim_HeightMeasurement(GoProfileDim tool)
Returns a GoProfileDim Height measurement object.
GoProfileBox::GoProfileBox_GlobalYMeasurement
GoProfileBoxGlobalY GoProfileBox_GlobalYMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Y measurement object.
GoProfilePanel::GoProfilePanel_SetMaxGapWidth
kStatus GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width)
Sets the maximum gap width.
k64f
GoProfileXLine::GoProfileXLine_MaxTrackingSpeed
k64f GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool)
Gets the profile X-Line tool maximum tracking speed.
GoProfileAreaType
Determines how to calculate profile area.
GoProfileTool::GoProfileTool_SetXAnchor
kStatus GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id)
Sets the X-anchoring source.
GoProfileDim::GoProfileDim_DistanceMeasurement
GoProfileDimDistance GoProfileDim_DistanceMeasurement(GoProfileDim tool)
Returns a GoProfileDim Distance measurement object.
GoProfileIntersectZ
Represents an intersect Z measurement for a Profile Intersect Tool.
GoProfilePositionX
Represents an X measurement for a Profile Position tool.
kBool
GoProfileCircle::GoProfileCircle_XMeasurement
GoProfileCircleX GoProfileCircle_XMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle X measurement object.
GoProfileCircle::GoProfileCircle_ZMeasurement
GoProfileCircleZ GoProfileCircle_ZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Z measurement object.
GoProfileLine::GoProfileLine_RegionEnabled
kBool GoProfileLine_RegionEnabled(GoProfileLine tool)
Indicates whether the region is enabled.
GoProfilePanel::GoProfilePanel_MaxGapWidth
k64f GoProfilePanel_MaxGapWidth(GoProfilePanel tool)
Gets the maximum gap width.
GoProfileGroove::GoProfileGroove_MeasurementCount
kSize GoProfileGroove_MeasurementCount(GoProfileGroove tool)
Returns the measurement count for the given tool.
GoProfileDim::GoProfileDim_CenterZMeasurement
GoProfileDimCenterZ GoProfileDim_CenterZMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center Z measurement object.
GoProfileBridgeValueBridgeValue
Represents a bridge value measurement for a Profile Bridge Value tool.
GoProfileStrip::GoProfileStrip_EnableTilt
kStatus GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable)
Enables or disables tilt.
GoProfileCircle::GoProfileCircle_RegionEnabled
kBool GoProfileCircle_RegionEnabled(GoProfileCircle tool)
Indicates whether the region is enabled.
GoProfileTool
Represents a base profile tool.
GoProfileArea::GoProfileArea_SetBaseline
kStatus GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type)
Sets the profile area type.
GoProfileTool::GoProfileTool_ZAnchorOptionCount
kSize GoProfileTool_ZAnchorOptionCount(GoProfileTool tool)
Gets the Z-anchoring option list count.
GoProfileBoxGlobalX
Represents a global X measurement for a Profile Bounding Box tool.
GoProfileBridgeValue::GoProfileBridgeValue_SetWindowSize
kStatus GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window size percentage.
GoProfileGroove::GoProfileGroove_MinWidth
k64f GoProfileGroove_MinWidth(GoProfileGroove tool)
Gets the groove width minimum value.
GoProfilePosition
Represents a profile position tool.
GoProfileDimDistance
Represents a distance value measurement for a Profile Dimension Tool.
GoProfileXLine::GoProfileXLine_ValidityMeasurement
GoProfileXLineZ GoProfileXLine_ValidityMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Validity measurement object.