Gocator API

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