Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
GdkToolDataOutputCfg.h
Go to the documentation of this file.
1 /**
2 * @file GdkToolDataOutputCfg.h
3 * @brief Declares the GdkToolDataOutputCfg class.
4 *
5 * Copyright (C) 2017-2022 by LMI Technologies Inc. All rights reserved.
6 */
7 #ifndef GDK_TOOLDATA_OUTPUT_CFG_H
8 #define GDK_TOOLDATA_OUTPUT_CFG_H
9 
10 #include <Gdk/GdkDef.h>
11 #include <Gdk/Config/GdkToolOutputCfg.h>
12 #include <Gdk/Config/GdkParams.h>
13 
14 /**
15 * Represents configuration for a tool data output.
16 *
17 * @class GdkToolDataOutputCfg
18 * @ingroup Gdk-Config
19 */
20 typedef kPointer GdkToolDataOutputCfg;
21 
22 /**
23 * Returns the tool data output Data type.
24 *
25 * @public @memberof GdkToolDataOutputCfg
26 * @param config Configuration object.
27 * @return Data type of the tool data output.
28 */
29 GdkFx(GdkDataType) GdkToolDataOutputCfg_DataType(GdkToolDataOutputCfg config);
30 
31 /**
32 * Returns the tool data output Type name.
33 *
34 * @public @memberof GdkToolDataOutputCfg
35 * @param config Configuration object.
36 * @return Pointer to type name.
37 */
38 GdkFx(const kChar*) GdkToolDataOutputCfg_Type(GdkToolDataOutputCfg config);
39 
40 /**
41 * Returns the tool data output ID.
42 *
43 * @public @memberof GdkToolDataOutputCfg
44 * @param config Configuration object.
45 * @return Tool data output configuration ID.
46 */
47 GdkFx(k32s) GdkToolDataOutputCfg_Id(GdkToolDataOutputCfg config);
48 
49 /**
50 * Returns the tool data output name.
51 *
52 * @public @memberof GdkToolDataOutputCfg
53 * @param config Configuration object.
54 * @return Pointer to name.
55 */
56 GdkFx(const kChar*) GdkToolDataOutputCfg_Name(GdkToolDataOutputCfg config);
57 
58 /**
59 * Returns tool data output enabled state.
60 *
61 * @public @memberof GdkToolDataOutputCfg
62 * @param config Configuration object.
63 * @return Enabled state.
64 */
65 GdkFx(kBool) GdkToolDataOutputCfg_Enabled(GdkToolDataOutputCfg config);
66 
67 /**
68 * Returns user-defined parameter set.
69 *
70 * @public @memberof GdkToolDataOutputCfg
71 * @param config Configuration object.
72 * @return Parameter set.
73 */
74 GdkFx(GdkParams) GdkToolDataOutputCfg_Parameters(GdkToolDataOutputCfg config);
75 
76 /**
77 * Sets the name of the data output.
78 *
79 * @public @memberof GdkToolDataOutputCfg
80 * @param config Configuration object.
81 * @param name Name to set to.
82 * @return Operation status.
83 */
84 GdkFx(kStatus) GdkToolDataOutputCfg_SetName(GdkToolDataOutputCfg config, const kChar* name);
85 
86 /**
87 * Sets the enabled state of the data output.
88 *
89 * @public @memberof GdkToolDataOutputCfg
90 * @param config Configuration object.
91 * @param flag True to enable, false to disable.
92 * @return Operation status.
93 */
94 GdkFx(kStatus) GdkToolDataOutputCfg_SetEnabled(GdkToolDataOutputCfg config, kBool flag);
95 
96 #endif
GdkToolDataOutputCfg
Represents configuration for a tool data output.
GdkDef.h
Essential Gdk declarations.
GdkToolDataOutputCfg::GdkToolDataOutputCfg_Parameters
GdkParams GdkToolDataOutputCfg_Parameters(GdkToolDataOutputCfg config)
Returns user-defined parameter set.
GdkParams.h
Declares the GdkParams class.
GdkParams
Represents a set of parameters.
GdkToolDataOutputCfg::GdkToolDataOutputCfg_Name
const kChar * GdkToolDataOutputCfg_Name(GdkToolDataOutputCfg config)
Returns the tool data output name.
GdkToolDataOutputCfg::GdkToolDataOutputCfg_SetEnabled
kStatus GdkToolDataOutputCfg_SetEnabled(GdkToolDataOutputCfg config, kBool flag)
Sets the enabled state of the data output.
GdkToolDataOutputCfg::GdkToolDataOutputCfg_DataType
GdkDataType GdkToolDataOutputCfg_DataType(GdkToolDataOutputCfg config)
Returns the tool data output Data type.
GdkToolDataOutputCfg::GdkToolDataOutputCfg_Type
const kChar * GdkToolDataOutputCfg_Type(GdkToolDataOutputCfg config)
Returns the tool data output Type name.
GdkToolOutputCfg.h
Declares the GdkToolOutputCfg class.
GdkDataType
Represents data type. No longer used as a bitmask. Note that generic data types will have their msb s...
GdkToolDataOutputCfg::GdkToolDataOutputCfg_Enabled
kBool GdkToolDataOutputCfg_Enabled(GdkToolDataOutputCfg config)
Returns tool data output enabled state.
GdkToolDataOutputCfg::GdkToolDataOutputCfg_Id
k32s GdkToolDataOutputCfg_Id(GdkToolDataOutputCfg config)
Returns the tool data output ID.
GdkToolDataOutputCfg::GdkToolDataOutputCfg_SetName
kStatus GdkToolDataOutputCfg_SetName(GdkToolDataOutputCfg config, const kChar *name)
Sets the name of the data output.