Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoProfileGeneration.h
1 /// @cond (Gocator_1x00)
2 
3 /**
4  * @file GoProfileGeneration.h
5  * @brief Declares the GoProfileGeneration class.
6  *
7  * @internal
8  * Copyright (C) 2015 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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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  * Sets the fixed length profile generation profile length.
71  *
72  * @public @memberof GoPartDetection
73  * @version Introduced in firmware 4.2.4.7
74  * @param profile GoProfileGeneration object.
75  * @param length The fixed length profile generation profile length to set.
76  * @return Operation status.
77  */
78 GoFx(kStatus) GoProfileGenerationFixedLength_SetLength(GoProfileGeneration profile, k64f length);
79 
80 /**
81  * Gets the fixed length profile generation profile length.
82  *
83  * @public @memberof GoPartDetection
84  * @version Introduced in firmware 4.2.4.7
85  * @param profile GoProfileGeneration object.
86  * @return The fixed length profile generation profile length.
87  */
88 GoFx(k64f) GoProfileGenerationFixedLength_Length(GoProfileGeneration profile);
89 
90 /**
91  * Gets the fixed length profile generation circumference limit maximum value.
92  *
93  * @public @memberof GoPartDetection
94  * @version Introduced in firmware 4.2.4.7
95  * @param profile GoProfileGeneration object.
96  * @return The fixed length profile generation circumference limit maximum value.
97  */
98 GoFx(k64f) GoProfileGenerationFixedLength_LengthLimitMax(GoProfileGeneration profile);
99 
100 /**
101  * Gets the fixed length profile generation circumference limit minimum value.
102  *
103  * @public @memberof GoPartDetection
104  * @version Introduced in firmware 4.2.4.7
105  * @param profile GoProfileGeneration object.
106  * @return The fixed length profile generation circumference limit minimum value.
107  */
108 GoFx(k64f) GoProfileGenerationFixedLength_LengthLimitMin(GoProfileGeneration profile);
109 
110 /**
111  * Sets the variable length profile generation maximum length.
112  *
113  * @public @memberof GoPartDetection
114  * @version Introduced in firmware 4.2.4.7
115  * @param profile GoProfileGeneration object.
116  * @param length The variable length profile generation maximum length to set.
117  * @return Operation status.
118  */
119 GoFx(kStatus) GoProfileGenerationVariableLength_SetMaxLength(GoProfileGeneration profile, k64f length);
120 
121 /**
122  * Gets the variable length profile generation maximum length.
123  *
124  * @public @memberof GoPartDetection
125  * @version Introduced in firmware 4.2.4.7
126  * @param profile GoProfileGeneration object.
127  * @return The variable length profile generation maximum length.
128  */
129 GoFx(k64f) GoProfileGenerationVariableLength_MaxLength(GoProfileGeneration profile);
130 
131 /**
132  * Gets the variable length profile generation circumference limit maximum value.
133  *
134  * @public @memberof GoPartDetection
135  * @version Introduced in firmware 4.2.4.7
136  * @param profile GoProfileGeneration object.
137  * @return The variable length profile generation circumference limit maximum value.
138  */
139 GoFx(k64f) GoProfileGenerationVariableLength_MaxLengthLimitMax(GoProfileGeneration profile);
140 
141 /**
142  * Gets the variable length profile generation circumference limit minimum value.
143  *
144  * @public @memberof GoPartDetection
145  * @version Introduced in firmware 4.2.4.7
146  * @param profile GoProfileGeneration object.
147  * @return The variable length profile generation circumference limit minimum value.
148  */
149 GoFx(k64f) GoProfileGenerationVariableLength_MaxLengthLimitMin(GoProfileGeneration profile);
150 
151 /**
152  * Sets the rotational profile generation profile circumference.
153  *
154  * @public @memberof GoPartDetection
155  * @version Introduced in firmware 4.2.4.7
156  * @param profile GoProfileGeneration object.
157  * @param value The rotational profile generation circumference value to set.
158  * @return Operation status.
159  */
160 GoFx(kStatus) GoProfileGenerationRotational_SetCircumference(GoProfileGeneration profile, k64f value);
161 
162 /**
163  * Gets the rotational profile generation circumference.
164  *
165  * @public @memberof GoPartDetection
166  * @version Introduced in firmware 4.2.4.7
167  * @param profile GoProfileGeneration object.
168  * @return The rotational profile generation circumference.
169  */
170 GoFx(k64f) GoProfileGenerationRotational_Circumference(GoProfileGeneration profile);
171 
172 /**
173  * Gets the rotational profile generation circumference limit maximum value.
174  *
175  * @public @memberof GoPartDetection
176  * @version Introduced in firmware 4.2.4.7
177  * @param profile GoProfileGeneration object.
178  * @return The rotational profile generation circumference limit maximum value.
179  */
180 GoFx(k64f) GoProfileGenerationRotational_CircumferenceLimitMax(GoProfileGeneration profile);
181 
182 /**
183  * Gets the rotational profile generation circumference limit minimum value.
184  *
185  * @public @memberof GoPartDetection
186  * @version Introduced in firmware 4.2.4.7
187  * @param profile GoProfileGeneration object.
188  * @return The rotational profile generation circumference limit minimum value.
189  */
190 GoFx(k64f) GoProfileGenerationRotational_CircumferenceLimitMin(GoProfileGeneration profile);
191 
192 kEndHeader()
193 #include <GoSdk/GoProfileGeneration.x.h>
194 
195 #endif
196 
197 /// @endcond
GoSdkDef.h
Essential SDK declarations.