Gocator API

GoTransform.h
Go to the documentation of this file.
1 /**
2 * @file GoTransform.h
3 * @brief Declares the GoTransform class.
4 *
5 * @internal
6 * Copyright (C) 2016-2020 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_TRANSFORM_H
11 #define GO_TRANSFORM_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 kBeginHeader()
16
17 /**
18 * @class GoTransform
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents a sensor transformation.
22 */
23 typedef kObject GoTransform;
24
25 /**
26 * Gets the encoder resolution.
27 *
28 * @public @memberof GoTransform
29 * @version Introduced in firmware 4.0.10.27
30 * @param transform GoTransform object.
31 * @return The encoder resolution in mm/tick.
32 */
33 GoFx(k64f) GoTransform_EncoderResolution(GoTransform transform);
34
35 /**
36 * Sets the encoder resolution.
37 *
38 * @public @memberof GoTransform
39 * @version Introduced in firmware 4.0.10.27
40 * @param transform GoTransform object.
41 * @param value Encoder resolution in mm/tick.
42 * @return Operation status.
43 */
44 GoFx(kStatus) GoTransform_SetEncoderResolution(GoTransform transform, k64f value);
45
46 /**
47 * Gets the travel speed.
48 *
49 * @public @memberof GoTransform
50 * @version Introduced in firmware 4.0.10.27
51 * @param transform GoTransform object.
52 * @return The travel speed in mm/sec.
53 */
54 GoFx(k64f) GoTransform_Speed(GoTransform transform);
55
56 /**
57 * Sets the travel speed.
58 *
59 * @public @memberof GoTransform
60 * @version Introduced in firmware 4.0.10.27
61 * @param transform GoTransform object.
62 * @param value travel speed in mm/sec.
63 * @return Operation status.
64 */
65 GoFx(kStatus) GoTransform_SetSpeed(GoTransform transform, k64f value);
66
67 /**
68 * Gets the X component of the transformation.
69 *
70 * @public @memberof GoTransform
71 * @version Introduced in firmware 4.0.10.27
72 * @param transform GoTransform object.
73 * @param role The sensor role transformation to retrieve the value from.
74 * @return The transformation X component.
75 */
76 GoFx(k64f) GoTransform_X(GoTransform transform, GoRole role);
77
78 /**
79 * Sets the transformation X component.
80 *
81 * @public @memberof GoTransform
82 * @version Introduced in firmware 4.0.10.27
83 * @param transform GoTransform object.
84 * @param role The sensor role transformation entry to update.
85 * @param offset The transformation X component to set.
86 * @return Operation status.
87 */
88 GoFx(kStatus) GoTransform_SetX(GoTransform transform, GoRole role, k64f offset);
89
90 /**
91 * Gets the Y component of the transformation.
92 *
93 * @public @memberof GoTransform
94 * @version Introduced in firmware 4.0.10.27
95 * @param transform GoTransform object.
96 * @param role The sensor role transformation to retrieve the value from.
97 * @return The transformation Y component.
98 */
99 GoFx(k64f) GoTransform_Y(GoTransform transform, GoRole role);
100
101 /**
102 * Sets the transformation Y component.
103 *
104 * @public @memberof GoTransform
105 * @version Introduced in firmware 4.0.10.27
106 * @param transform GoTransform object.
107 * @param role The sensor role transformation entry to update.
108 * @param offset The transformation Y component to set.
109 * @return Operation status.
110 */
111 GoFx(kStatus) GoTransform_SetY(GoTransform transform, GoRole role, k64f offset);
112
113 /**
114 * Gets the Z component of the transformation.
115 *
116 * @public @memberof GoTransform
117 * @version Introduced in firmware 4.0.10.27
118 * @param transform GoTransform object.
119 * @param role The sensor role transformation to retrieve the value from.
120 * @return The transformation Z component.
121 */
122 GoFx(k64f) GoTransform_Z(GoTransform transform, GoRole role);
123
124 /**
125 * Sets the transformation Z component.
126 *
127 * @public @memberof GoTransform
128 * @version Introduced in firmware 4.0.10.27
129 * @param transform GoTransform object.
130 * @param role The sensor role transformation entry to update.
131 * @param offset The transformation Z component to set.
132 * @return Operation status.
133 */
134 GoFx(kStatus) GoTransform_SetZ(GoTransform transform, GoRole role, k64f offset);
135
136 /**
137 * Gets the X-angle of the transformation.
138 *
139 * @public @memberof GoTransform
140 * @version Introduced in firmware 4.0.10.27
141 * @param transform GoTransform object.
142 * @param role The sensor role transformation to retrieve the value from.
143 * @return The transformation X-angle in degrees
144 */
145 GoFx(k64f) GoTransform_XAngle(GoTransform transform, GoRole role);
146
147 /**
148 * Sets the transformation X-angle.
149 *
150 * @public @memberof GoTransform
151 * @version Introduced in firmware 4.0.10.27
152 * @param transform GoTransform object.
153 * @param role The sensor role transformation entry to update.
154 * @param offset The transformation X-angle to set in degrees
155 * @return Operation status.
156 */
157 GoFx(kStatus) GoTransform_SetXAngle(GoTransform transform, GoRole role, k64f offset);
158
159 /**
160 * Gets the Y-angle of the transformation.
161 *
162 * @public @memberof GoTransform
163 * @version Introduced in firmware 4.0.10.27
164 * @param transform GoTransform object.
165 * @param role The sensor role transformation to retrieve the value from.
166 * @return The transformation Y-angle component in degrees
167 */
168 GoFx(k64f) GoTransform_YAngle(GoTransform transform, GoRole role);
169
170 /**
171 * Sets the transformation Y-angle.
172 *
173 * @public @memberof GoTransform
174 * @version Introduced in firmware 4.0.10.27
175 * @param transform GoTransform object.
176 * @param role The sensor role transformation entry to update.
177 * @param offset The transformation Y-angle to set in degrees
178 * @return Operation status.
179 */
180 GoFx(kStatus) GoTransform_SetYAngle(GoTransform transform, GoRole role, k64f offset);
181
182 /**
183 * Gets the Z-angle of the transformation.
184 *
185 * @public @memberof GoTransform
186 * @version Introduced in firmware 4.0.10.27
187 * @param transform GoTransform object.
188 * @param role The sensor role transformation to retrieve the value from.
189 * @return The transformation Z-angle component in degrees
190 */
191 GoFx(k64f) GoTransform_ZAngle(GoTransform transform, GoRole role);
192
193 /**
194 * Sets the transformation Z-angle.
195 *
196 * @public @memberof GoTransform
197 * @version Introduced in firmware 4.0.10.27
198 * @param transform GoTransform object.
199 * @param role The sensor role transformation entry to update.
200 * @param offset The transformation Z-angle to set in degrees
201 * @return Operation status.
202 */
203 GoFx(kStatus) GoTransform_SetZAngle(GoTransform transform, GoRole role, k64f offset);
204
205
206 kEndHeader()
207 #include <GoSdk/GoTransform.x.h>
208
209 #endif
GoTransform::GoTransform_SetZAngle
kStatus GoTransform_SetZAngle(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Z-angle.
GoTransform::GoTransform_Y
k64f GoTransform_Y(GoTransform transform, GoRole role)
Gets the Y component of the transformation.
GoTransform::GoTransform_SetYAngle
kStatus GoTransform_SetYAngle(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Y-angle.
GoTransform::GoTransform_SetSpeed
kStatus GoTransform_SetSpeed(GoTransform transform, k64f value)
Sets the travel speed.
GoTransform::GoTransform_ZAngle
k64f GoTransform_ZAngle(GoTransform transform, GoRole role)
Gets the Z-angle of the transformation.
GoRole
Represents a user role.
GoTransform::GoTransform_YAngle
k64f GoTransform_YAngle(GoTransform transform, GoRole role)
Gets the Y-angle of the transformation.
GoSdkDef.h
Essential SDK declarations.
GoTransform::GoTransform_Z
k64f GoTransform_Z(GoTransform transform, GoRole role)
Gets the Z component of the transformation.
GoTransform::GoTransform_EncoderResolution
k64f GoTransform_EncoderResolution(GoTransform transform)
Gets the encoder resolution.
GoTransform::GoTransform_SetZ
kStatus GoTransform_SetZ(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Z component.
kObject
kStatus
GoTransform
Represents a sensor transformation.
k64f
GoTransform::GoTransform_SetX
kStatus GoTransform_SetX(GoTransform transform, GoRole role, k64f offset)
Sets the transformation X component.
GoTransform::GoTransform_SetEncoderResolution
kStatus GoTransform_SetEncoderResolution(GoTransform transform, k64f value)
Sets the encoder resolution.
GoTransform::GoTransform_SetY
kStatus GoTransform_SetY(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Y component.
GoTransform::GoTransform_X
k64f GoTransform_X(GoTransform transform, GoRole role)
Gets the X component of the transformation.
GoTransform::GoTransform_Speed
k64f GoTransform_Speed(GoTransform transform)
Gets the travel speed.
GoTransform::GoTransform_SetXAngle
kStatus GoTransform_SetXAngle(GoTransform transform, GoRole role, k64f offset)
Sets the transformation X-angle.
GoTransform::GoTransform_XAngle
k64f GoTransform_XAngle(GoTransform transform, GoRole role)
Gets the X-angle of the transformation.