Gocator API

GoSurfaceGeneration.h
1 /// @cond (Gocator_2x00 || Gocator_3x00)
2
3 /**
4 * @file GoSurfaceGeneration.h
5 * @brief Declares the GoSurfaceGeneration class.
6 *
7 * @internal
8 * Copyright (C) 2016-2020 by LMI Technologies Inc.
9 * Licensed under the MIT License.
10 * Redistributed files must retain the above copyright notice.
11 */
12 #ifndef GO_SURFACEGENERATION_H
13 #define GO_SURFACEGENERATION_H
14
15 #include <GoSdk/GoSdkDef.h>
16
17 kBeginHeader()
18
19 /**
20 * @class GoSurfaceGeneration
21 * @extends kObject
22 * @ingroup GoSdk-Surface
23 * @brief Represents a surface generation configuration.
24 */
25 typedef kObject GoSurfaceGeneration;
26
27 /**
28 * Sets the surface generation type.
29 *
30 * @public @memberof GoSurfaceGeneration
31 * @version Introduced in firmware 4.0.10.27
32 * @param surface GoSurfaceGeneration object.
33 * @param type The surface generation type to set.
34 * @return Operation status.
35 */
36 GoFx(kStatus) GoSurfaceGeneration_SetGenerationType(GoSurfaceGeneration surface, GoSurfaceGenerationType type);
37
38 /**
39 * Gets the current surface generation type.
40 *
41 * @public @memberof GoSurfaceGeneration
42 * @version Introduced in firmware 4.0.10.27
43 * @param surface GoSurfaceGeneration object.
44 * @return The surface generation type.
45 */
46 GoFx(GoSurfaceGenerationType) GoSurfaceGeneration_GenerationType(GoSurfaceGeneration surface);
47
48 /**
49 * Sets the fixed length surface generation start trigger.
50 *
51 * @public @memberof GoSurfaceGeneration
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 * @version Introduced in firmware 4.0.10.27
64 * @param surface GoSurfaceGeneration object.
65 * @return The fixed length surface generation start trigger.
66 */
67 GoFx(GoSurfaceGenerationStartTrigger) GoSurfaceGenerationFixedLength_StartTrigger(GoSurfaceGeneration surface);
68
69 /**
70 * Sets the fixed length surface generation surface length.
71 *
72 * @public @memberof GoSurfaceGeneration
73 * @version Introduced in firmware 4.0.10.27
74 * @param surface GoSurfaceGeneration object.
75 * @param length The fixed length surface generation surface length to set.
76 * @return Operation status.
77 */
78 GoFx(kStatus) GoSurfaceGenerationFixedLength_SetLength(GoSurfaceGeneration surface, k64f length);
79
80 /**
81 * Gets the fixed length surface generation surface length.
82 *
83 * @public @memberof GoSurfaceGeneration
84 * @version Introduced in firmware 4.0.10.27
85 * @param surface GoSurfaceGeneration object.
86 * @return The fixed length surface generation surface length.
87 */
88 GoFx(k64f) GoSurfaceGenerationFixedLength_Length(GoSurfaceGeneration surface);
89
90 /**
91 * Gets the fixed length surface generation circumference limit maximum value.
92 *
93 * @public @memberof GoSurfaceGeneration
94 * @version Introduced in firmware 4.0.10.27
95 * @param surface GoSurfaceGeneration object.
96 * @return The fixed length surface generation circumference limit maximum value.
97 */
98 GoFx(k64f) GoSurfaceGenerationFixedLength_LengthLimitMax(GoSurfaceGeneration surface);
99
100 /**
101 * Gets the fixed length surface generation circumference limit minimum value.
102 *
103 * @public @memberof GoSurfaceGeneration
104 * @version Introduced in firmware 4.0.10.27
105 * @param surface GoSurfaceGeneration object.
106 * @return The fixed length surface generation circumference limit minimum value.
107 */
108 GoFx(k64f) GoSurfaceGenerationFixedLength_LengthLimitMin(GoSurfaceGeneration surface);
109
110 /**
111 * Gets the flag indicating whether the external input trigger is being used.
112 *
113 * @public @memberof GoSurfaceGeneration
114 * @version Introduced in firmware 5.2.1.110
115 * @param surface GoSurfaceGeneration object.
116 * @return TRUE if being used, FALSE otherwise.
117 */
118 GoFx(kBool)GoSurfaceGenerationFixedLength_TriggerExternalInputIndexUsed(GoSurfaceGeneration surface);
119
120 /**
121 * Sets the external input index to trigger surface capturing.
122 *
123 * @public @memberof GoSurfaceGeneration
124 * @version Introduced in firmware 5.2.1.110
125 * @param surface GoSurfaceGeneration object.
126 * @param index External digital input index.
127 * @return Operation status.
128 */
129 GoFx(kStatus) GoSurfaceGenerationFixedLength_SetTriggerExternalInputIndex(GoSurfaceGeneration surface, k32s index);
130
131 /**
132 * Gets the external input index to trigger surface capturing.
133 *
134 * @public @memberof GoSurfaceGeneration
135 * @version Introduced in firmware 5.2.1.110
136 * @param surface GoSurfaceGeneration object.
137 * @return External input index to trigger capturing.
138 */
139 GoFx(k32s) GoSurfaceGenerationFixedLength_TriggerExternalInputIndex(GoSurfaceGeneration surface);
140
141 /**
142 * Gets the count of available external input trigger index options.
143 *
144 * @public @memberof GoSurfaceGeneration
145 * @version Introduced in firmware 5.2.1.110
146 * @param surface GoSurfaceGeneration object.
147 * @return Count of external input index options.
148 */
149 GoFx(kSize) GoSurfaceGenerationFixedLength_TriggerExternalInputIndexOptionCount(GoSurfaceGeneration surface);
150
151 /**
152 * Sets the variable length surface generation maximum length.
153 *
154 * @public @memberof GoSurfaceGeneration
155 * @version Introduced in firmware 4.0.10.27
156 * @param surface GoSurfaceGeneration object.
157 * @param length The variable length surface generation maximum length to set.
158 * @return Operation status.
159 */
160 GoFx(kStatus) GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length);
161
162 /**
163 * Gets the variable length surface generation maximum length.
164 *
165 * @public @memberof GoSurfaceGeneration
166 * @version Introduced in firmware 4.0.10.27
167 * @param surface GoSurfaceGeneration object.
168 * @return The variable length surface generation maximum length.
169 */
170 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface);
171
172 /**
173 * Gets the variable length surface generation circumference limit maximum value.
174 *
175 * @public @memberof GoSurfaceGeneration
176 * @version Introduced in firmware 4.0.10.27
177 * @param surface GoSurfaceGeneration object.
178 * @return The variable length surface generation circumference limit maximum value.
179 */
180 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface);
181
182 /**
183 * Gets the variable length surface generation circumference limit minimum value.
184 *
185 * @public @memberof GoSurfaceGeneration
186 * @version Introduced in firmware 4.0.10.27
187 * @param surface GoSurfaceGeneration object.
188 * @return The variable length surface generation circumference limit minimum value.
189 */
190 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface);
191
192 /**
193 * @deprecated Sets the rotational surface generation surface circumference.
194 *
195 * @public @memberof GoSurfaceGeneration
196 * @version Introduced in firmware 4.0.10.27
197 * @param surface GoSurfaceGeneration object.
198 * @param value The rotational surface generation circumference value to set.
199 * @return Operation status.
200 */
201 GoFx(kStatus) GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value);
202
203 /**
204 * @deprecated Gets the rotational surface generation circumference.
205 *
206 * @public @memberof GoSurfaceGeneration
207 * @version Introduced in firmware 4.0.10.27
208 * @param surface GoSurfaceGeneration object.
209 * @return The rotational surface generation circumference.
210 */
211 GoFx(k64f) GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface);
212
213 /**
214 * @deprecated Gets the rotational surface generation circumference limit maximum value.
215 *
216 * @public @memberof GoSurfaceGeneration
217 * @version Introduced in firmware 4.0.10.27
218 * @param surface GoSurfaceGeneration object.
219 * @return The rotational surface generation circumference limit maximum value.
220 */
221 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface);
222
223 /**
224 * @deprecated Gets the rotational surface generation circumference limit minimum value.
225 *
226 * @public @memberof GoSurfaceGeneration
227 * @version Introduced in firmware 4.0.10.27
228 * @param surface GoSurfaceGeneration object.
229 * @return The rotational surface generation circumference limit minimum value.
230 */
231 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface);
232
233 /**
234 * Sets the rotational surface generation surface encoder resolution.
235 *
236 * @public @memberof GoSurfaceGeneration
237 * @version
238 * @param surface GoSurfaceGeneration object.
239 * @param value The rotational surface generation encoder resolution value [ticks/rev] to set.
240 * @return Operation status.
241 */
242 GoFx(kStatus) GoSurfaceGenerationRotational_SetEncoderResolution(GoSurfaceGeneration surface, k64f value);
243
244 /**
245 * Gets the rotational surface generation encoder resolution in ticks/rev.
246 *
247 * @public @memberof GoSurfaceGeneration
248 * @version
249 * @param surface GoSurfaceGeneration object.
250 * @return The rotational surface generation encoder resolution.
251 */
252 GoFx(k64f) GoSurfaceGenerationRotational_EncoderResolution(GoSurfaceGeneration surface);
253
254 kEndHeader()
255 #include <GoSdk/GoSurfaceGeneration.x.h>
256
257 #endif
258
259 /// @endcond
kSize
GoSdkDef.h
Essential SDK declarations.
k32s
kObject
kStatus
k64f
kBool