Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
GoRangeTools.h
Go to the documentation of this file.
1 /// @cond Gocator_1x00
2 /**
3 * @file GoRangeTools.h
4 * @brief Declares all range tools and their related classes.
5 *
6 * @internal
7 * Copyright (C) 2014 by LMI Technologies Inc.
8 * Licensed under the MIT License.
9 * Redistributed files must retain the above copyright notice.
10 */
11 #ifndef GO_RANGE_TOOLS_H
12 #define GO_RANGE_TOOLS_H
13
14 #include <GoSdk/GoSdkDef.h>
15 #include <GoSdk/GoUtils.h>
16 #include <GoSdk/Tools/GoTool.h>
17 kBeginHeader()
18
19 /**
20 * @class GoRangeTool
21 * @extends GoTool
22 * @ingroup GoSdk-RangeTools
23 * @brief Represents a base range tool.
24 */
25 typedef GoTool GoRangeTool;
26
27 /**
28 * Sets the data source.
29 *
30 * @public @memberof GoRangeTool
31 * @param tool GoRangeTool object.
32 * @param source GoDataSource object.
33 * @return Operation status.
34 */
35 GoFx(kStatus) GoRangeTool_SetSource(GoRangeTool tool, GoDataSource source);
36
37 /**
38 * Gets the data source.
39 *
40 * @public @memberof GoRangeTool
41 * @param tool GoRangeTool object.
42 * @return The data source.
43 */
44 GoFx(GoDataSource) GoRangeTool_Source(GoRangeTool tool);
45
46 /**
47 * Gets the data source option list count.
48 *
49 * @public @memberof GoRangeTool
50 * @param tool GoRangeTool object.
51 * @return The data source option list count.
52 */
53 GoFx(kSize) GoRangeTool_SourceOptionCount(GoRangeTool tool);
54
55 /**
56 * Gets the data source option at the given index.
57 *
58 * @public @memberof GoRangeTool
59 * @param tool GoRangeTool object.
60 * @param index The index with which to retrieve a data source option.
61 * @return The data source option at the given index or k32U_MAX if an invalid index is given.
62 */
63 GoFx(GoDataSource) GoRangeTool_SourceOptionAt(GoRangeTool tool, kSize index);
64
65 /**
66 * @class GoRangePosition
67 * @extends GoRangeTool
68 * @ingroup GoSdk-RangeTools
69 * @brief Represents a range position tool.
70 */
71 typedef GoRangeTool GoRangePosition;
72
73 /**
74 * Returns a range position tool Z measurement object.
75 *
76 * @public @memberof GoRangePosition
77 * @param tool GoRangePosition object.
78 * @return A GoRangePositionZ measurement.
79 */
80 GoFx(GoRangePositionZ) GoRangePosition_ZMeasurement(GoRangePosition tool);
81
82 /**
83 * @class GoRangeThickness
84 * @extends GoRangeTool
85 * @ingroup GoSdk-RangeTools
86 * @brief Represents a range thickness tool.
87 */
88 typedef GoRangeTool GoRangeThickness;
89
90 /**
91 * Returns a boolean value representing whether or not the measurement is set to return an absolute value.
92 *
93 * @public @memberof GoRangePosition
94 * @param tool GoRangePosition object.
95 * @return kTRUE if enabled and kFALSE otherwise.
96 */
97 GoFx(kBool) GoRangeThickness_AbsoluteEnabled(GoRangeThickness tool);
98
99 /**
100 * Enable or disable absolute value measurement output.
101 *
102 * @public @memberof GoRangePosition
103 * @param tool GoRangePosition object.
104 * @param enable kTRUE to enable absolute value and kFALSE to disable it.
105 * @return Operation status.
106 */
107 GoFx(kStatus) GoRangeThickness_EnableAbsolute(GoRangeThickness tool, kBool enable);
108
109 /**
110 * Returns a range thickness tool Thickness measurement object.
111 *
112 * @public @memberof GoRangeThickness
113 * @param tool GoRangeThickness object.
114 * @return A GoRangeThicknessThickness measurement.
115 */
116 GoFx(GoRangeThickness) GoRangeThickness_ThicknessMeasurement(GoRangeThickness tool);
117
118 kEndHeader()
119
120 #include <GoSdk/Tools/GoRangeTools.x.h>
121
122 #endif
123 /// @endcond
GoRangePosition::GoRangeThickness_AbsoluteEnabled
kBool GoRangeThickness_AbsoluteEnabled(GoRangeThickness tool)
Returns a boolean value representing whether or not the measurement is set to return an absolute valu...
GoRangeTool::GoRangeTool_SourceOptionCount
kSize GoRangeTool_SourceOptionCount(GoRangeTool tool)
Gets the data source option list count.
GoTool.h
Declares the base GoTool class.
GoRangeThickness::GoRangeThickness_ThicknessMeasurement
GoRangeThickness GoRangeThickness_ThicknessMeasurement(GoRangeThickness tool)
Returns a range thickness tool Thickness measurement object.
GoRangePosition
Represents a range position tool.
GoRangeThickness
Represents a range thickness tool.
GoRangePosition::GoRangeThickness_EnableAbsolute
kStatus GoRangeThickness_EnableAbsolute(GoRangeThickness tool, kBool enable)
Enable or disable absolute value measurement output.
GoDataSource
Represents a data source.
GoRangePositionZ
Represents a position Z measurement of a Range Position tool.
Definition: GoMeasurements.h:15
GoUtils.h
Contains various helper functions.
GoRangeTool::GoRangeTool_Source
GoDataSource GoRangeTool_Source(GoRangeTool tool)
Gets the data source.
GoSdkDef.h
Essential SDK declarations.
GoTool
Represents the base tool class.
Definition: GoTool.h:16
GoRangeTool
Represents a base range tool.
Definition: GoRangeTools.h:17
GoRangePosition::GoRangePosition_ZMeasurement
GoRangePositionZ GoRangePosition_ZMeasurement(GoRangePosition tool)
Returns a range position tool Z measurement object.
GoRangeTool::GoRangeTool_SourceOptionAt
GoDataSource GoRangeTool_SourceOptionAt(GoRangeTool tool, kSize index)
Gets the data source option at the given index.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoRangeTool::GoRangeTool_SetSource
kStatus GoRangeTool_SetSource(GoRangeTool tool, GoDataSource source)
Sets the data source.