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-2018 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 kBeginHeader()
20 
21 /**
22  * @class GoOutput
23  * @extends kObject
24  * @ingroup GoSdk-Output
25  * @brief Represents output configuration.
26  */
27 typedef kObject GoOutput;
28 
29 /**
30  * @deprecated Gets the Ethernet output configuration object.
31  *
32  * @public @memberof GoOutput
33  * @version Introduced in firmware 4.0.10.27
34  * @param output GoOutput object.
35  * @return Ethernet configuration object.
36  */
37 GoFx(GoEthernet) GoOutput_Ethernet(GoOutput output);
38 
39 /**
40  * Gets the count of Ethernet output configuration objects.
41  *
42  * @public @memberof GoOutput
43  * @param output GoOutput object.
44  * @return Count of Ethernet output configuration objects.
45  */
46 GoFx(k32u) GoOutput_EthernetCount(GoOutput output);
47 
48 /**
49  * Gets the Ethernet output configuration object at the specified index.
50  *
51  * @public @memberof GoOutput
52  * @param output GoOutput object.
53  * @param index Ethernet output index.
54  * @return Ethernet output configuration object.
55  */
56 GoFx(GoEthernet) GoOutput_EthernetAt(GoOutput output, kSize index);
57 
58 /**
59  * @deprecated Gets the Serial output configuration object.
60  *
61  * @public @memberof GoOutput
62  * @version Introduced in firmware 4.0.10.27
63  * @param output GoOutput object.
64  * @return Serial configuration object.
65  */
66 GoFx(GoSerial) GoOutput_Serial(GoOutput output);
67 
68 /**
69  * Gets the count of Serial output configuration objects.
70  *
71  * @public @memberof GoOutput
72  * @param output GoOutput object.
73  * @return Count of Serial output configuration objects.
74  */
75 GoFx(k32u) GoOutput_SerialCount(GoOutput output);
76 
77 /**
78  * Gets the Serial output configuration object at the specified index.
79  *
80  * @public @memberof GoOutput
81  * @param output GoOutput object.
82  * @param index Serial output index.
83  * @return Serial output configuration object.
84  */
85 GoFx(GoSerial) GoOutput_SerialAt(GoOutput output, kSize index);
86 
87 /**
88  * Gets the count of Digital output configuration objects.
89  *
90  * @public @memberof GoOutput
91  * @param output GoOutput object.
92  * @return Count of digital output configuration objects.
93  */
94 GoFx(k32u) GoOutput_DigitalCount(GoOutput output);
95 
96 /**
97  * Gets the Digital output configuration object at the specified index.
98  *
99  * @public @memberof GoOutput
100  * @param output GoOutput object.
101  * @param index Digital output index.
102  * @return Digital output configuration object.
103  */
104 GoFx(GoDigital) GoOutput_DigitalAt(GoOutput output, kSize index);
105 
106 /**
107  * @deprecated Gets the Analog output configuration object.
108  *
109  * @public @memberof GoOutput
110  * @version Introduced in firmware 4.0.10.27
111  * @param output GoOutput object.
112  * @return Analog configuration object.
113  */
114 GoFx(GoAnalog) GoOutput_Analog(GoOutput output);
115 
116 /**
117  * Gets the count of Analog output configuration objects.
118  *
119  * @public @memberof GoOutput
120  * @param output GoOutput object.
121  * @return Count of analog output configuration objects.
122  */
123 GoFx(k32u) GoOutput_AnalogCount(GoOutput output);
124 
125 /**
126  * Gets the Analog output configuration object at the specified index.
127  *
128  * @public @memberof GoOutput
129  * @param output GoOutput object.
130  * @param index Analog output index.
131  * @return Analog output configuration object.
132  */
133 GoFx(GoAnalog) GoOutput_AnalogAt(GoOutput output, kSize index);
134 
135 kEndHeader()
136 #include <GoSdk/Outputs/GoOutput.x.h>
137 
138 #endif
GoEthernet GoOutput_Ethernet(GoOutput output)
GoDigital GoOutput_DigitalAt(GoOutput output, kSize index)
Gets the Digital output configuration object at the specified index.
GoAnalog GoOutput_Analog(GoOutput output)
Declares the GoSerial class.
k32u GoOutput_EthernetCount(GoOutput output)
Gets the count of Ethernet output configuration objects.
GoSerial GoOutput_Serial(GoOutput output)
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.
GoEthernet GoOutput_EthernetAt(GoOutput output, kSize index)
Gets the Ethernet output configuration object at the specified index.
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.