Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoMeasurement.h
Go to the documentation of this file.
1 /**
2 * @file GoMeasurement.h
3 * @brief Declares the GoMeasurement class.
4 *
5 * @internal
6 * Copyright (C) 2016-2022 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_MEASUREMENT_H
11 #define GO_MEASUREMENT_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 /**
16 * @class GoMeasurement
17 * @extends kObject
18 * @ingroup GoSdk
19 * @brief Represents the base class for a tool measurement or script output.
20 */
21 typedef kObject GoMeasurement;
22
23
24 /**
25 * Returns whether or not the given measurement has a valid ID assigned to it.
26 *
27 * @public @memberof GoMeasurement
28 * @version Introduced in firmware 4.0.10.27
29 * @param measurement GoMeasurement object.
30 * @return kTRUE if there is an ID; kFALSE otherwise.
31 */
32 GoFx(kBool) GoMeasurement_HasId(GoMeasurement measurement);
33
34 /**
35 * Clears the assigned ID for the given measurement.
36 *
37 * @public @memberof GoMeasurement
38 * @version Introduced in firmware 4.0.10.27
39 * @param measurement GoMeasurement object.
40 * @return Operation status.
41 */
42 GoFx(kStatus) GoMeasurement_ClearId(GoMeasurement measurement);
43
44 /**
45 * Sets an ID number for the given measurement.
46 *
47 * @public @memberof GoMeasurement
48 * @version Introduced in firmware 4.0.10.27
49 * @param measurement GoMeasurement object.
50 * @param id The ID value to set for the measurement.
51 * @return Operation status.
52 */
53 GoFx(kStatus) GoMeasurement_SetId(GoMeasurement measurement, k32u id);
54
55 /**
56 * Gets the ID for the given measurement.
57 *
58 * @public @memberof GoMeasurement
59 * @version Introduced in firmware 4.0.10.27
60 * @param measurement GoMeasurement object.
61 * @return The ID value if there is one assigned. Otherwise, -1 is returned.
62 */
63 GoFx(k32s) GoMeasurement_Id(GoMeasurement measurement);
64
65 /**
66 * Gets the name for the given measurement.
67 *
68 * @public @memberof GoMeasurement
69 * @version Introduced in firmware 4.0.10.27
70 * @param measurement GoMeasurement object.
71 * @return A character array pointer for the measurement name.
72 */
73 GoFx(const kChar*) GoMeasurement_Name(GoMeasurement measurement);
74
75 /**
76 * Sets the name for the given measurement.
77 *
78 * @public @memberof GoMeasurement
79 * @version Introduced in firmware 4.0.10.27
80 * @param measurement GoMeasurement object.
81 * @param name The name to assign to the measurement.
82 * @return Operation status.
83 */
84 GoFx(kStatus) GoMeasurement_SetName(GoMeasurement measurement, const kChar* name);
85
86 /**
87 * Returns the source tool of the given measurement.
88 *
89 * @public @memberof GoMeasurement
90 * @version Introduced in firmware 4.0.10.27
91 * @param measurement GoMeasurement object.
92 * @return A pointer to the source tool for the measurement.
93 */
94 GoFx(kObject) GoMeasurement_SourceTool(GoMeasurement measurement);
95
96 /**
97 * Enables the given measurement for output.
98 *
99 * @public @memberof GoMeasurement
100 * @version Introduced in firmware 4.0.10.27
101 * @param measurement GoMeasurement object.
102 * @param enable Set to kTRUE to enable the measurement, kFALSE to disable it.
103 * @return Operation status.
104 */
105 GoFx(kStatus) GoMeasurement_Enable(GoMeasurement measurement, kBool enable);
106
107 /**
108 * Returns a boolean value representing whether the given measurement is enabled.
109 *
110 * @public @memberof GoMeasurement
111 * @version Introduced in firmware 4.0.10.27
112 * @param measurement GoMeasurement object.
113 * @return kTRUE if enabled; kFALSE otherwise.
114 */
115 GoFx(kBool) GoMeasurement_Enabled(GoMeasurement measurement);
116
117 /**
118 * Sets the minimum decision value for the given measurement.
119 *
120 * @public @memberof GoMeasurement
121 * @version Introduced in firmware 4.0.10.27
122 * @param measurement GoMeasurement object.
123 * @param min The minimum decision value to set.
124 * @return Operation status.
125 */
126 GoFx(kStatus) GoMeasurement_SetDecisionMin(GoMeasurement measurement, k64f min);
127
128 /**
129 * Gets the minimum decision value for the given measurement.
130 *
131 * @public @memberof GoMeasurement
132 * @version Introduced in firmware 4.0.10.27
133 * @param measurement GoMeasurement object.
134 * @return The minimum decision value.
135 */
136 GoFx(k64f) GoMeasurement_DecisionMin(GoMeasurement measurement);
137
138 /**
139 * Sets the maximum decision value for the given measurement.
140 *
141 * @public @memberof GoMeasurement
142 * @version Introduced in firmware 4.0.10.27
143 * @param measurement GoMeasurement object.
144 * @param max The maximum decision value to set.
145 * @return Operation status.
146 */
147 GoFx(kStatus) GoMeasurement_SetDecisionMax(GoMeasurement measurement, k64f max);
148
149 /**
150 * Gets the maximum decision value for the given measurement.
151 *
152 * @public @memberof GoMeasurement
153 * @version Introduced in firmware 4.0.10.27
154 * @param measurement GoMeasurement object.
155 * @return The maximum decision value.
156 */
157 GoFx(k64f) GoMeasurement_DecisionMax(GoMeasurement measurement);
158
159 /**
160 * Sets measurement value hold for the given measurement.
161 *
162 * @public @memberof GoMeasurement
163 * @version Introduced in firmware 4.0.10.27
164 * @param measurement GoMeasurement object.
165 * @param enable kTRUE to enable measurement value hold, kFALSE to disable it.
166 * @return Operation status.
167 */
168 GoFx(kStatus) GoMeasurement_EnableHold(GoMeasurement measurement, kBool enable);
169
170 /**
171 * Returns a boolean value representing the current state of measurement value hold.
172 *
173 * @public @memberof GoMeasurement
174 * @version Introduced in firmware 4.0.10.27
175 * @param measurement GoMeasurement object.
176 * @return kTRUE if enabled and kFALSE if disabled.
177 */
178 GoFx(kBool) GoMeasurement_HoldEnabled(GoMeasurement measurement);
179
180 /**
181 * Sets measurement value smoothing for the given measurement.
182 *
183 * @public @memberof GoMeasurement
184 * @version Introduced in firmware 4.0.10.27
185 * @param measurement GoMeasurement object.
186 * @param enable kTRUE to enable measurement value smoothing, kFALSE to disable it.
187 * @return Operation status.
188 */
189 GoFx(kStatus) GoMeasurement_EnableSmoothing(GoMeasurement measurement, kBool enable);
190
191 /**
192 * Returns a boolean value representing the current state of measurement value smoothing.
193 *
194 * @public @memberof GoMeasurement
195 * @version Introduced in firmware 4.0.10.27
196 * @param measurement GoMeasurement object.
197 * @return kTRUE if enabled and kFALSE if disabled.
198 */
199 GoFx(kBool) GoMeasurement_SmoothingEnabled(GoMeasurement measurement);
200
201 /**
202 * Sets the measurement value smoothing window for the given measurement.
203 *
204 * @public @memberof GoMeasurement
205 * @version Introduced in firmware 4.0.10.27
206 * @param measurement GoMeasurement object.
207 * @param value The intended size of the smoothing window.
208 * @return Operation status.
209 */
210 GoFx(kStatus) GoMeasurement_SetSmoothingWindow(GoMeasurement measurement, k64s value);
211
212 /**
213 * Gets Preserve invalid smoothign enable state.
214 *
215 * @public @memberof GoMeasurement
216 * @version Introduced in firmware 4.8.2.76
217 * @param measurement GoMeasurement object.
218 * @return Preserve enable state.
219 */
220 GoFx(kBool) GoMeasurement_XSmoothingPreserveInvalidEnabled(GoMeasurement measurement);
221
222 /**
223 * Preserve invalid smoothign values.
224 *
225 * @public @memberof GoMeasurement
226 * @version Introduced in firmware 4.8.2.76
227 * @param measurement GoMeasurement object.
228 * @param enable enable state.
229 * @return Operation status
230 */
231 GoFx(kStatus) GoMeasurement_SetXSmoothingPreserveInvalidEnabled(GoMeasurement measurement, kBool enable);
232
233
234 /**
235 * Returns the current measurement value smoothing window size.
236 *
237 * @public @memberof GoMeasurement
238 * @version Introduced in firmware 4.0.10.27
239 * @param measurement GoMeasurement object.
240 * @return Smoothing window size.
241 */
242 GoFx(k64s) GoMeasurement_SmoothingWindow(GoMeasurement measurement);
243
244 /**
245 * Sets the measurement value scaling for the given measurement.
246 *
247 * @public @memberof GoMeasurement
248 * @version Introduced in firmware 4.0.10.27
249 * @param measurement GoMeasurement object.
250 * @param value The intended measurement value scaling factor.
251 * @return Operation status.
252 */
253 GoFx(kStatus) GoMeasurement_SetScale(GoMeasurement measurement, k64f value);
254
255 /**
256 * Returns the current measurement value scaling factor.
257 *
258 * @public @memberof GoMeasurement
259 * @version Introduced in firmware 4.0.10.27
260 * @param measurement GoMeasurement object.
261 * @return The measurement value scaling factor.
262 */
263 GoFx(k64f) GoMeasurement_Scale(GoMeasurement measurement);
264
265 /**
266 * Sets the measurement value offset for the given measurement.
267 *
268 * @public @memberof GoMeasurement
269 * @version Introduced in firmware 4.0.10.27
270 * @param measurement GoMeasurement object.
271 * @param value The measurement offset to set.
272 * @return Operation status.
273 */
274 GoFx(kStatus) GoMeasurement_SetOffset(GoMeasurement measurement, k64f value);
275
276 /**
277 * Returns the measurement value offset.
278 *
279 * @public @memberof GoMeasurement
280 * @version Introduced in firmware 4.0.10.27
281 * @param measurement GoMeasurement object.
282 * @return Measurement value offset.
283 */
284 GoFx(k64f) GoMeasurement_Offset(GoMeasurement measurement);
285
286 /**
287 * Gets the measurement type for the given measurement.
288 *
289 * @public @memberof GoMeasurement
290 * @version Introduced in firmware 4.0.10.27
291 * @param measurement GoMeasurement object.
292 * @return The measurement value type enumerator value.
293 */
294 GoFx(GoMeasurementType) GoMeasurement_Type(GoMeasurement measurement);
295
296 #include <GoSdk/Tools/GoMeasurement.x.h>
297
298 #endif
GoMeasurement::GoMeasurement_Enable
kStatus GoMeasurement_Enable(GoMeasurement measurement, kBool enable)
Enables the given measurement for output.
k32u
GoMeasurement::GoMeasurement_EnableHold
kStatus GoMeasurement_EnableHold(GoMeasurement measurement, kBool enable)
Sets measurement value hold for the given measurement.
GoMeasurement
Represents the base class for a tool measurement or script output.
GoMeasurement::GoMeasurement_Enabled
kBool GoMeasurement_Enabled(GoMeasurement measurement)
Returns a boolean value representing whether the given measurement is enabled.
GoMeasurement::GoMeasurement_SetXSmoothingPreserveInvalidEnabled
kStatus GoMeasurement_SetXSmoothingPreserveInvalidEnabled(GoMeasurement measurement, kBool enable)
Preserve invalid smoothign values.
GoMeasurement::GoMeasurement_Name
const kChar * GoMeasurement_Name(GoMeasurement measurement)
Gets the name for the given measurement.
GoMeasurement::GoMeasurement_HoldEnabled
kBool GoMeasurement_HoldEnabled(GoMeasurement measurement)
Returns a boolean value representing the current state of measurement value hold. ...
GoMeasurement::GoMeasurement_SetScale
kStatus GoMeasurement_SetScale(GoMeasurement measurement, k64f value)
Sets the measurement value scaling for the given measurement.
GoMeasurement::GoMeasurement_SmoothingWindow
k64s GoMeasurement_SmoothingWindow(GoMeasurement measurement)
Returns the current measurement value smoothing window size.
GoMeasurementType
Lists all measurement types.
GoMeasurement::GoMeasurement_SetSmoothingWindow
kStatus GoMeasurement_SetSmoothingWindow(GoMeasurement measurement, k64s value)
Sets the measurement value smoothing window for the given measurement.
GoMeasurement::GoMeasurement_EnableSmoothing
kStatus GoMeasurement_EnableSmoothing(GoMeasurement measurement, kBool enable)
Sets measurement value smoothing for the given measurement.
GoMeasurement::GoMeasurement_DecisionMin
k64f GoMeasurement_DecisionMin(GoMeasurement measurement)
Gets the minimum decision value for the given measurement.
GoMeasurement::GoMeasurement_SmoothingEnabled
kBool GoMeasurement_SmoothingEnabled(GoMeasurement measurement)
Returns a boolean value representing the current state of measurement value smoothing.
kChar
GoMeasurement::GoMeasurement_SetDecisionMax
kStatus GoMeasurement_SetDecisionMax(GoMeasurement measurement, k64f max)
Sets the maximum decision value for the given measurement.
GoMeasurement::GoMeasurement_SetDecisionMin
kStatus GoMeasurement_SetDecisionMin(GoMeasurement measurement, k64f min)
Sets the minimum decision value for the given measurement.
GoMeasurement::GoMeasurement_Id
k32s GoMeasurement_Id(GoMeasurement measurement)
Gets the ID for the given measurement.
GoSdkDef.h
Essential SDK declarations.
GoMeasurement::GoMeasurement_Offset
k64f GoMeasurement_Offset(GoMeasurement measurement)
Returns the measurement value offset.
GoMeasurement::GoMeasurement_SetName
kStatus GoMeasurement_SetName(GoMeasurement measurement, const kChar *name)
Sets the name for the given measurement.
GoMeasurement::GoMeasurement_HasId
kBool GoMeasurement_HasId(GoMeasurement measurement)
Returns whether or not the given measurement has a valid ID assigned to it.
GoMeasurement::GoMeasurement_SourceTool
kObject GoMeasurement_SourceTool(GoMeasurement measurement)
Returns the source tool of the given measurement.
k32s
GoMeasurement::GoMeasurement_SetId
kStatus GoMeasurement_SetId(GoMeasurement measurement, k32u id)
Sets an ID number for the given measurement.
k64s
GoMeasurement::GoMeasurement_ClearId
kStatus GoMeasurement_ClearId(GoMeasurement measurement)
Clears the assigned ID for the given measurement.
GoMeasurement::GoMeasurement_SetOffset
kStatus GoMeasurement_SetOffset(GoMeasurement measurement, k64f value)
Sets the measurement value offset for the given measurement.
kObject
kStatus
GoMeasurement::GoMeasurement_Scale
k64f GoMeasurement_Scale(GoMeasurement measurement)
Returns the current measurement value scaling factor.
GoMeasurement::GoMeasurement_DecisionMax
k64f GoMeasurement_DecisionMax(GoMeasurement measurement)
Gets the maximum decision value for the given measurement.
k64f
GoMeasurement::GoMeasurement_XSmoothingPreserveInvalidEnabled
kBool GoMeasurement_XSmoothingPreserveInvalidEnabled(GoMeasurement measurement)
Gets Preserve invalid smoothign enable state.
kBool
GoMeasurement::GoMeasurement_Type
GoMeasurementType GoMeasurement_Type(GoMeasurement measurement)
Gets the measurement type for the given measurement.