Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups 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) 2014 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 * @param output GoOutput object.
34 * @return Ethernet configuration object.
35 */
36 GoFx(GoEthernet) GoOutput_Ethernet(GoOutput output);
37
38 /**
39 * Gets the Serial output configuration object.
40 *
41 * @public @memberof GoOutput
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 Digital output configuration objects.
49 *
50 * @public @memberof GoOutput
51 * @param output GoOutput object.
52 * @return Count of digital output configuration objects.
53 */
54 GoFx(k32u) GoOutput_DigitalCount(GoOutput output);
55
56 /**
57 * Gets the Digital output configuration object at the specified index.
58 *
59 * @public @memberof GoOutput
60 * @param output GoOutput object.
61 * @param index Digital output index.
62 * @return Digital output configuration object.
63 */
64 GoFx(GoDigital) GoOutput_DigitalAt(GoOutput output, kSize index);
65
66 /**
67 * Gets the Analog output configuration object.
68 *
69 * @public @memberof GoOutput
70 * @param output GoOutput object.
71 * @return Analog configuration object.
72 */
73 GoFx(GoAnalog) GoOutput_Analog(GoOutput output);
74
75
76 kEndHeader()
77 #include <GoSdk/Outputs/GoOutput.x.h>
78
79 #endif
GoOutput::GoOutput_Serial
GoSerial GoOutput_Serial(GoOutput output)
Gets the Serial output configuration object.
GoOutput::GoOutput_Ethernet
GoEthernet GoOutput_Ethernet(GoOutput output)
Gets the Ethernet output configuration object.
GoSerial.h
Declares the GoSerial class.
GoOutput::GoOutput_DigitalAt
GoDigital GoOutput_DigitalAt(GoOutput output, kSize index)
Gets the Digital output configuration object at the specified index.
GoDigital
Represents Digital output settings.
Definition: GoDigital.h:14
GoEthernet.h
Declares the GoEthernet class.
GoOutput
Represents output configuration.
Definition: GoOutput.h:19
GoSdkDef.h
Essential SDK declarations.
GoSerial
Represents Serial output settings.
Definition: GoSerial.h:14
GoDigital.h
Declares the GoDigital class.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoOutput::GoOutput_Analog
GoAnalog GoOutput_Analog(GoOutput output)
Gets the Analog output configuration object.
GoEthernet
Represents Ethernet output settings.
Definition: GoEthernet.h:14
GoAnalog.h
Declares the GoAnalog class.
GoOutput::GoOutput_DigitalCount
k32u GoOutput_DigitalCount(GoOutput output)
Gets the count of Digital output configuration objects.
GoAnalog
Represents Analog output settings.
Definition: GoAnalog.h:14