Gocator API

GoExtMeasurement.h
Go to the documentation of this file.
1 /**
2 * @file GoExtMeasurement.h
3 * @brief Declares the GoExtMeasurement class.
4 *
5 * @internal
6 * Copyright (C) 2017-2020 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_EXTMEASUREMENT_H
11 #define GO_EXTMEASUREMENT_H
12
13 #include <GoSdk/Tools/GoMeasurement.h>
14 #include <GoSdk/Tools/GoExtParams.h>
15
16 kBeginHeader()
17
18 typedef GoMeasurement GoExtMeasurement;
19
20 /**
21 * Returns the type name of the extensible measurement
22 * @public @memberof GoExtMeasurement
23 * @version Introduced in firmware 4.6.3.142
24 * @param measurement GoExtMeasurement object.
25 * @return Type of extensible measurement..
26 */
27 GoFx(const kChar*) GoExtMeasurement_Type(GoExtMeasurement measurement);
28
29 /**
30 * Returns the number of custom parameters available for this extensible measurement.
31 *
32 * @public @memberof GoExtMeasurement
33 * @version Introduced in firmware 4.6.3.142
34 * @param measurement GoExtMeasurement object.
35 * @return Number of extensible parameters.
36 */
37 GoFx(kSize) GoExtMeasurement_CustomParameterCount(GoExtMeasurement measurement);
38
39 /**
40 * Returns the custom parameter at the specified index.
41 *
42 * @public @memberof GoExtMeasurement
43 * @version Introduced in firmware 4.6.3.142
44 * @param measurement GoExtMeasurement object.
45 * @param index Index of parameter to retrieve.
46 * @return The custom measurement parameter object.
47 */
48 GoFx(GoExtParam) GoExtMeasurement_CustomParameterAt(GoExtMeasurement measurement, kSize index);
49
50
51 kEndHeader()
52 #include <GoSdk/Tools/GoExtMeasurement.x.h>
53
54 #endif
GoMeasurement
Represents the base class for a tool measurement or script output.
GoMeasurement.h
Declares the GoMeasurement class.
kSize
kChar