Gocator API

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-2020 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 tool.
47 */
48 typedef GoFeature GoSurfaceEdgeEdgeLine;
49
50
51
52 /**
53 * @class GoSurfaceEdgeCenterPoint
54 * @extends GoFeature
55 * @ingroup GoSdk
56 * @brief Represents the center point of a Surface Edge tool.
57 */
58 typedef GoFeature GoSurfaceEdgeCenterPoint;
59
60 /**
61 * @class GoSurfaceBoundingBoxCenterPoint
62 * @extends GoFeature
63 * @ingroup GoSdk
64 * @brief Represents the center point of a Surface Bounding Box tool.
65 */
66 typedef GoFeature GoSurfaceBoundingBoxCenterPoint;
67
68
69 /**
70 * @class GoSurfaceCountersunkHoleCenterPoint
71 * @extends GoFeature
72 * @ingroup GoSdk
73 * @brief Represents the center point of a Surface Countersunk Hole tool.
74 */
75 typedef GoFeature GoSurfaceCountersunkHoleCenterPoint;
76
77 /**
78 * @class GoSurfaceDimensionCenterPoint
79 * @extends GoFeature
80 * @ingroup GoSdk
81 * @brief Represents the center point for a Surface Dimension tool.
82 */
83 typedef GoFeature GoSurfaceDimensionCenterPoint;
84
85 /**
86 * @class GoSurfaceEllipseCenterPoint
87 * @extends GoFeature
88 * @ingroup GoSdk
89 * @brief Represents the center point of an Surface Ellipse tool.
90 */
91 typedef GoFeature GoSurfaceEllipseCenterPoint;
92
93 /**
94 * @class GoSurfaceEllipseMajorAxisLine
95 * @extends GoFeature
96 * @ingroup GoSdk
97 * @brief Represents the major axis line of an Surface Ellipse tool.
98 */
99 typedef GoFeature GoSurfaceEllipseMajorAxisLine;
100
101 /**
102 * @class GoSurfaceEllipseMinorAxisLine
103 * @extends GoFeature
104 * @ingroup GoSdk
105 * @brief Represents the minor axis line of an Surface Ellipse tool.
106 */
107 typedef GoFeature GoSurfaceEllipseMinorAxisLine;
108
109 /**
110 * @class GoSurfaceHoleCenterPoint
111 * @extends GoFeature
112 * @ingroup GoSdk
113 * @brief Represents the center point of a Surface Hole tool.
114 */
115 typedef GoFeature GoSurfaceHoleCenterPoint;
116
117 /**
118 * @class GoSurfaceOpeningCenterPoint
119 * @extends GoFeature
120 * @ingroup GoSdk
121 * @brief Represents the center point of a Surface Opening tool.
122 */
123 typedef GoFeature GoSurfaceOpeningCenterPoint;
124
125 /**
126 * @class GoSurfacePlanePlane
127 * @extends GoFeature
128 * @ingroup GoSdk
129 * @brief Represents a plane for a Surface Plane tool.
130 */
131 typedef GoFeature GoSurfacePlanePlane;
132
133 /**
134 * @class GoSurfacePositionPoint
135 * @extends GoFeature
136 * @ingroup GoSdk
137 * @brief Represents a point of a Surface Position tool.
138 */
139 typedef GoFeature GoSurfacePositionPoint;
140
141 /**
142 * @class GoSurfaceStudTipPoint
143 * @extends GoFeature
144 * @ingroup GoSdk
145 * @brief Represents a point of a Surface Stud Tip tool.
146 */
147 typedef GoFeature GoSurfaceStudTipPoint;
148
149 /**
150 * @class GoSurfaceStudBasePoint
151 * @extends GoFeature
152 * @ingroup GoSdk
153 * @brief Represents a point of a Surface Stud Base tool.
154 */
155 typedef GoFeature GoSurfaceStudBasePoint;
156
157 /**
158 * @class GoProfilePositionPoint
159 * @extends GoFeature
160 * @ingroup GoSdk
161 * @brief Represents a point of a Profile Position tool.
162 */
163 typedef GoFeature GoProfilePositionPoint;
164
165 /**
166 * @class GoProfileLineLine
167 * @extends GoFeature
168 * @ingroup GoSdk
169 * @brief Represents a point of a Profile Line tool.
170 */
171 typedef GoFeature GoProfileLineLine;
172
173 /**
174 * @class GoProfileLineMinErrorPoint
175 * @extends GoFeature
176 * @ingroup GoSdk
177 * @brief Represents a point of minimum error for a Profile Line tool.
178 */
179 typedef GoFeature GoProfileLineMinErrorPoint;
180
181 /**
182 * @class GoProfileLineMaxErrorPoint
183 * @extends GoFeature
184 * @ingroup GoSdk
185 * @brief Represents a point of maximum error for a Profile Line tool.
186 */
187 typedef GoFeature GoProfileLineMaxErrorPoint;
188
189 /**
190 * @class GoProfileIntersectIntersectPoint
191 * @extends GoFeature
192 * @ingroup GoSdk
193 * @brief Represents a point of intersection for a Profile Intersect tool.
194 */
195 typedef GoFeature GoProfileIntersectIntersectPoint;
196
197 /**
198 * @class GoProfileIntersectLine
199 * @extends GoFeature
200 * @ingroup GoSdk
201 * @brief Represents a line for a Profile Intersect tool.
202 */
203 typedef GoFeature GoProfileIntersectLine;
204
205 /**
206 * @class GoProfileIntersectBaseLine
207 * @extends GoFeature
208 * @ingroup GoSdk
209 * @brief Represents a base line feature of a Profile Intersect tool tool.
210 */
211 typedef GoFeature GoProfileIntersectBaseLine;
212
213 /**
214 * @class GoProfileBoundingBoxCornerPoint
215 * @extends GoFeature
216 * @ingroup GoSdk
217 * @brief Represents a corner point for a Profile Bounding Box tool.
218 */
219 typedef GoFeature GoProfileBoundingBoxCornerPoint;
220
221 /**
222 * @class GoProfileBoundingBoxCenterPoint
223 * @extends GoFeature
224 * @ingroup GoSdk
225 * @brief ReprRepresents a center point for a Profile Bounding Box tool.
226 */
227 typedef GoFeature GoProfileBoundingBoxCenterPoint;
228
229 /**
230 * @class GoProfileAreaCenterPoint
231 * @extends GoFeature
232 * @ingroup GoSdk
233 * @brief Represents a center point of a Profile Area tool.
234 */
235 typedef GoFeature GoProfileAreaCenterPoint;
236
237 /**
238 * @class GoProfileCircleCenterPoint
239 * @extends GoFeature
240 * @ingroup GoSdk
241 * @brief Represents a center point of a Profile Circle tool.
242 */
243 typedef GoFeature GoProfileCircleCenterPoint;
244
245 /**
246 * @class GoProfileDimensionCenterPoint
247 * @extends GoFeature
248 * @ingroup GoSdk
249 * @brief Represents a center point of a Profile Dimension tool.
250 */
251 typedef GoFeature GoProfileDimensionCenterPoint;
252
253 /**
254 * @class GoProfilePanelLeftGapPoint
255 * @extends GoFeature
256 * @ingroup GoSdk
257 * @brief Represents a left gap point of a Profile Panel tool.
258 */
259 typedef GoFeature GoProfilePanelLeftGapPoint;
260
261 /**
262 * @class GoProfilePanelLeftFlushPoint
263 * @extends GoFeature
264 * @ingroup GoSdk
265 * @brief Represents a left flush point of a Profile Panel tool.
266 */
267 typedef GoFeature GoProfilePanelLeftFlushPoint;
268
269 /**
270 * @class GoProfilePanelRightGapPoint
271 * @extends GoFeature
272 * @ingroup GoSdk
273 * @brief Represents a right gap point of a Profile Panel tool.
274 */
275 typedef GoFeature GoProfilePanelRightGapPoint;
276
277 /**
278 * @class GoProfilePanelRightFlushPoint
279 * @extends GoFeature
280 * @ingroup GoSdk
281 * @brief Represents a right flush point of a Profile Panel tool.
282 */
283 typedef GoFeature GoProfilePanelRightFlushPoint;
284
285 /**
286 * @class GoProfileRoundCornerPoint
287 * @extends GoFeature
288 * @ingroup GoSdk
289 * @brief Represents a round corner point of a Profile Round tool.
290 */
291 typedef GoFeature GoProfileRoundCornerPoint;
292
293 /**
294 * @class GoProfileRoundCornerEdgePoint
295 * @extends GoFeature
296 * @ingroup GoSdk
297 * @brief Represents a round corner edge point of a Profile Round tool.
298 */
299 typedef GoFeature GoProfileRoundCornerEdgePoint;
300
301 /**
302 * @class GoProfileRoundCornerCenterPoint
303 * @extends GoFeature
304 * @ingroup GoSdk
305 * @brief Represents a round corner circle center point of a Profile Round tool.
306 */
307 typedef GoFeature GoProfileRoundCornerCenterPoint;
308
309 typedef GoFeature GoBoundingBoxCenterPoint;
310 kEndHeader()
311 #include <GoSdk/Tools/GoFeatures.x.h>
312
313 #endif
GoProfileRoundCornerPoint
Represents a round corner point of a Profile Round tool.
GoSurfaceEllipseMajorAxisLine
Represents the major axis line of an Surface Ellipse tool.
GoProfileBoundingBoxCornerPoint
Represents a corner point for a Profile Bounding Box tool.
GoSurfaceStudTipPoint
Represents a point of a Surface Stud Tip tool.
GoSurfaceEdgeEdgeLine
Represents an edge line of a Surface Edge tool.
GoSurfaceBoundingBoxCenterPoint
Represents the center point of a Surface Bounding Box tool.
GoProfilePanelRightFlushPoint
Represents a right flush point of a Profile Panel tool.
GoProfilePanelLeftFlushPoint
Represents a left flush point of a Profile Panel tool.
GoProfileRoundCornerCenterPoint
Represents a round corner circle center point of a Profile Round tool.
GoSurfaceHoleCenterPoint
Represents the center point of a Surface Hole tool.
GoProfilePanelRightGapPoint
Represents a right gap point of a Profile Panel tool.
GoSurfaceOpeningCenterPoint
Represents the center point of a Surface Opening tool.
GoProfileLineLine
Represents a point of a Profile Line tool.
GoProfileBoundingBoxCenterPoint
ReprRepresents a center point for a Profile Bounding Box tool.
GoSurfaceStudBasePoint
Represents a point of a Surface Stud Base tool.
GoProfileIntersectIntersectPoint
Represents a point of intersection for a Profile Intersect tool.
kSize
GoSurfaceEdgeCenterPoint
Represents the center point of a Surface Edge tool.
GoSurfaceEllipseMinorAxisLine
Represents the minor axis line of an Surface Ellipse tool.
GoProfilePanelLeftGapPoint
Represents a left gap point of a Profile Panel tool.
GoSdkDef.h
Essential SDK declarations.
GoFeature.h
Declares the GoFeature class.
GoProfileAreaCenterPoint
Represents a center point of a Profile Area tool.
GoProfilePositionPoint
Represents a point of a Profile Position tool.
GoProfileCircleCenterPoint
Represents a center point of a Profile Circle tool.
GoSurfaceDimensionCenterPoint
Represents the center point for a Surface Dimension tool.
GoProfileIntersectBaseLine
Represents a base line feature of a Profile Intersect tool tool.
GoSurfaceEllipseCenterPoint
Represents the center point of an Surface Ellipse tool.
GoFeature
Represents the base class for a tool Feature or script output.
GoProfileLineMaxErrorPoint
Represents a point of maximum error for a Profile Line tool.
GoProfileRoundCornerEdgePoint
Represents a round corner edge point of a Profile Round tool.
GoSurfaceCountersunkHoleCenterPoint
Represents the center point of a Surface Countersunk Hole tool.
GoSurfacePlanePlane
Represents a plane for a Surface Plane tool.
GoProfileIntersectLine
Represents a line for a Profile Intersect tool.
GoProfileLineMinErrorPoint
Represents a point of minimum error for a Profile Line tool.
GoProfileDimensionCenterPoint
Represents a center point of a Profile Dimension tool.
GoSurfacePositionPoint
Represents a point of a Surface Position tool.