Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoOutput.h
Go to the documentation of this file.
1 /**
2  * @file GoOutput.h
3  * @brief Declares the GoOutput class.
4  *
5  * @internal
6  * Copyright (C) 2016-2022 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_SDK_OUTPUT_H
11 #define GO_SDK_OUTPUT_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Outputs/GoAnalog.h>
17 #include <GoSdk/Outputs/GoSerial.h>
18 
19 /**
20  * @class GoOutput
21  * @extends kObject
22  * @ingroup GoSdk-Output
23  * @brief Represents output configuration.
24  */
25 typedef kObject GoOutput;
26 
27 /**
28  * Gets the Ethernet output configuration object.
29  *
30  * @public @memberof GoOutput
31  * @version Introduced in firmware 4.0.10.27
32  * @param output GoOutput object.
33  * @return Ethernet configuration object.
34  */
36 
37 /**
38 * [Deprecated]
39 *
40 * Gets the Serial output configuration object.
41 *
42 * @deprecated
43 * @public @memberof GoOutput
44 * @version Introduced in firmware 4.0.10.27
45 * @param output GoOutput object.
46 * @return Serial configuration object.
47 */
48 GoFx(GoSerial) GoOutput_Serial(GoOutput output);
49 
50 /**
51  * Gets the count of Serial output configuration objects.
52  *
53  * @public @memberof GoOutput
54  * @version Introduced in firmware 5.2.18.3
55  * @param output GoOutput object.
56  * @return Count of Serial output configuration objects.
57  */
58 GoFx(k32u) GoOutput_SerialCount(GoOutput output);
59 
60 /**
61  * Gets the Serial output configuration object at the specified index.
62  *
63  * @public @memberof GoOutput
64  * @version Introduced in firmware 5.2.18.3
65  * @param output GoOutput object.
66  * @param index Serial output index.
67  * @return Serial output configuration object.
68  */
69 GoFx(GoSerial) GoOutput_SerialAt(GoOutput output, kSize index);
70 
71 /**
72  * Gets the count of Digital output configuration objects.
73  *
74  * @public @memberof GoOutput
75  * @version Introduced in firmware 5.2.18.3
76  * @param output GoOutput object.
77  * @return Count of digital output configuration objects.
78  */
79 GoFx(k32u) GoOutput_DigitalCount(GoOutput output);
80 
81 /**
82  * Gets the Digital output configuration object at the specified index.
83  *
84  * @public @memberof GoOutput
85  * @version Introduced in firmware 5.2.18.3
86  * @param output GoOutput object.
87  * @param index Digital output index.
88  * @return Digital output configuration object.
89  */
90 GoFx(GoDigital) GoOutput_DigitalAt(GoOutput output, kSize index);
91 
92 /**
93 * [Deprecated]
94 *
95 * Gets the Analog output configuration object.
96 *
97 * @deprecated
98 * @public @memberof GoOutput
99 * @version Introduced in firmware 4.0.10.27
100 * @param output GoOutput object.
101 * @return Analog configuration object.
102 */
103 GoFx(GoAnalog) GoOutput_Analog(GoOutput output);
104 
105 /**
106  * Gets the count of Analog output configuration objects.
107  *
108  * @public @memberof GoOutput
109  * @version Introduced in firmware 5.2.18.3
110  * @param output GoOutput object.
111  * @return Count of analog output configuration objects.
112  */
113 GoFx(k32u) GoOutput_AnalogCount(GoOutput output);
114 
115 /**
116  * Gets the Analog output configuration object at the specified index.
117  *
118  * @public @memberof GoOutput
119  * @version Introduced in firmware 5.2.18.3
120  * @param output GoOutput object.
121  * @param index Analog output index.
122  * @return Analog output configuration object.
123  */
124 GoFx(GoAnalog) GoOutput_AnalogAt(GoOutput output, kSize index);
125 
126 #include <GoSdk/Outputs/GoOutput.x.h>
127 
128 #endif
GoEthernet GoOutput_Ethernet(GoOutput output)
Gets the Ethernet output configuration object.
GoDigital GoOutput_DigitalAt(GoOutput output, kSize index)
Gets the Digital output configuration object at the specified index.
GoAnalog GoOutput_Analog(GoOutput output)
[Deprecated]
Declares the GoSerial class.
GoSerial GoOutput_Serial(GoOutput output)
[Deprecated]
Represents Digital output settings.
k32u GoOutput_SerialCount(GoOutput output)
Gets the count of Serial output configuration objects.
Declares the GoEthernet class.
Represents output configuration.
Essential SDK declarations.
k32u GoOutput_AnalogCount(GoOutput output)
Gets the count of Analog output configuration objects.
GoAnalog GoOutput_AnalogAt(GoOutput output, kSize index)
Gets the Analog output configuration object at the specified index.
Represents Serial output settings.
Declares the GoDigital class.
GoSerial GoOutput_SerialAt(GoOutput output, kSize index)
Gets the Serial output configuration object at the specified index.
k32u GoOutput_DigitalCount(GoOutput output)
Gets the count of Digital output configuration objects.
Represents Ethernet output settings.
Declares the GoAnalog class.
Represents Analog output settings.