Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups 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) 2014 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 * @param surface GoSurfaceGeneration object.
32 * @param type The surface generation type to set.
33 * @return Operation status.
34 */
35 GoFx(kStatus) GoSurfaceGeneration_SetGenerationType(GoSurfaceGeneration surface, GoSurfaceGenerationType type);
36
37 /**
38 * Gets the current surface generation type.
39 *
40 * @public @memberof GoPartDetection
41 * @param surface GoSurfaceGeneration object.
42 * @return The surface generation type.
43 */
44 GoFx(GoSurfaceGenerationType) GoSurfaceGeneration_GenerationType(GoSurfaceGeneration surface);
45
46 /**
47 * Sets the fixed length surface generation start trigger.
48 *
49 * @public @memberof GoPartDetection
50 * @param surface GoSurfaceGeneration object.
51 * @param trigger The surface generation start trigger value to set.
52 * @return Operation status.
53 */
54 GoFx(kStatus) GoSurfaceGenerationFixedLength_SetStartTrigger(GoSurfaceGeneration surface, GoSurfaceGenerationStartTrigger trigger);
55
56 /**
57 * Gets the fixed length surface generation start trigger.
58 *
59 * @public @memberof GoPartDetection
60 * @param surface GoSurfaceGeneration object.
61 * @return The fixed length surface generation start trigger.
62 */
63 GoFx(GoSurfaceGenerationStartTrigger) GoSurfaceGenerationFixedLength_StartTrigger(GoSurfaceGeneration surface);
64
65 /**
66 * Sets the fixed length surface generation surface length.
67 *
68 * @public @memberof GoPartDetection
69 * @param surface GoSurfaceGeneration object.
70 * @param length The fixed length surface generation surface length to set.
71 * @return Operation status.
72 */
73 GoFx(kStatus) GoSurfaceGenerationFixedLength_SetLength(GoSurfaceGeneration surface, k64f length);
74
75 /**
76 * Gets the fixed length surface generation surface length.
77 *
78 * @public @memberof GoPartDetection
79 * @param surface GoSurfaceGeneration object.
80 * @return The fixed length surface generation surface length.
81 */
82 GoFx(k64f) GoSurfaceGenerationFixedLength_Length(GoSurfaceGeneration surface);
83
84 /**
85 * Gets the fixed length surface generation circumference limit maximum value.
86 *
87 * @public @memberof GoPartDetection
88 * @param surface GoSurfaceGeneration object.
89 * @return The fixed length surface generation circumference limit maximum value.
90 */
91 GoFx(k64f) GoSurfaceGenerationFixedLength_LengthLimitMax(GoSurfaceGeneration surface);
92
93 /**
94 * Gets the fixed length surface generation circumference limit minimum value.
95 *
96 * @public @memberof GoPartDetection
97 * @param surface GoSurfaceGeneration object.
98 * @return The fixed length surface generation circumference limit minimum value.
99 */
100 GoFx(k64f) GoSurfaceGenerationFixedLength_LengthLimitMin(GoSurfaceGeneration surface);
101
102 /**
103 * Sets the variable length surface generation maximum length.
104 *
105 * @public @memberof GoPartDetection
106 * @param surface GoSurfaceGeneration object.
107 * @param length The variable length surface generation maximum length to set.
108 * @return Operation status.
109 */
110 GoFx(kStatus) GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length);
111
112 /**
113 * Gets the variable length surface generation maximum length.
114 *
115 * @public @memberof GoPartDetection
116 * @param surface GoSurfaceGeneration object.
117 * @return The variable length surface generation maximum length.
118 */
119 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface);
120
121 /**
122 * Gets the variable length surface generation circumference limit maximum value.
123 *
124 * @public @memberof GoPartDetection
125 * @param surface GoSurfaceGeneration object.
126 * @return The variable length surface generation circumference limit maximum value.
127 */
128 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface);
129
130 /**
131 * Gets the variable length surface generation circumference limit minimum value.
132 *
133 * @public @memberof GoPartDetection
134 * @param surface GoSurfaceGeneration object.
135 * @return The variable length surface generation circumference limit minimum value.
136 */
137 GoFx(k64f) GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface);
138
139 /**
140 * Sets the rotational surface generation surface circumference.
141 *
142 * @public @memberof GoPartDetection
143 * @param surface GoSurfaceGeneration object.
144 * @param value The rotational surface generation circumference value to set.
145 * @return Operation status.
146 */
147 GoFx(kStatus) GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value);
148
149 /**
150 * Gets the rotational surface generation circumference.
151 *
152 * @public @memberof GoPartDetection
153 * @param surface GoSurfaceGeneration object.
154 * @return The rotational surface generation circumference.
155 */
156 GoFx(k64f) GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface);
157
158 /**
159 * Gets the rotational surface generation circumference limit maximum value.
160 *
161 * @public @memberof GoPartDetection
162 * @param surface GoSurfaceGeneration object.
163 * @return The rotational surface generation circumference limit maximum value.
164 */
165 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface);
166
167 /**
168 * Gets the rotational surface generation circumference limit minimum value.
169 *
170 * @public @memberof GoPartDetection
171 * @param surface GoSurfaceGeneration object.
172 * @return The rotational surface generation circumference limit minimum value.
173 */
174 GoFx(k64f) GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface);
175
176 kEndHeader()
177 #include <GoSdk/GoSurfaceGeneration.x.h>
178
179 #endif
180
181 /// @endcond
GoPartDetection::GoSurfaceGenerationFixedLength_LengthLimitMax
k64f GoSurfaceGenerationFixedLength_LengthLimitMax(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit maximum value.
GoPartDetection::GoSurfaceGenerationFixedLength_StartTrigger
GoSurfaceGenerationStartTrigger GoSurfaceGenerationFixedLength_StartTrigger(GoSurfaceGeneration surface)
Gets the fixed length surface generation start trigger.
GoPartDetection::GoSurfaceGeneration_GenerationType
GoSurfaceGenerationType GoSurfaceGeneration_GenerationType(GoSurfaceGeneration surface)
Gets the current surface generation type.
GoSurfaceGenerationStartTrigger
Represents a surface generation start trigger.
GoPartDetection::GoSurfaceGenerationVariableLength_MaxLengthLimitMax
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMax(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit maximum value.
GoSurfaceGenerationType
Represents a surface generation type.
GoSurfaceGeneration
Represents a surface generation configuration.
Definition: GoSurfaceGeneration.h:17
GoSdkDef.h
Essential SDK declarations.
GoPartDetection::GoSurfaceGenerationRotational_CircumferenceLimitMin
k64f GoSurfaceGenerationRotational_CircumferenceLimitMin(GoSurfaceGeneration surface)
Gets the rotational surface generation circumference limit minimum value.
GoPartDetection::GoSurfaceGenerationFixedLength_Length
k64f GoSurfaceGenerationFixedLength_Length(GoSurfaceGeneration surface)
Gets the fixed length surface generation surface length.
GoPartDetection::GoSurfaceGeneration_SetGenerationType
kStatus GoSurfaceGeneration_SetGenerationType(GoSurfaceGeneration surface, GoSurfaceGenerationType type)
Sets the surface generation type.
GoPartDetection::GoSurfaceGenerationFixedLength_LengthLimitMin
k64f GoSurfaceGenerationFixedLength_LengthLimitMin(GoSurfaceGeneration surface)
Gets the fixed length surface generation circumference limit minimum value.
GoPartDetection::GoSurfaceGenerationRotational_Circumference
k64f GoSurfaceGenerationRotational_Circumference(GoSurfaceGeneration surface)
Gets the rotational surface generation circumference.
GoPartDetection::GoSurfaceGenerationFixedLength_SetLength
kStatus GoSurfaceGenerationFixedLength_SetLength(GoSurfaceGeneration surface, k64f length)
Sets the fixed length surface generation surface length.
GoPartDetection::GoSurfaceGenerationRotational_CircumferenceLimitMax
k64f GoSurfaceGenerationRotational_CircumferenceLimitMax(GoSurfaceGeneration surface)
Gets the rotational surface generation circumference limit maximum value.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoPartDetection::GoSurfaceGenerationVariableLength_MaxLength
k64f GoSurfaceGenerationVariableLength_MaxLength(GoSurfaceGeneration surface)
Gets the variable length surface generation maximum length.
GoPartDetection::GoSurfaceGenerationFixedLength_SetStartTrigger
kStatus GoSurfaceGenerationFixedLength_SetStartTrigger(GoSurfaceGeneration surface, GoSurfaceGenerationStartTrigger trigger)
Sets the fixed length surface generation start trigger.
GoPartDetection::GoSurfaceGenerationRotational_SetCircumference
kStatus GoSurfaceGenerationRotational_SetCircumference(GoSurfaceGeneration surface, k64f value)
Sets the rotational surface generation surface circumference.
GoPartDetection::GoSurfaceGenerationVariableLength_SetMaxLength
kStatus GoSurfaceGenerationVariableLength_SetMaxLength(GoSurfaceGeneration surface, k64f length)
Sets the variable length surface generation maximum length.
GoPartDetection::GoSurfaceGenerationVariableLength_MaxLengthLimitMin
k64f GoSurfaceGenerationVariableLength_MaxLengthLimitMin(GoSurfaceGeneration surface)
Gets the variable length surface generation circumference limit minimum value.