Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSurfaceGeneration.h
Go to the documentation of this file.
1 /**
2  * @file GoSurfaceGeneration.h
3  * @brief Declares the GoSurfaceGeneration class.
4  *
5  * @internal
6  * Copyright (C) 2016-2021 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_SURFACEGENERATION_H
11 #define GO_SURFACEGENERATION_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 
15 /**
16  * @class GoSurfaceGeneration
17  * @extends kObject
18  * @note Supported with G2, G3
19  * @ingroup GoSdk-Surface
20  * @brief Represents a surface generation configuration.
21  */
23 
24 /**
25  * Sets the surface generation type.
26  *
27  * @public @memberof GoSurfaceGeneration
28  * @note Supported with G2, G3
29  * @version Introduced in firmware 4.0.10.27
30  * @param surface GoSurfaceGeneration object.
31  * @param type The surface generation type to set.
32  * @return Operation status.
33  */
35 
36 /**
37  * Gets the current surface generation type.
38  *
39  * @public @memberof GoSurfaceGeneration
40  * @note Supported with G2, G3
41  * @version Introduced in firmware 4.0.10.27
42  * @param surface GoSurfaceGeneration object.
43  * @return The surface generation type.
44  */
46 
47 /**
48  * Sets the fixed length surface generation start trigger.
49  *
50  * @public @memberof GoSurfaceGeneration
51  * @note Supported with G2, G3
52  * @version Introduced in firmware 4.0.10.27
53  * @param surface GoSurfaceGeneration object.
54  * @param trigger The surface generation start trigger value to set.
55  * @return Operation status.
56  */
58 
59 /**
60  * Gets the fixed length surface generation start trigger.
61  *
62  * @public @memberof GoSurfaceGeneration
63  * @note Supported with G2, G3
64  * @version Introduced in firmware 4.0.10.27
65  * @param surface GoSurfaceGeneration object.
66  * @return The fixed length surface generation start trigger.
67  */
69 
70 /**
71  * Sets the fixed length surface generation surface length.
72  *
73  * @public @memberof GoSurfaceGeneration
74  * @note Supported with G2, G3
75  * @version Introduced in firmware 4.0.10.27
76  * @param surface GoSurfaceGeneration object.
77  * @param length The fixed length surface generation surface length to set.
78  * @return Operation status.
79  */
81 
82 /**
83  * Gets the fixed length surface generation surface length.
84  *
85  * @public @memberof GoSurfaceGeneration
86  * @note Supported with G2, G3
87  * @version Introduced in firmware 4.0.10.27
88  * @param surface GoSurfaceGeneration object.
89  * @return The fixed length surface generation surface length.
90  */
92 
93 /**
94  * Gets the fixed length surface generation circumference limit maximum value.
95  *
96  * @public @memberof GoSurfaceGeneration
97  * @note Supported with G2, G3
98  * @version Introduced in firmware 4.0.10.27
99  * @param surface GoSurfaceGeneration object.
100  * @return The fixed length surface generation circumference limit maximum value.
101  */
103 
104 /**
105  * Gets the fixed length surface generation circumference limit minimum value.
106  *
107  * @public @memberof GoSurfaceGeneration
108  * @note Supported with G2, G3
109  * @version Introduced in firmware 4.0.10.27
110  * @param surface GoSurfaceGeneration object.
111  * @return The fixed length surface generation circumference limit minimum value.
112  */
114 
115 /**
116  * Gets the flag indicating whether the external input trigger is being used.
117  *
118  * @public @memberof GoSurfaceGeneration
119  * @note Supported with G2, G3
120  * @version Introduced in firmware 5.2.1.110
121  * @param surface GoSurfaceGeneration object.
122  * @return TRUE if being used, FALSE otherwise.
123  */
125 
126 /**
127  * Sets the external input index to trigger surface capturing.
128  *
129  * @public @memberof GoSurfaceGeneration
130  * @note Supported with G2, G3
131  * @version Introduced in firmware 5.2.1.110
132  * @param surface GoSurfaceGeneration object.
133  * @param index External digital input index.
134  * @return Operation status.
135  */
137 
138 /**
139  * Gets the external input index to trigger surface capturing.
140  *
141  * @public @memberof GoSurfaceGeneration
142  * @note Supported with G2, G3
143  * @version Introduced in firmware 5.2.1.110
144  * @param surface GoSurfaceGeneration object.
145  * @return External input index to trigger capturing.
146  */
148 
149 /**
150  * Gets the count of available external input trigger index options.
151  *
152  * @public @memberof GoSurfaceGeneration
153  * @note Supported with G2, G3
154  * @version Introduced in firmware 5.2.1.110
155  * @param surface GoSurfaceGeneration object.
156  * @return Count of external input index options.
157  */
159 
160 /**
161  * Sets the variable length surface generation maximum length.
162  *
163  * @public @memberof GoSurfaceGeneration
164  * @note Supported with G2, G3
165  * @version Introduced in firmware 4.0.10.27
166  * @param surface GoSurfaceGeneration object.
167  * @param length The variable length surface generation maximum length to set.
168  * @return Operation status.
169  */
171 
172 /**
173  * Gets the variable length surface generation maximum length.
174  *
175  * @public @memberof GoSurfaceGeneration
176  * @note Supported with G2, G3
177  * @version Introduced in firmware 4.0.10.27
178  * @param surface GoSurfaceGeneration object.
179  * @return The variable length surface generation maximum length.
180  */
182 
183 /**
184  * Gets the variable length surface generation circumference limit maximum value.
185  *
186  * @public @memberof GoSurfaceGeneration
187  * @note Supported with G2, G3
188  * @version Introduced in firmware 4.0.10.27
189  * @param surface GoSurfaceGeneration object.
190  * @return The variable length surface generation circumference limit maximum value.
191  */
193 
194 /**
195  * Gets the variable length surface generation circumference limit minimum value.
196  *
197  * @public @memberof GoSurfaceGeneration
198  * @note Supported with G2, G3
199  * @version Introduced in firmware 4.0.10.27
200  * @param surface GoSurfaceGeneration object.
201  * @return The variable length surface generation circumference limit minimum value.
202  */
204 
205 /**
206  * Sets the rotational surface generation surface encoder resolution.
207  *
208  * @public @memberof GoSurfaceGeneration
209  * @note Supported with G2, G3
210  * @version
211  * @param surface GoSurfaceGeneration object.
212  * @param value The rotational surface generation encoder resolution value [ticks/rev] to set.
213  * @return Operation status.
214  */
216 
217 /**
218  * Gets the rotational surface generation encoder resolution in ticks/rev.
219  *
220  * @public @memberof GoSurfaceGeneration
221  * @note Supported with G2, G3
222  * @version
223  * @param surface GoSurfaceGeneration object.
224  * @return The rotational surface generation encoder resolution.
225  */
227 
228 /**
229 * [Deprecated]
230 *
231 * Sets the rotational surface generation surface circumference.
232 *
233 * @deprecated
234 * @public @memberof GoSurfaceGeneration
235 * @note Supported with G2, G3
236 * @version Introduced in firmware 4.0.10.27
237 * @param surface GoSurfaceGeneration object.
238 * @param value The rotational surface generation circumference value to set.
239 * @return Operation status.
240 */
242 
243 /**
244 * [Deprecated]
245 *
246 * Gets the rotational surface generation circumference.
247 *
248 * @deprecated
249 * @public @memberof GoSurfaceGeneration
250 * @note Supported with G2, G3
251 * @version Introduced in firmware 4.0.10.27
252 * @param surface GoSurfaceGeneration object.
253 * @return The rotational surface generation circumference.
254 */
256 
257 /**
258 * [Deprecated]
259 *
260 * Gets the rotational surface generation circumference limit maximum value.
261 *
262 * @deprecated
263 * @public @memberof GoSurfaceGeneration
264 * @note Supported with G2, G3
265 * @version Introduced in firmware 4.0.10.27
266 * @param surface GoSurfaceGeneration object.
267 * @return The rotational surface generation circumference limit maximum value.
268 */
270 
271 /**
272 * [Deprecated]
273 *
274 * Gets the rotational surface generation circumference limit minimum value.
275 *
276 * @deprecated
277 * @public @memberof GoSurfaceGeneration
278 * @note Supported with G2, G3
279 * @version Introduced in firmware 4.0.10.27
280 * @param surface GoSurfaceGeneration object.
281 * @return The rotational surface generation circumference limit minimum value.
282 */
284 
285 #include <GoSdk/GoSurfaceGeneration.x.h>
286 
287 #endif
k64f GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface)
Gets the variable length surface generation maximum length.
kStatus GoSurfaceGenerationFixedLength_SetLength(GoSurfaceGeneration surface, k64f length)
Sets the fixed length surface generation surface length.
kStatus GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value)
[Deprecated]
k64f GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface)
[Deprecated]
k64f GoSurfaceGenerationFixedLength_Length(GoSurfaceGeneration surface)
Gets the fixed length surface generation surface length.
kBool GoSurfaceGenerationFixedLength_TriggerExternalInputIndexUsed(GoSurfaceGeneration surface)
Gets the flag indicating whether the external input trigger is being used.
kStatus GoSurfaceGenerationFixedLength_SetStartTrigger(GoSurfaceGeneration surface, GoSurfaceGenerationStartTrigger trigger)
Sets the fixed length surface generation start trigger.
k64f GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface)
[Deprecated]
Represents a surface generation start trigger.
kSize GoSurfaceGenerationFixedLength_TriggerExternalInputIndexOptionCount(GoSurfaceGeneration surface)
Gets the count of available external input trigger index options.
k64f GoSurfaceGenerationFixedLength_LengthLimitMax(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit maximum value.
kStatus GoSurfaceGenerationFixedLength_SetTriggerExternalInputIndex(GoSurfaceGeneration surface, k32s index)
Sets the external input index to trigger surface capturing.
k64f GoSurfaceGenerationRotational_EncoderResolution(GoSurfaceGeneration surface)
Gets the rotational surface generation encoder resolution in ticks/rev.
k64f GoSurfaceGenerationFixedLength_LengthLimitMin(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit minimum value.
Represents a surface generation type.
Represents a surface generation configuration.
Essential SDK declarations.
k64f GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface)
[Deprecated]
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit minimum value.
kStatus GoSurfaceGenerationRotational_SetEncoderResolution(GoSurfaceGeneration surface, k64f value)
Sets the rotational surface generation surface encoder resolution.
GoSurfaceGenerationType GoSurfaceGeneration_GenerationType(GoSurfaceGeneration surface)
Gets the current surface generation type.
kStatus GoSurfaceGeneration_SetGenerationType(GoSurfaceGeneration surface, GoSurfaceGenerationType type)
Sets the surface generation type.
kStatus GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length)
Sets the variable length surface generation maximum length.
GoSurfaceGenerationStartTrigger GoSurfaceGenerationFixedLength_StartTrigger(GoSurfaceGeneration surface)
Gets the fixed length surface generation start trigger.
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit maximum value.
k32s GoSurfaceGenerationFixedLength_TriggerExternalInputIndex(GoSurfaceGeneration surface)
Gets the external input index to trigger surface capturing.