Gocator API

GoProfileGeneration.h
1 /// @cond (Gocator_1x00)
2
3 /**
4 * @file GoProfileGeneration.h
5 * @brief Declares the GoProfileGeneration 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_PROFILEGENERATION_H
13 #define GO_PROFILEGENERATION_H
14
15 #include <GoSdk/GoSdkDef.h>
16
17 kBeginHeader()
18
19 /**
20 * @class GoProfileGeneration
21 * @extends kObject
22 * @ingroup GoSdk-Profile
23 * @brief Represents a profile generation configuration.
24 */
25 typedef kObject GoProfileGeneration;
26
27 /**
28 * Sets the profile generation type.
29 *
30 * @public @memberof GoProfileGeneration
31 * @version Introduced in firmware 4.2.4.7
32 * @param profile GoProfileGeneration object.
33 * @param type The profile generation type to set.
34 * @return Operation status.
35 */
36 GoFx(kStatus) GoProfileGeneration_SetGenerationType(GoProfileGeneration profile, GoProfileGenerationType type);
37
38 /**
39 * Gets the current profile generation type.
40 *
41 * @public @memberof GoProfileGeneration
42 * @version Introduced in firmware 4.2.4.7
43 * @param profile GoProfileGeneration object.
44 * @return The profile generation type.
45 */
46 GoFx(GoProfileGenerationType) GoProfileGeneration_GenerationType(GoProfileGeneration profile);
47
48 /**
49 * Sets the fixed length profile generation start trigger.
50 *
51 * @public @memberof GoProfileGeneration
52 * @version Introduced in firmware 4.2.4.7
53 * @param profile GoProfileGeneration object.
54 * @param trigger The profile generation start trigger value to set.
55 * @return Operation status.
56 */
57 GoFx(kStatus) GoProfileGenerationFixedLength_SetStartTrigger(GoProfileGeneration profile, GoProfileGenerationStartTrigger trigger);
58
59 /**
60 * Gets the fixed length profile generation start trigger.
61 *
62 * @public @memberof GoProfileGeneration
63 * @version Introduced in firmware 4.2.4.7
64 * @param profile GoProfileGeneration object.
65 * @return The fixed length profile generation start trigger.
66 */
67 GoFx(GoProfileGenerationStartTrigger) GoProfileGenerationFixedLength_StartTrigger(GoProfileGeneration profile);
68
69 /**
70 * Gets the flag indicating whether the external input trigger is being used.
71 *
72 * @public @memberof GoProfileGeneration
73 * @version Introduced in firmware 5.2.1.110
74 * @param surface GoProfileGeneration object.
75 * @return TRUE if being used, FALSE otherwise.
76 */
77 GoFx(kBool)GoProfileGenerationFixedLength_TriggerExternalInputIndexUsed(GoProfileGeneration surface);
78
79 /**
80 * Sets the external input index to trigger surface capturing.
81 *
82 * @public @memberof GoProfileGeneration
83 * @version Introduced in firmware 5.2.1.110
84 * @param surface GoProfileGeneration object.
85 * @param index External digital input index.
86 * @return Operation status.
87 */
88 GoFx(kStatus) GoProfileGenerationFixedLength_SetTriggerExternalInputIndex(GoProfileGeneration surface, k32s index);
89
90 /**
91 * Gets the external input index to trigger surface capturing.
92 *
93 * @public @memberof GoProfileGeneration
94 * @version Introduced in firmware 5.2.1.110
95 * @param surface GoProfileGeneration object.
96 * @return External input index to trigger capturing.
97 */
98 GoFx(k32s) GoProfileGenerationFixedLength_TriggerExternalInputIndex(GoProfileGeneration surface);
99
100 /**
101 * Gets the count of available external input trigger index options.
102 *
103 * @public @memberof GoProfileGeneration
104 * @version Introduced in firmware 5.2.1.110
105 * @param surface GoProfileGeneration object.
106 * @return Count of external input index options.
107 */
108 GoFx(kSize) GoProfileGenerationFixedLength_TriggerExternalInputIndexOptionCount(GoProfileGeneration surface);
109
110 /**
111 * Sets the fixed length profile generation profile length.
112 *
113 * @public @memberof GoProfileGeneration
114 * @version Introduced in firmware 4.2.4.7
115 * @param profile GoProfileGeneration object.
116 * @param length The fixed length profile generation profile length to set.
117 * @return Operation status.
118 */
119 GoFx(kStatus) GoProfileGenerationFixedLength_SetLength(GoProfileGeneration profile, k64f length);
120
121 /**
122 * Gets the fixed length profile generation profile length.
123 *
124 * @public @memberof GoProfileGeneration
125 * @version Introduced in firmware 4.2.4.7
126 * @param profile GoProfileGeneration object.
127 * @return The fixed length profile generation profile length.
128 */
129 GoFx(k64f) GoProfileGenerationFixedLength_Length(GoProfileGeneration profile);
130
131 /**
132 * Gets the fixed length profile generation circumference limit maximum value.
133 *
134 * @public @memberof GoProfileGeneration
135 * @version Introduced in firmware 4.2.4.7
136 * @param profile GoProfileGeneration object.
137 * @return The fixed length profile generation circumference limit maximum value.
138 */
139 GoFx(k64f) GoProfileGenerationFixedLength_LengthLimitMax(GoProfileGeneration profile);
140
141 /**
142 * Gets the fixed length profile generation circumference limit minimum value.
143 *
144 * @public @memberof GoProfileGeneration
145 * @version Introduced in firmware 4.2.4.7
146 * @param profile GoProfileGeneration object.
147 * @return The fixed length profile generation circumference limit minimum value.
148 */
149 GoFx(k64f) GoProfileGenerationFixedLength_LengthLimitMin(GoProfileGeneration profile);
150
151 /**
152 * Sets the variable length profile generation maximum length.
153 *
154 * @public @memberof GoProfileGeneration
155 * @version Introduced in firmware 4.2.4.7
156 * @param profile GoProfileGeneration object.
157 * @param length The variable length profile generation maximum length to set.
158 * @return Operation status.
159 */
160 GoFx(kStatus) GoProfileGenerationVariableLength_SetMaxLength(GoProfileGeneration profile, k64f length);
161
162 /**
163 * Gets the variable length profile generation maximum length.
164 *
165 * @public @memberof GoProfileGeneration
166 * @version Introduced in firmware 4.2.4.7
167 * @param profile GoProfileGeneration object.
168 * @return The variable length profile generation maximum length.
169 */
170 GoFx(k64f) GoProfileGenerationVariableLength_MaxLength(GoProfileGeneration profile);
171
172 /**
173 * Gets the variable length profile generation circumference limit maximum value.
174 *
175 * @public @memberof GoProfileGeneration
176 * @version Introduced in firmware 4.2.4.7
177 * @param profile GoProfileGeneration object.
178 * @return The variable length profile generation circumference limit maximum value.
179 */
180 GoFx(k64f) GoProfileGenerationVariableLength_MaxLengthLimitMax(GoProfileGeneration profile);
181
182 /**
183 * Gets the variable length profile generation circumference limit minimum value.
184 *
185 * @public @memberof GoProfileGeneration
186 * @version Introduced in firmware 4.2.4.7
187 * @param profile GoProfileGeneration object.
188 * @return The variable length profile generation circumference limit minimum value.
189 */
190 GoFx(k64f) GoProfileGenerationVariableLength_MaxLengthLimitMin(GoProfileGeneration profile);
191
192 /**
193 * Sets the rotational profile generation profile circumference.
194 *
195 * @public @memberof GoProfileGeneration
196 * @version Introduced in firmware 4.2.4.7
197 * @param profile GoProfileGeneration object.
198 * @param value The rotational profile generation circumference value to set.
199 * @return Operation status.
200 */
201 GoFx(kStatus) GoProfileGenerationRotational_SetCircumference(GoProfileGeneration profile, k64f value);
202
203 /**
204 * Gets the rotational profile generation circumference.
205 *
206 * @public @memberof GoProfileGeneration
207 * @version Introduced in firmware 4.2.4.7
208 * @param profile GoProfileGeneration object.
209 * @return The rotational profile generation circumference.
210 */
211 GoFx(k64f) GoProfileGenerationRotational_Circumference(GoProfileGeneration profile);
212
213 /**
214 * Gets the rotational profile generation circumference limit maximum value.
215 *
216 * @public @memberof GoProfileGeneration
217 * @version Introduced in firmware 4.2.4.7
218 * @param profile GoProfileGeneration object.
219 * @return The rotational profile generation circumference limit maximum value.
220 */
221 GoFx(k64f) GoProfileGenerationRotational_CircumferenceLimitMax(GoProfileGeneration profile);
222
223 /**
224 * Gets the rotational profile generation circumference limit minimum value.
225 *
226 * @public @memberof GoProfileGeneration
227 * @version Introduced in firmware 4.2.4.7
228 * @param profile GoProfileGeneration object.
229 * @return The rotational profile generation circumference limit minimum value.
230 */
231 GoFx(k64f) GoProfileGenerationRotational_CircumferenceLimitMin(GoProfileGeneration profile);
232
233 kEndHeader()
234 #include <GoSdk/GoProfileGeneration.x.h>
235
236 #endif
237
238 /// @endcond
kSize
GoProfileGenerationStartTrigger
Represents a profile generation start trigger.
GoSdkDef.h
Essential SDK declarations.
k32s
GoProfileGenerationType
Represents a profile generation type.
kObject
kStatus
k64f
kBool