Gocator API
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-2019 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 Gets the Serial output configuration object.
39  *
40  * @public @memberof GoOutput
41  * @version Introduced in firmware 4.0.10.27
42  * @param output GoOutput object.
43  * @return Serial configuration object.
44  */
45 GoFx(GoSerial) GoOutput_Serial(GoOutput output);
46 
47 /**
48  * Gets the count of Serial output configuration objects.
49  *
50  * @public @memberof GoOutput
51  * @version Introduced in firmware 5.2.18.3
52  * @param output GoOutput object.
53  * @return Count of Serial output configuration objects.
54  */
55 GoFx(k32u) GoOutput_SerialCount(GoOutput output);
56 
57 /**
58  * Gets the Serial output configuration object at the specified index.
59  *
60  * @public @memberof GoOutput
61  * @version Introduced in firmware 5.2.18.3
62  * @param output GoOutput object.
63  * @param index Serial output index.
64  * @return Serial output configuration object.
65  */
66 GoFx(GoSerial) GoOutput_SerialAt(GoOutput output, kSize index);
67 
68 /**
69  * Gets the count of Digital output configuration objects.
70  *
71  * @public @memberof GoOutput
72  * @version Introduced in firmware 5.2.18.3
73  * @param output GoOutput object.
74  * @return Count of digital output configuration objects.
75  */
76 GoFx(k32u) GoOutput_DigitalCount(GoOutput output);
77 
78 /**
79  * Gets the Digital output configuration object at the specified index.
80  *
81  * @public @memberof GoOutput
82  * @version Introduced in firmware 5.2.18.3
83  * @param output GoOutput object.
84  * @param index Digital output index.
85  * @return Digital output configuration object.
86  */
87 GoFx(GoDigital) GoOutput_DigitalAt(GoOutput output, kSize index);
88 
89 /**
90  * @deprecated Gets the Analog output configuration object.
91  *
92  * @public @memberof GoOutput
93  * @version Introduced in firmware 4.0.10.27
94  * @param output GoOutput object.
95  * @return Analog configuration object.
96  */
97 GoFx(GoAnalog) GoOutput_Analog(GoOutput output);
98 
99 /**
100  * Gets the count of Analog output configuration objects.
101  *
102  * @public @memberof GoOutput
103  * @version Introduced in firmware 5.2.18.3
104  * @param output GoOutput object.
105  * @return Count of analog output configuration objects.
106  */
107 GoFx(k32u) GoOutput_AnalogCount(GoOutput output);
108 
109 /**
110  * Gets the Analog output configuration object at the specified index.
111  *
112  * @public @memberof GoOutput
113  * @version Introduced in firmware 5.2.18.3
114  * @param output GoOutput object.
115  * @param index Analog output index.
116  * @return Analog output configuration object.
117  */
118 GoFx(GoAnalog) GoOutput_AnalogAt(GoOutput output, kSize index);
119 
120 #include <GoSdk/Outputs/GoOutput.x.h>
121 
122 #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)
Declares the GoSerial class.
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.
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.