Gocator API

- Home
- Topics
- Types
- Files

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-2022 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 */
22 typedef kObject GoSurfaceGeneration;
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 */
34 GoFx(kStatus) GoSurfaceGeneration_SetGenerationType(GoSurfaceGeneration surface, GoSurfaceGenerationType type);
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 */
45 GoFx(GoSurfaceGenerationType) GoSurfaceGeneration_GenerationType(GoSurfaceGeneration surface);
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 */
57 GoFx(kStatus) GoSurfaceGenerationFixedLength_SetStartTrigger(GoSurfaceGeneration surface, GoSurfaceGenerationStartTrigger trigger);
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 */
68 GoFx(GoSurfaceGenerationStartTrigger) GoSurfaceGenerationFixedLength_StartTrigger(GoSurfaceGeneration surface);
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 */
80 GoFx(kStatus) GoSurfaceGenerationFixedLength_SetLength(GoSurfaceGeneration surface, k64f length);
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 */
91 GoFx(k64f) GoSurfaceGenerationFixedLength_Length(GoSurfaceGeneration surface);
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 */
102 GoFx(k64f) GoSurfaceGenerationFixedLength_LengthLimitMax(GoSurfaceGeneration surface);
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 */
113 GoFx(k64f) GoSurfaceGenerationFixedLength_LengthLimitMin(GoSurfaceGeneration surface);
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 */
124 GoFx(kBool)GoSurfaceGenerationFixedLength_TriggerExternalInputIndexUsed(GoSurfaceGeneration surface);
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 */
136 GoFx(kStatus) GoSurfaceGenerationFixedLength_SetTriggerExternalInputIndex(GoSurfaceGeneration surface, k32s index);
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 */
147 GoFx(k32s) GoSurfaceGenerationFixedLength_TriggerExternalInputIndex(GoSurfaceGeneration surface);
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 */
158 GoFx(kSize) GoSurfaceGenerationFixedLength_TriggerExternalInputIndexOptionCount(GoSurfaceGeneration surface);
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 */
170 GoFx(kStatus) GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length);
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 */
181 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface);
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 */
192 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface);
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 */
203 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface);
204
205 /**
206 * @deprecated Sets the rotational surface generation surface circumference.
207 *
208 * @public @memberof GoSurfaceGeneration
209 * @note Supported with G2, G3
210 * @version Introduced in firmware 4.0.10.27
211 * @param surface GoSurfaceGeneration object.
212 * @param value The rotational surface generation circumference value to set.
213 * @return Operation status.
214 */
215 GoFx(kStatus) GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value);
216
217 /**
218 * @deprecated Gets the rotational surface generation circumference.
219 *
220 * @public @memberof GoSurfaceGeneration
221 * @note Supported with G2, G3
222 * @version Introduced in firmware 4.0.10.27
223 * @param surface GoSurfaceGeneration object.
224 * @return The rotational surface generation circumference.
225 */
226 GoFx(k64f) GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface);
227
228 /**
229 * @deprecated Gets the rotational surface generation circumference limit maximum value.
230 *
231 * @public @memberof GoSurfaceGeneration
232 * @note Supported with G2, G3
233 * @version Introduced in firmware 4.0.10.27
234 * @param surface GoSurfaceGeneration object.
235 * @return The rotational surface generation circumference limit maximum value.
236 */
237 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface);
238
239 /**
240 * @deprecated Gets the rotational surface generation circumference limit minimum value.
241 *
242 * @public @memberof GoSurfaceGeneration
243 * @note Supported with G2, G3
244 * @version Introduced in firmware 4.0.10.27
245 * @param surface GoSurfaceGeneration object.
246 * @return The rotational surface generation circumference limit minimum value.
247 */
248 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface);
249
250 /**
251 * Sets the rotational surface generation surface encoder resolution.
252 *
253 * @public @memberof GoSurfaceGeneration
254 * @note Supported with G2, G3
255 * @version
256 * @param surface GoSurfaceGeneration object.
257 * @param value The rotational surface generation encoder resolution value [ticks/rev] to set.
258 * @return Operation status.
259 */
260 GoFx(kStatus) GoSurfaceGenerationRotational_SetEncoderResolution(GoSurfaceGeneration surface, k64f value);
261
262 /**
263 * Gets the rotational surface generation encoder resolution in ticks/rev.
264 *
265 * @public @memberof GoSurfaceGeneration
266 * @note Supported with G2, G3
267 * @version
268 * @param surface GoSurfaceGeneration object.
269 * @return The rotational surface generation encoder resolution.
270 */
271 GoFx(k64f) GoSurfaceGenerationRotational_EncoderResolution(GoSurfaceGeneration surface);
272
273 #include <GoSdk/GoSurfaceGeneration.x.h>
274
275 #endif
GoSurfaceGeneration::GoSurfaceGenerationVariableLength_MaxLength
k64f GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface)
Gets the variable length surface generation maximum length.
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_SetLength
kStatus GoSurfaceGenerationFixedLength_SetLength(GoSurfaceGeneration surface, k64f length)
Sets the fixed length surface generation surface length.
GoSurfaceGeneration::GoSurfaceGenerationRotational_SetCircumference
kStatus GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value)
GoSurfaceGeneration::GoSurfaceGenerationRotational_Circumference
k64f GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface)
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_Length
k64f GoSurfaceGenerationFixedLength_Length(GoSurfaceGeneration surface)
Gets the fixed length surface generation surface length.
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_TriggerExternalInputIndexUsed
kBool GoSurfaceGenerationFixedLength_TriggerExternalInputIndexUsed(GoSurfaceGeneration surface)
Gets the flag indicating whether the external input trigger is being used.
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_SetStartTrigger
kStatus GoSurfaceGenerationFixedLength_SetStartTrigger(GoSurfaceGeneration surface, GoSurfaceGenerationStartTrigger trigger)
Sets the fixed length surface generation start trigger.
GoSurfaceGeneration::GoSurfaceGenerationRotational_CircumferenceLimitMin
k64f GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface)
GoSurfaceGenerationStartTrigger
Represents a surface generation start trigger.
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_TriggerExternalInputIndexOptionCount
kSize GoSurfaceGenerationFixedLength_TriggerExternalInputIndexOptionCount(GoSurfaceGeneration surface)
Gets the count of available external input trigger index options.
kSize
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_LengthLimitMax
k64f GoSurfaceGenerationFixedLength_LengthLimitMax(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit maximum value.
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_SetTriggerExternalInputIndex
kStatus GoSurfaceGenerationFixedLength_SetTriggerExternalInputIndex(GoSurfaceGeneration surface, k32s index)
Sets the external input index to trigger surface capturing.
GoSurfaceGeneration::GoSurfaceGenerationRotational_EncoderResolution
k64f GoSurfaceGenerationRotational_EncoderResolution(GoSurfaceGeneration surface)
Gets the rotational surface generation encoder resolution in ticks/rev.
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_LengthLimitMin
k64f GoSurfaceGenerationFixedLength_LengthLimitMin(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit minimum value.
GoSurfaceGenerationType
Represents a surface generation type.
GoSurfaceGeneration
Represents a surface generation configuration.
GoSdkDef.h
Essential SDK declarations.
GoSurfaceGeneration::GoSurfaceGenerationRotational_CircumferenceLimitMax
k64f GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface)
GoSurfaceGeneration::GoSurfaceGenerationVariableLength_MaxLengthLimitMin
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit minimum value.
k32s
GoSurfaceGeneration::GoSurfaceGenerationRotational_SetEncoderResolution
kStatus GoSurfaceGenerationRotational_SetEncoderResolution(GoSurfaceGeneration surface, k64f value)
Sets the rotational surface generation surface encoder resolution.
GoSurfaceGeneration::GoSurfaceGeneration_GenerationType
GoSurfaceGenerationType GoSurfaceGeneration_GenerationType(GoSurfaceGeneration surface)
Gets the current surface generation type.
GoSurfaceGeneration::GoSurfaceGeneration_SetGenerationType
kStatus GoSurfaceGeneration_SetGenerationType(GoSurfaceGeneration surface, GoSurfaceGenerationType type)
Sets the surface generation type.
kObject
GoSurfaceGeneration::GoSurfaceGenerationVariableLength_SetMaxLength
kStatus GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length)
Sets the variable length surface generation maximum length.
kStatus
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_StartTrigger
GoSurfaceGenerationStartTrigger GoSurfaceGenerationFixedLength_StartTrigger(GoSurfaceGeneration surface)
Gets the fixed length surface generation start trigger.
k64f
kBool
GoSurfaceGeneration::GoSurfaceGenerationVariableLength_MaxLengthLimitMax
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit maximum value.
GoSurfaceGeneration::GoSurfaceGenerationFixedLength_TriggerExternalInputIndex
k32s GoSurfaceGenerationFixedLength_TriggerExternalInputIndex(GoSurfaceGeneration surface)
Gets the external input index to trigger surface capturing.