Gocator API
 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-2021 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 typedef GoFeature GoExtFeature;
18 
19 /**
20 * Returns the number of custom parameters available for this extensible feature.
21 *
22 * @public @memberof GoExtFeature
23 * @version Introduced in firmware 4.6.3.142
24 * @param feature GoExtFeature object.
25 * @return Number of extensible parameters.
26 */
27 GoFx(kSize) GoExtFeature_CustomParameterCount(GoExtFeature feature);
28 
29 /**
30 * Returns the custom parameter at the specified index.
31 *
32 * @public @memberof GoExtFeature
33 * @version Introduced in firmware 4.6.3.142
34 * @param feature GoExtFeature object.
35 * @param index Index of parameter to retrieve.
36 * @return The custom feature parameter object.
37 */
38 GoFx(GoExtParam) GoExtFeature_CustomParameterAt(GoExtFeature feature, kSize index);
39 
40 /**
41 * @class GoSurfaceEdgeEdgeLine
42 * @extends GoFeature
43 * @ingroup GoSdk
44 * @brief Represents an edge line of a Surface Edge tool.
45 */
47 
48 
49 
50 /**
51 * @class GoSurfaceEdgeCenterPoint
52 * @extends GoFeature
53 * @ingroup GoSdk
54 * @brief Represents the center point of a Surface Edge tool.
55 */
57 
58 /**
59 * @class GoSurfaceBoundingBoxCenterPoint
60 * @extends GoFeature
61 * @ingroup GoSdk
62 * @brief Represents the center point of a Surface Bounding Box tool.
63 */
65 
66 /**
67 * @class GoSurfaceBoundingBoxAxisLine
68 * @extends GoFeature
69 * @ingroup GoSdk
70 * @brief Represents the axis line of a Surface Bounding Box tool.
71 */
73 
74 /**
75 * @class GoSurfaceCountersunkHoleCenterPoint
76 * @extends GoFeature
77 * @ingroup GoSdk
78 * @brief Represents the center point of a Surface Countersunk Hole tool.
79 */
81 
82 /**
83 * @class GoSurfaceDimensionCenterPoint
84 * @extends GoFeature
85 * @ingroup GoSdk
86 * @brief Represents the center point for a Surface Dimension tool.
87 */
89 
90 /**
91 * @class GoSurfaceEllipseCenterPoint
92 * @extends GoFeature
93 * @ingroup GoSdk
94 * @brief Represents the center point of an Surface Ellipse tool.
95 */
97 
98 /**
99 * @class GoSurfaceEllipseMajorAxisLine
100 * @extends GoFeature
101 * @ingroup GoSdk
102 * @brief Represents the major axis line of an Surface Ellipse tool.
103 */
105 
106 /**
107 * @class GoSurfaceEllipseMinorAxisLine
108 * @extends GoFeature
109 * @ingroup GoSdk
110 * @brief Represents the minor axis line of an Surface Ellipse tool.
111 */
113 
114 /**
115 * @class GoSurfaceHoleCenterPoint
116 * @extends GoFeature
117 * @ingroup GoSdk
118 * @brief Represents the center point of a Surface Hole tool.
119 */
121 
122 /**
123 * @class GoSurfaceOpeningCenterPoint
124 * @extends GoFeature
125 * @ingroup GoSdk
126 * @brief Represents the center point of a Surface Opening tool.
127 */
129 
130 /**
131 * @class GoSurfacePlanePlane
132 * @extends GoFeature
133 * @ingroup GoSdk
134 * @brief Represents a plane for a Surface Plane tool.
135 */
137 
138 /**
139 * @class GoSurfacePositionPoint
140 * @extends GoFeature
141 * @ingroup GoSdk
142 * @brief Represents a point of a Surface Position tool.
143 */
145 
146 /**
147 * @class GoSurfaceStudTipPoint
148 * @extends GoFeature
149 * @ingroup GoSdk
150 * @brief Represents a point of a Surface Stud Tip tool.
151 */
153 
154 /**
155 * @class GoSurfaceStudBasePoint
156 * @extends GoFeature
157 * @ingroup GoSdk
158 * @brief Represents a point of a Surface Stud Base tool.
159 */
161 
162 /**
163 * @class GoProfilePositionPoint
164 * @extends GoFeature
165 * @ingroup GoSdk
166 * @brief Represents a point of a Profile Position tool.
167 */
169 
170 /**
171 * @class GoProfileLineLine
172 * @extends GoFeature
173 * @ingroup GoSdk
174 * @brief Represents a point of a Profile Line tool.
175 */
177 
178 /**
179 * @class GoProfileLineMinErrorPoint
180 * @extends GoFeature
181 * @ingroup GoSdk
182 * @brief Represents a point of minimum error for a Profile Line tool.
183 */
185 
186 /**
187 * @class GoProfileLineMaxErrorPoint
188 * @extends GoFeature
189 * @ingroup GoSdk
190 * @brief Represents a point of maximum error for a Profile Line tool.
191 */
193 
194 /**
195 * @class GoProfileIntersectIntersectPoint
196 * @extends GoFeature
197 * @ingroup GoSdk
198 * @brief Represents a point of intersection for a Profile Intersect tool.
199 */
201 
202 /**
203 * @class GoProfileIntersectLine
204 * @extends GoFeature
205 * @ingroup GoSdk
206 * @brief Represents a line for a Profile Intersect tool.
207 */
209 
210 /**
211 * @class GoProfileIntersectBaseLine
212 * @extends GoFeature
213 * @ingroup GoSdk
214 * @brief Represents a base line feature of a Profile Intersect tool tool.
215 */
217 
218 /**
219 * @class GoProfileBoundingBoxCornerPoint
220 * @extends GoFeature
221 * @ingroup GoSdk
222 * @brief Represents a corner point for a Profile Bounding Box tool.
223 */
225 
226 /**
227 * @class GoProfileBoundingBoxCenterPoint
228 * @extends GoFeature
229 * @ingroup GoSdk
230 * @brief ReprRepresents a center point for a Profile Bounding Box tool.
231 */
233 
234 /**
235 * @class GoProfileAreaCenterPoint
236 * @extends GoFeature
237 * @ingroup GoSdk
238 * @brief Represents a center point of a Profile Area tool.
239 */
241 
242 /**
243 * @class GoProfileCircleCenterPoint
244 * @extends GoFeature
245 * @ingroup GoSdk
246 * @brief Represents a center point of a Profile Circle tool.
247 */
249 
250 /**
251 * @class GoProfileDimensionCenterPoint
252 * @extends GoFeature
253 * @ingroup GoSdk
254 * @brief Represents a center point of a Profile Dimension tool.
255 */
257 
258 /**
259 * @class GoProfilePanelLeftGapPoint
260 * @extends GoFeature
261 * @ingroup GoSdk
262 * @brief Represents a left gap point of a Profile Panel tool.
263 */
265 
266 /**
267 * @class GoProfilePanelLeftFlushPoint
268 * @extends GoFeature
269 * @ingroup GoSdk
270 * @brief Represents a left flush point of a Profile Panel tool.
271 */
273 
274 /**
275 * @class GoProfilePanelRightGapPoint
276 * @extends GoFeature
277 * @ingroup GoSdk
278 * @brief Represents a right gap point of a Profile Panel tool.
279 */
281 
282 /**
283 * @class GoProfilePanelRightFlushPoint
284 * @extends GoFeature
285 * @ingroup GoSdk
286 * @brief Represents a right flush point of a Profile Panel tool.
287 */
289 
290 /**
291 * @class GoProfileRoundCornerPoint
292 * @extends GoFeature
293 * @ingroup GoSdk
294 * @brief Represents a round corner point of a Profile Round tool.
295 */
297 
298 /**
299 * @class GoProfileRoundCornerEdgePoint
300 * @extends GoFeature
301 * @ingroup GoSdk
302 * @brief Represents a round corner edge point of a Profile Round tool.
303 */
305 
306 /**
307 * @class GoProfileRoundCornerCenterPoint
308 * @extends GoFeature
309 * @ingroup GoSdk
310 * @brief Represents a round corner circle center point of a Profile Round tool.
311 */
313 
315 
316 #include <GoSdk/Tools/GoFeatures.x.h>
317 
318 #endif
Represents a round corner point of a Profile Round tool.
Represents the major axis line of an Surface Ellipse tool.
Represents the axis line of a Surface Bounding Box tool.
Represents a corner point for a Profile Bounding Box tool.
Represents a point of a Surface Stud Tip tool.
Represents an edge line of a Surface Edge tool.
Represents the center point of a Surface Bounding Box tool.
Represents a right flush point of a Profile Panel tool.
Represents a left flush point of a Profile Panel tool.
Represents a round corner circle center point of a Profile Round tool.
Represents the center point of a Surface Hole tool.
Represents a right gap point of a Profile Panel tool.
Represents the center point of a Surface Opening tool.
Represents a point of a Profile Line tool.
ReprRepresents a center point for a Profile Bounding Box tool.
Represents a point of a Surface Stud Base tool.
Represents a point of intersection for a Profile Intersect tool.
Represents the center point of a Surface Edge tool.
Represents the minor axis line of an Surface Ellipse tool.
Represents a left gap point of a Profile Panel tool.
Essential SDK declarations.
Declares the GoFeature class.
Represents a center point of a Profile Area tool.
Represents a point of a Profile Position tool.
Represents a center point of a Profile Circle tool.
Represents the center point for a Surface Dimension tool.
Represents a base line feature of a Profile Intersect tool tool.
Represents the center point of an Surface Ellipse tool.
Represents the base class for a tool Feature or script output.
Represents a point of maximum error for a Profile Line tool.
Represents a round corner edge point of a Profile Round tool.
Represents the center point of a Surface Countersunk Hole tool.
Represents a plane for a Surface Plane tool.
Represents a line for a Profile Intersect tool.
Represents a point of minimum error for a Profile Line tool.
Represents a center point of a Profile Dimension tool.
Represents a point of a Surface Position tool.