Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSurfaceGeneration.h
Go to the documentation of this file.
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-2018 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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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 GoPartDetection
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 * Sets the variable length surface generation maximum length.
112 *
113 * @public @memberof GoPartDetection
114 * @version Introduced in firmware 4.0.10.27
115 * @param surface GoSurfaceGeneration object.
116 * @param length The variable length surface generation maximum length to set.
117 * @return Operation status.
118 */
119 GoFx(kStatus) GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length);
120
121 /**
122 * Gets the variable length surface generation maximum length.
123 *
124 * @public @memberof GoPartDetection
125 * @version Introduced in firmware 4.0.10.27
126 * @param surface GoSurfaceGeneration object.
127 * @return The variable length surface generation maximum length.
128 */
129 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface);
130
131 /**
132 * Gets the variable length surface generation circumference limit maximum value.
133 *
134 * @public @memberof GoPartDetection
135 * @version Introduced in firmware 4.0.10.27
136 * @param surface GoSurfaceGeneration object.
137 * @return The variable length surface generation circumference limit maximum value.
138 */
139 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface);
140
141 /**
142 * Gets the variable length surface generation circumference limit minimum value.
143 *
144 * @public @memberof GoPartDetection
145 * @version Introduced in firmware 4.0.10.27
146 * @param surface GoSurfaceGeneration object.
147 * @return The variable length surface generation circumference limit minimum value.
148 */
149 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface);
150
151 /**
152 * @deprecated Sets the rotational surface generation surface circumference.
153 *
154 * @public @memberof GoPartDetection
155 * @version Introduced in firmware 4.0.10.27
156 * @param surface GoSurfaceGeneration object.
157 * @param value The rotational surface generation circumference value to set.
158 * @return Operation status.
159 */
160 GoFx(kStatus) GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value);
161
162 /**
163 * @deprecated Gets the rotational surface generation circumference.
164 *
165 * @public @memberof GoPartDetection
166 * @version Introduced in firmware 4.0.10.27
167 * @param surface GoSurfaceGeneration object.
168 * @return The rotational surface generation circumference.
169 */
170 GoFx(k64f) GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface);
171
172 /**
173 * @deprecated Gets the rotational surface generation circumference limit maximum value.
174 *
175 * @public @memberof GoPartDetection
176 * @version Introduced in firmware 4.0.10.27
177 * @param surface GoSurfaceGeneration object.
178 * @return The rotational surface generation circumference limit maximum value.
179 */
180 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface);
181
182 /**
183 * @deprecated Gets the rotational surface generation circumference limit minimum value.
184 *
185 * @public @memberof GoPartDetection
186 * @version Introduced in firmware 4.0.10.27
187 * @param surface GoSurfaceGeneration object.
188 * @return The rotational surface generation circumference limit minimum value.
189 */
190 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface);
191
192 /**
193 * Sets the rotational surface generation surface encoder resolution.
194 *
195 * @public @memberof GoPartDetection
196 * @version
197 * @param surface GoSurfaceGeneration object.
198 * @param value The rotational surface generation encoder resolution value [ticks/rev] to set.
199 * @return Operation status.
200 */
201 GoFx(kStatus) GoSurfaceGenerationRotational_SetEncoderResolution(GoSurfaceGeneration surface, k64f value);
202
203 /**
204 * Gets the rotational surface generation encoder resolution in ticks/rev.
205 *
206 * @public @memberof GoPartDetection
207 * @version
208 * @param surface GoSurfaceGeneration object.
209 * @return The rotational surface generation encoder resolution.
210 */
211 GoFx(k64f) GoSurfaceGenerationRotational_EncoderResolution(GoSurfaceGeneration surface);
212
213 kEndHeader()
214 #include <GoSdk/GoSurfaceGeneration.x.h>
215
216 #endif
217
218 /// @endcond
GoPartDetection::GoSurfaceGeneration_SetGenerationType
kStatus GoSurfaceGeneration_SetGenerationType(GoSurfaceGeneration surface, GoSurfaceGenerationType type)
Sets the surface generation type.
GoPartDetection::GoSurfaceGenerationRotational_SetEncoderResolution
kStatus GoSurfaceGenerationRotational_SetEncoderResolution(GoSurfaceGeneration surface, k64f value)
Sets the rotational surface generation surface encoder resolution.
GoPartDetection::GoSurfaceGenerationRotational_SetCircumference
kStatus GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value)
GoPartDetection::GoSurfaceGenerationVariableLength_MaxLength
k64f GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface)
Gets the variable length surface generation maximum length.
GoPartDetection::GoSurfaceGenerationRotational_EncoderResolution
k64f GoSurfaceGenerationRotational_EncoderResolution(GoSurfaceGeneration surface)
Gets the rotational surface generation encoder resolution in ticks/rev.
GoSurfaceGenerationStartTrigger
Represents a surface generation start trigger.
GoPartDetection::GoSurfaceGeneration_GenerationType
GoSurfaceGenerationType GoSurfaceGeneration_GenerationType(GoSurfaceGeneration surface)
Gets the current surface generation type.
GoPartDetection::GoSurfaceGenerationVariableLength_MaxLengthLimitMin
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit minimum value.
GoPartDetection::GoSurfaceGenerationRotational_CircumferenceLimitMin
k64f GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface)
GoPartDetection::GoSurfaceGenerationRotational_CircumferenceLimitMax
k64f GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface)
GoPartDetection::GoSurfaceGenerationFixedLength_Length
k64f GoSurfaceGenerationFixedLength_Length(GoSurfaceGeneration surface)
Gets the fixed length surface generation surface length.
GoSurfaceGenerationType
Represents a surface generation type.
GoSurfaceGeneration
Represents a surface generation configuration.
GoPartDetection::GoSurfaceGenerationFixedLength_SetStartTrigger
kStatus GoSurfaceGenerationFixedLength_SetStartTrigger(GoSurfaceGeneration surface, GoSurfaceGenerationStartTrigger trigger)
Sets the fixed length surface generation start trigger.
GoSdkDef.h
Essential SDK declarations.
GoPartDetection::GoSurfaceGenerationFixedLength_LengthLimitMax
k64f GoSurfaceGenerationFixedLength_LengthLimitMax(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit maximum value.
GoPartDetection::GoSurfaceGenerationVariableLength_MaxLengthLimitMax
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit maximum value.
GoPartDetection::GoSurfaceGenerationRotational_Circumference
k64f GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface)
GoPartDetection::GoSurfaceGenerationVariableLength_SetMaxLength
kStatus GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length)
Sets the variable length surface generation maximum length.
kObject
kStatus
GoPartDetection::GoSurfaceGenerationFixedLength_SetLength
kStatus GoSurfaceGenerationFixedLength_SetLength(GoSurfaceGeneration surface, k64f length)
Sets the fixed length surface generation surface length.
GoPartDetection::GoSurfaceGenerationFixedLength_LengthLimitMin
k64f GoSurfaceGenerationFixedLength_LengthLimitMin(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit minimum value.
GoPartDetection::GoSurfaceGenerationFixedLength_StartTrigger
GoSurfaceGenerationStartTrigger GoSurfaceGenerationFixedLength_StartTrigger(GoSurfaceGeneration surface)
Gets the fixed length surface generation start trigger.
k64f