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-2019 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
typedef
GoMeasurement
GoExtMeasurement
;
17
18
/**
19
* Returns the type name of the extensible measurement
20
* @public @memberof GoExtMeasurement
21
* @version Introduced in firmware 4.6.3.142
22
* @param measurement GoExtMeasurement object.
23
* @return Type of extensible measurement..
24
*/
25
GoFx(
const
kChar
*) GoExtMeasurement_Type(
GoExtMeasurement
measurement);
26
27
/**
28
* Returns the number of custom parameters available for this extensible measurement.
29
*
30
* @public @memberof GoExtMeasurement
31
* @version Introduced in firmware 4.6.3.142
32
* @param measurement GoExtMeasurement object.
33
* @return Number of extensible parameters.
34
*/
35
GoFx(
kSize
) GoExtMeasurement_CustomParameterCount(
GoExtMeasurement
measurement);
36
37
/**
38
* Returns the custom parameter at the specified index.
39
*
40
* @public @memberof GoExtMeasurement
41
* @version Introduced in firmware 4.6.3.142
42
* @param measurement GoExtMeasurement object.
43
* @param index Index of parameter to retrieve.
44
* @return The custom measurement parameter object.
45
*/
46
GoFx(GoExtParam) GoExtMeasurement_CustomParameterAt(
GoExtMeasurement
measurement,
kSize
index);
47
48
#include <GoSdk/Tools/GoExtMeasurement.x.h>
49
50
#endif
GoMeasurement
Represents the base class for a tool measurement or script output.
GoMeasurement.h
Declares the GoMeasurement class.
kSize
kChar
Tools
GoExtMeasurement.h