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