Gocator API

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-2020 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 kBeginHeader()
16
17 /**
18 * @class GoExtToolDataOutput
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents the base class for a tool data output.
22 */
23 typedef kObject GoExtToolDataOutput;
24
25
26 /**
27 * Sets an ID number for the given toolDataOutput.
28 *
29 * @public @memberof GoExtToolDataOutput
30 * @version Introduced in firmware 4.7.3.97
31 * @param toolDataOutput GoExtToolDataOutput object.
32 * @param id The ID value to set for the toolDataOutput.
33 * @return Operation status.
34 */
35 GoFx(kStatus) GoExtToolDataOutput_SetId(GoExtToolDataOutput toolDataOutput, k32s id);
36
37 /**
38 * Gets the ID for the given toolDataOutput.
39 *
40 * @public @memberof GoExtToolDataOutput
41 * @version Introduced in firmware 4.7.3.97
42 * @param toolDataOutput GoExtToolDataOutput object.
43 * @return The ID value if there is one assigned. Otherwise, -1 is returned.
44 */
45 GoFx(k32s) GoExtToolDataOutput_Id(GoExtToolDataOutput toolDataOutput);
46
47 /**
48 * Sets the name for the given toolDataOutput.
49 *
50 * @public @memberof GoExtToolDataOutput
51 * @version Introduced in firmware 4.7.3.97
52 * @param toolDataOutput GoExtToolDataOutput object.
53 * @param name The name to assign to the toolDataOutput.
54 * @return Operation status.
55 */
56 GoFx(kStatus) GoExtToolDataOutput_SetName(GoExtToolDataOutput toolDataOutput, const kChar* name);
57
58 /**
59 * Gets the name for the given toolDataOutput.
60 *
61 * @public @memberof GoExtToolDataOutput
62 * @version Introduced in firmware 4.7.3.97
63 * @param toolDataOutput GoExtToolDataOutput object.
64 * @return A character array pointer for the toolDataOutput name.
65 */
66 GoFx(const kChar*) GoExtToolDataOutput_Name(GoExtToolDataOutput toolDataOutput);
67
68 /**
69 * Enables the given toolDataOutput for output.
70 *
71 * @public @memberof GoExtToolDataOutput
72 * @version Introduced in firmware 4.7.3.97
73 * @param toolDataOutput GoExtToolDataOutput object.
74 * @param enable Set to kTRUE to enable the toolDataOutput, kFALSE to disable it.
75 * @return Operation status.
76 */
77 GoFx(kStatus) GoExtToolDataOutput_SetEnable(GoExtToolDataOutput toolDataOutput, kBool enable);
78
79 /**
80 * Returns a boolean value representing whether the given toolDataOutput is enabled.
81 *
82 * @public @memberof GoExtToolDataOutput
83 * @version Introduced in firmware 4.7.3.97
84 * @param toolDataOutput GoExtToolDataOutput object.
85 * @return kTRUE if enabled; kFALSE otherwise.
86 */
87 GoFx(kBool) GoExtToolDataOutput_Enabled(GoExtToolDataOutput toolDataOutput);
88
89 /**
90 * Gets the data type for the given toolDataOutput.
91 *
92 * @public @memberof GoExtToolDataOutput
93 * @version Introduced in firmware 4.7.3.97
94 * @param toolDataOutput GoExtToolDataOutput object.
95 * @return The data type value.
96 */
97 GoFx(GoDataType) GoExtToolDataOutput_DataType(GoExtToolDataOutput toolDataOutput);
98
99 /**
100 * Gets the toolDataOutput type name for the given toolDataOutput.
101 *
102 * @public @memberof GoExtToolDataOutput
103 * @version Introduced in firmware 4.7.3.97
104 * @param toolDataOutput GoExtToolDataOutput object.
105 * @return The toolDataOutput type name.
106 */
107 GoFx(const kChar*) GoExtToolDataOutput_Type(GoExtToolDataOutput toolDataOutput);
108
109 kEndHeader()
110 #include <GoSdk/Tools/GoExtToolDataOutput.x.h>
111
112 #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.