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