Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoExtToolDataOutput.h
Go to the documentation of this file.
1 /**
2 * @file GoExtToolDataOutput.h
3 * @brief Declares the GoExtToolDataOutput class.
4 *
5 * @internal
6 * Copyright (C) 2017-2022 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_EXT_TOOL_DATA_OUTPUT_H
11 #define GO_EXT_TOOL_DATA_OUTPUT_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 /**
16 * @class GoExtToolDataOutput
17 * @extends kObject
18 * @ingroup GoSdk
19 * @brief Represents the base class for a tool data output.
20 */
21 typedef kObject GoExtToolDataOutput;
22
23
24 /**
25 * Sets an ID number for the given toolDataOutput.
26 *
27 * @public @memberof GoExtToolDataOutput
28 * @version Introduced in firmware 4.7.3.97
29 * @param toolDataOutput GoExtToolDataOutput object.
30 * @param id The ID value to set for the toolDataOutput.
31 * @return Operation status.
32 */
33 GoFx(kStatus) GoExtToolDataOutput_SetId(GoExtToolDataOutput toolDataOutput, k32s id);
34
35 /**
36 * Gets the ID for the given toolDataOutput.
37 *
38 * @public @memberof GoExtToolDataOutput
39 * @version Introduced in firmware 4.7.3.97
40 * @param toolDataOutput GoExtToolDataOutput object.
41 * @return The ID value if there is one assigned. Otherwise, -1 is returned.
42 */
43 GoFx(k32s) GoExtToolDataOutput_Id(GoExtToolDataOutput toolDataOutput);
44
45 /**
46 * Sets the name for the given toolDataOutput.
47 *
48 * @public @memberof GoExtToolDataOutput
49 * @version Introduced in firmware 4.7.3.97
50 * @param toolDataOutput GoExtToolDataOutput object.
51 * @param name The name to assign to the toolDataOutput.
52 * @return Operation status.
53 */
54 GoFx(kStatus) GoExtToolDataOutput_SetName(GoExtToolDataOutput toolDataOutput, const kChar* name);
55
56 /**
57 * Gets the name for the given toolDataOutput.
58 *
59 * @public @memberof GoExtToolDataOutput
60 * @version Introduced in firmware 4.7.3.97
61 * @param toolDataOutput GoExtToolDataOutput object.
62 * @return A character array pointer for the toolDataOutput name.
63 */
64 GoFx(const kChar*) GoExtToolDataOutput_Name(GoExtToolDataOutput toolDataOutput);
65
66 /**
67 * Enables the given toolDataOutput for output.
68 *
69 * @public @memberof GoExtToolDataOutput
70 * @version Introduced in firmware 4.7.3.97
71 * @param toolDataOutput GoExtToolDataOutput object.
72 * @param enable Set to kTRUE to enable the toolDataOutput, kFALSE to disable it.
73 * @return Operation status.
74 */
75 GoFx(kStatus) GoExtToolDataOutput_SetEnable(GoExtToolDataOutput toolDataOutput, kBool enable);
76
77 /**
78 * Returns a boolean value representing whether the given toolDataOutput is enabled.
79 *
80 * @public @memberof GoExtToolDataOutput
81 * @version Introduced in firmware 4.7.3.97
82 * @param toolDataOutput GoExtToolDataOutput object.
83 * @return kTRUE if enabled; kFALSE otherwise.
84 */
85 GoFx(kBool) GoExtToolDataOutput_Enabled(GoExtToolDataOutput toolDataOutput);
86
87 /**
88 * Gets the data type for the given toolDataOutput.
89 *
90 * @public @memberof GoExtToolDataOutput
91 * @version Introduced in firmware 4.7.3.97
92 * @param toolDataOutput GoExtToolDataOutput object.
93 * @return The data type value.
94 */
95 GoFx(GoDataType) GoExtToolDataOutput_DataType(GoExtToolDataOutput toolDataOutput);
96
97 /**
98 * Gets the toolDataOutput type name for the given toolDataOutput.
99 *
100 * @public @memberof GoExtToolDataOutput
101 * @version Introduced in firmware 4.7.3.97
102 * @param toolDataOutput GoExtToolDataOutput object.
103 * @return The toolDataOutput type name.
104 */
105 GoFx(const kChar*) GoExtToolDataOutput_Type(GoExtToolDataOutput toolDataOutput);
106
107 #include <GoSdk/Tools/GoExtToolDataOutput.x.h>
108
109 #endif // GO_EXT_TOOL_DATA_OUTPUT_H
GoExtToolDataOutput::GoExtToolDataOutput_Enabled
kBool GoExtToolDataOutput_Enabled(GoExtToolDataOutput toolDataOutput)
Returns a boolean value representing whether the given toolDataOutput is enabled. ...
GoDataType
Represents data source selections. Used as a bitmask.
GoExtToolDataOutput::GoExtToolDataOutput_SetId
kStatus GoExtToolDataOutput_SetId(GoExtToolDataOutput toolDataOutput, k32s id)
Sets an ID number for the given toolDataOutput.
kChar
GoExtToolDataOutput::GoExtToolDataOutput_DataType
GoDataType GoExtToolDataOutput_DataType(GoExtToolDataOutput toolDataOutput)
Gets the data type for the given toolDataOutput.
GoExtToolDataOutput::GoExtToolDataOutput_SetName
kStatus GoExtToolDataOutput_SetName(GoExtToolDataOutput toolDataOutput, const kChar *name)
Sets the name for the given toolDataOutput.
GoSdkDef.h
Essential SDK declarations.
GoExtToolDataOutput::GoExtToolDataOutput_Name
const kChar * GoExtToolDataOutput_Name(GoExtToolDataOutput toolDataOutput)
Gets the name for the given toolDataOutput.
k32s
GoExtToolDataOutput
Represents the base class for a tool data output.
GoExtToolDataOutput::GoExtToolDataOutput_SetEnable
kStatus GoExtToolDataOutput_SetEnable(GoExtToolDataOutput toolDataOutput, kBool enable)
Enables the given toolDataOutput for output.
kObject
kStatus
GoExtToolDataOutput::GoExtToolDataOutput_Type
const kChar * GoExtToolDataOutput_Type(GoExtToolDataOutput toolDataOutput)
Gets the toolDataOutput type name for the given toolDataOutput.
kBool
GoExtToolDataOutput::GoExtToolDataOutput_Id
k32s GoExtToolDataOutput_Id(GoExtToolDataOutput toolDataOutput)
Gets the ID for the given toolDataOutput.