Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoTool.h
Go to the documentation of this file.
1 /**
2 * @file GoTool.h
3 * @brief Declares the base GoTool class.
4 *
5 * @internal
6 * Copyright (C) 2016 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_TOOL_H
11 #define GO_TOOL_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoMeasurements.h>
15 #include <kApi/Data/kXml.h>
16 kBeginHeader()
17
18 /**
19 * @class GoTool
20 * @extends kObject
21 * @ingroup GoSdk-Tools
22 * @brief Represents the base tool class.
23 */
24 typedef kObject GoTool;
25
26 /**
27 * Returns the measurement count.
28 *
29 * @public @memberof GoTool
30 * @version Introduced in firmware 4.0.10.27
31 * @param tool GoTool object.
32 * @return The measurement count.
33 */
34 GoFx(kSize) GoTool_MeasurementCount(GoTool tool);
35
36 /**
37 * Retrieves the measurement at the given index.
38 *
39 * @public @memberof GoTool
40 * @version Introduced in firmware 4.0.10.27
41 * @param tool GoTool object.
42 * @param index The index of the measurement.
43 * @return The measurement at the given index or kNULL if an invalid index is provided.
44 */
45 GoFx(GoMeasurement) GoTool_MeasurementAt(GoTool tool, kSize index);
46
47 /**
48 * Sets the name of the tool.
49 *
50 * @public @memberof GoTool
51 * @version Introduced in firmware 4.0.10.27
52 * @param tool GoTool object.
53 * @param name The name to be set for the tool.
54 * @return Operation status.
55 */
56 GoFx(kStatus) GoTool_SetName(GoTool tool, const kChar* name);
57
58 /**
59 * Retrieves the name of the tool.
60 *
61 * @public @memberof GoTool
62 * @version Introduced in firmware 4.0.10.27
63 * @param tool GoTool object.
64 * @param name Receives the name of the tool.
65 * @param capacity The maximum capacity of the name array.
66 * @return Operation status.
67 */
68 GoFx(kStatus) GoTool_Name(GoTool tool, kChar* name, kSize capacity);
69
70 /**
71 * Retrieves the tool type enumeration value of the tool.
72 *
73 * @public @memberof GoTool
74 * @version Introduced in firmware 4.0.10.27
75 * @param tool GoTool object.
76 * @return The tool type enumeration value.
77 */
78 GoFx(GoToolType) GoTool_Type(GoTool tool);
79
80 /**
81 * Retrieves the first found instance of a measurement for a given enumeration type.
82 *
83 * @public @memberof GoTool
84 * @version Introduced in firmware 4.0.10.27
85 * @param tool GoTool object.
86 * @param type A GoMeasurementType representing the measurement type to find in the given tool.
87 * @return A measurement object if one is found, otherwise kNULL.
88 */
89 GoFx(GoMeasurement) GoTool_FindMeasurementByType(GoTool tool, GoMeasurementType type);
90
91 kEndHeader()
92 #include <GoSdk/Tools/GoTool.x.h>
93
94 #endif
GoToolType
Lists all tool types.
GoTool::GoTool_FindMeasurementByType
GoMeasurement GoTool_FindMeasurementByType(GoTool tool, GoMeasurementType type)
Retrieves the first found instance of a measurement for a given enumeration type. ...
GoMeasurement
Represents the base class for a tool measurement or script output.
GoMeasurementType
Lists all measurement types.
kSize
kChar
GoTool::GoTool_SetName
kStatus GoTool_SetName(GoTool tool, const kChar *name)
Sets the name of the tool.
GoSdkDef.h
Essential SDK declarations.
GoTool::GoTool_MeasurementAt
GoMeasurement GoTool_MeasurementAt(GoTool tool, kSize index)
Retrieves the measurement at the given index.
GoTool::GoTool_Name
kStatus GoTool_Name(GoTool tool, kChar *name, kSize capacity)
Retrieves the name of the tool.
GoMeasurements.h
Declares the GoMeasurement classes.
GoTool
Represents the base tool class.
GoTool::GoTool_Type
GoToolType GoTool_Type(GoTool tool)
Retrieves the tool type enumeration value of the tool.
GoTool::GoTool_MeasurementCount
kSize GoTool_MeasurementCount(GoTool tool)
Returns the measurement count.
kObject
kStatus
kXml.h