Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoFeatures.h
Go to the documentation of this file.
1 /**
2 * @file GoFeatures.h
3 * @brief Declares the GoFeatures classes.
4 *
5 * @internal
6 * Copyright (C) 2017 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_FEATURES_H
11 #define GO_SDK_FEATURES_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoFeature.h>
15 #include <GoSdk/Tools/GoExtParams.h>
16
17 kBeginHeader()
18
19 typedef GoFeature GoExtFeature;
20
21 /**
22 * Returns the number of custom parameters available for this extensible feature.
23 *
24 * @public @memberof GoExtFeature
25 * @version Introduced in firmware 4.6.3.142
26 * @param feature GoExtFeature object.
27 * @return Number of extensible parameters.
28 */
29 GoFx(kSize) GoExtFeature_CustomParameterCount(GoExtFeature feature);
30
31 /**
32 * Returns the custom parameter at the specified index.
33 *
34 * @public @memberof GoExtFeature
35 * @version Introduced in firmware 4.6.3.142
36 * @param feature GoExtFeature object.
37 * @param index Index of parameter to retrieve.
38 * @return The custom feature parameter object.
39 */
40 GoFx(GoExtParam) GoExtFeature_CustomParameterAt(GoExtFeature feature, kSize index);
41
42 /**
43 * @class GoSurfaceEdgeEdgeLine
44 * @extends GoFeature
45 * @ingroup GoSdk
46 * @brief Represents an edge line.of a Surface Edge
47 */
48 typedef GoFeature GoSurfaceEdgeEdgeLine;
49
50
51
52 /**
53 * @class GoSurfaceEdgeCenterPoint
54 * @extends GoFeature
55 * @ingroup GoSdk
56 * @brief Represents an center point.of a Surface Edge
57 */
58 typedef GoFeature GoSurfaceEdgeCenterPoint;
59
60 /**
61 * @class GoSurfaceBoundingBoxCenterPoint
62 * @extends GoMeasurement
63 * @ingroup GoSdk
64 * @brief Represents a position Z measurement of a Range Position tool.
65 */
66 typedef GoFeature GoSurfaceBoundingBoxCenterPoint;
67
68
69 /**
70 * @class GoSurfaceCountersunkHoleCenterPoint
71 * @extends GoMeasurement
72 * @ingroup GoSdk
73 * @brief Represents a position Z measurement of a Range Position tool.
74 */
75 typedef GoFeature GoSurfaceCountersunkHoleCenterPoint;
76
77 /**
78 * @class GoSurfaceDimensionCenterPoint
79 * @extends GoMeasurement
80 * @ingroup GoSdk
81 * @brief Represents a position Z measurement of a Range Position tool.
82 */
83 typedef GoFeature GoSurfaceDimensionCenterPoint;
84
85 /**
86 * @class GoSurfaceEllipseCenterPoint
87 * @extends GoMeasurement
88 * @ingroup GoSdk
89 * @brief Represents a position Z measurement of a Range Position tool.
90 */
91 typedef GoFeature GoSurfaceEllipseCenterPoint;
92
93 /**
94 * @class GoSurfaceEllipseMajorAxisLine
95 * @extends GoMeasurement
96 * @ingroup GoSdk
97 * @brief Represents a major axis line.
98 */
99 typedef GoFeature GoSurfaceEllipseMajorAxisLine;
100
101 /**
102 * @class GoSurfaceEllipseMinorAxisLine
103 * @extends GoMeasurement
104 * @ingroup GoSdk
105 * @brief Represents a minor axis line.
106 */
107 typedef GoFeature GoSurfaceEllipseMinorAxisLine;
108
109 /**
110 * @class GoSurfaceHoleCenterPoint
111 * @extends GoMeasurement
112 * @ingroup GoSdk
113 * @brief Represents a position Z measurement of a Range Position tool.
114 */
115 typedef GoFeature GoSurfaceHoleCenterPoint;
116
117 /**
118 * @class GoSurfaceOpeningCenterPoint
119 * @extends GoMeasurement
120 * @ingroup GoSdk
121 * @brief Represents a position Z measurement of a Range Position tool.
122 */
123 typedef GoFeature GoSurfaceOpeningCenterPoint;
124
125 /**
126 * @class GoSurfacePositionPoint
127 * @extends GoMeasurement
128 * @ingroup GoSdk
129 * @brief Represents a position Z measurement of a Range Position tool.
130 */
131 typedef GoFeature GoSurfacePositionPoint;
132
133 /**
134 * @class GoSurfaceStudTipPoint
135 * @extends GoMeasurement
136 * @ingroup GoSdk
137 * @brief Represents a position Z measurement of a Range Position tool.
138 */
139 typedef GoFeature GoSurfaceStudTipPoint;
140
141 /**
142 * @class GoSurfaceStudBasePoint
143 * @extends GoMeasurement
144 * @ingroup GoSdk
145 * @brief Represents a position Z measurement of a Range Position tool.
146 */
147 typedef GoFeature GoSurfaceStudBasePoint;
148
149 /**
150 * @class GoProfilePositionPoint
151 * @extends GoMeasurement
152 * @ingroup GoSdk
153 * @brief Represents a position Z measurement of a Range Position tool.
154 */
155 typedef GoFeature GoProfilePositionPoint;
156
157 /**
158 * @class GoProfileLineLine
159 * @extends GoMeasurement
160 * @ingroup GoSdk
161 * @brief Represents a position Z measurement of a Range Position tool.
162 */
163 typedef GoFeature GoProfileLineLine;
164
165 /**
166 * @class GoProfileLineMinErrorPoint
167 * @extends GoMeasurement
168 * @ingroup GoSdk
169 * @brief Represents a position Z measurement of a Range Position tool.
170 */
171 typedef GoFeature GoProfileLineMinErrorPoint;
172
173 /**
174 * @class GoProfileLineMaxErrorPoint
175 * @extends GoMeasurement
176 * @ingroup GoSdk
177 * @brief Represents a position Z measurement of a Range Position tool.
178 */
179 typedef GoFeature GoProfileLineMaxErrorPoint;
180
181 /**
182 * @class GoProfileIntersectIntersectPoint
183 * @extends GoMeasurement
184 * @ingroup GoSdk
185 * @brief Represents a position Z measurement of a Range Position tool.
186 */
187 typedef GoFeature GoProfileIntersectIntersectPoint;
188
189 /**
190 * @class GoProfileIntersectLine
191 * @extends GoMeasurement
192 * @ingroup GoSdk
193 * @brief Represents a position Z measurement of a Range Position tool.
194 */
195 typedef GoFeature GoProfileIntersectLine;
196
197 /**
198 * @class GoProfileIntersectBaseLine
199 * @extends GoFeature
200 * @ingroup GoSdk
201 * @brief Represents a base line feature of a Profile Intersect tool.
202 */
203 typedef GoFeature GoProfileIntersectBaseLine;
204
205 /**
206 * @class GoProfileBoundingBoxCornerPoint
207 * @extends GoMeasurement
208 * @ingroup GoSdk
209 * @brief Represents a position Z measurement of a Range Position tool.
210 */
211 typedef GoFeature GoProfileBoundingBoxCornerPoint;
212
213 /**
214 * @class GoProfileBoundingBoxCenterPoint
215 * @extends GoMeasurement
216 * @ingroup GoSdk
217 * @brief Represents a position Z measurement of a Range Position tool.
218 */
219 typedef GoFeature GoProfileBoundingBoxCenterPoint;
220
221 /**
222 * @class GoProfileAreaCenterPoint
223 * @extends GoMeasurement
224 * @ingroup GoSdk
225 * @brief Represents a center point feature of a Profile Area tool.
226 */
227 typedef GoFeature GoProfileAreaCenterPoint;
228
229 /**
230 * @class GoProfileCircleCenterPoint
231 * @extends GoMeasurement
232 * @ingroup GoSdk
233 * @brief Represents a position Z measurement of a Range Position tool.
234 */
235 typedef GoFeature GoProfileCircleCenterPoint;
236
237 /**
238 * @class GoProfileDimensionCenterPoint
239 * @extends GoMeasurement
240 * @ingroup GoSdk
241 * @brief Represents a position Z measurement of a Range Position tool.
242 */
243 typedef GoFeature GoProfileDimensionCenterPoint;
244
245 /**
246 * @class GoProfilePanelLeftGapPoint
247 * @extends GoMeasurement
248 * @ingroup GoSdk
249 * @brief Represents a position Z measurement of a Range Position tool.
250 */
251 typedef GoFeature GoProfilePanelLeftGapPoint;
252
253 /**
254 * @class GoProfilePanelLeftFlushPoint
255 * @extends GoMeasurement
256 * @ingroup GoSdk
257 * @brief Represents a position Z measurement of a Range Position tool.
258 */
259 typedef GoFeature GoProfilePanelLeftFlushPoint;
260
261 /**
262 * @class GoProfilePanelRightGapPoint
263 * @extends GoMeasurement
264 * @ingroup GoSdk
265 * @brief Represents a position Z measurement of a Range Position tool.
266 */
267 typedef GoFeature GoProfilePanelRightGapPoint;
268
269 /**
270 * @class GoProfilePanelRightFlushPoint
271 * @extends GoMeasurement
272 * @ingroup GoSdk
273 * @brief Represents a position Z measurement of a Range Position tool.
274 */
275 typedef GoFeature GoProfilePanelRightFlushPoint;
276
277 /**
278 * @class GoProfileRoundCornerPoint
279 * @extends GoMeasurement
280 * @ingroup GoSdk
281 * @brief Represents a position Z measurement of a Range Position tool.
282 */
283 typedef GoFeature GoProfileRoundCornerPoint;
284
285
286 typedef GoFeature GoBoundingBoxCenterPoint;
287 kEndHeader()
288 #include <GoSdk/Tools/GoFeatures.x.h>
289
290 #endif
GoProfileRoundCornerPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceEllipseMajorAxisLine
Represents a major axis line.
GoProfileBoundingBoxCornerPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceStudTipPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceEdgeEdgeLine
Represents an edge line.of a Surface Edge.
GoSurfaceBoundingBoxCenterPoint
Represents a position Z measurement of a Range Position tool.
GoProfilePanelRightFlushPoint
Represents a position Z measurement of a Range Position tool.
GoProfilePanelLeftFlushPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceHoleCenterPoint
Represents a position Z measurement of a Range Position tool.
GoProfilePanelRightGapPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceOpeningCenterPoint
Represents a position Z measurement of a Range Position tool.
GoProfileLineLine
Represents a position Z measurement of a Range Position tool.
GoProfileBoundingBoxCenterPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceStudBasePoint
Represents a position Z measurement of a Range Position tool.
GoProfileIntersectIntersectPoint
Represents a position Z measurement of a Range Position tool.
kSize
GoSurfaceEdgeCenterPoint
Represents an center point.of a Surface Edge.
GoSurfaceEllipseMinorAxisLine
Represents a minor axis line.
GoProfilePanelLeftGapPoint
Represents a position Z measurement of a Range Position tool.
GoSdkDef.h
Essential SDK declarations.
GoFeature.h
Declares the GoFeature class.
GoProfileAreaCenterPoint
Represents a center point feature of a Profile Area tool.
GoProfilePositionPoint
Represents a position Z measurement of a Range Position tool.
GoProfileCircleCenterPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceDimensionCenterPoint
Represents a position Z measurement of a Range Position tool.
GoProfileIntersectBaseLine
Represents a base line feature of a Profile Intersect tool.
GoSurfaceEllipseCenterPoint
Represents a position Z measurement of a Range Position tool.
GoFeature
Represents the base class for a tool Feature or script output.
GoProfileLineMaxErrorPoint
Represents a position Z measurement of a Range Position tool.
GoSurfaceCountersunkHoleCenterPoint
Represents a position Z measurement of a Range Position tool.
GoProfileIntersectLine
Represents a position Z measurement of a Range Position tool.
GoProfileLineMinErrorPoint
Represents a position Z measurement of a Range Position tool.
GoProfileDimensionCenterPoint
Represents a position Z measurement of a Range Position tool.
GoSurfacePositionPoint
Represents a position Z measurement of a Range Position tool.