Gocator API
 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) 2011-2012 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_API_OUTPUT_H
11 #define GO_API_OUTPUT_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoOutputTypes.h>
15 kBeginHeader()
16 
17 /**
18  * @class GoOutput
19  * @extends kObject
20  * @ingroup GoSdk
21  * @brief Represents output configuration.
22  */
23 typedef kObject GoOutput;
24 
25 /**
26  * Gets the Ethernet output configuration object.
27  *
28  * @public @memberof GoOutput
29  * @param output GoOutput object.
30  * @return Ethernet configuration object.
31  */
32 GoFx(GoEthernet) GoOutput_Ethernet(GoOutput output);
33 
34 /**
35  * Gets the Serial output configuration object.
36  *
37  * @public @memberof GoOutput
38  * @param output GoOutput object.
39  * @return Serial configuration object.
40  */
41 GoFx(GoSerial) GoOutput_Serial(GoOutput output);
42 
43 /**
44  * Gets the count of Digital output configuration objects.
45  *
46  * @public @memberof GoOutput
47  * @param output GoOutput object.
48  * @return Count of digital output configuration objects.
49  */
50 GoFx(k32u) GoOutput_DigitalCount(GoOutput output);
51 
52 /**
53  * Gets the Digital output configuration object at the specified index.
54  *
55  * @public @memberof GoOutput
56  * @param output GoOutput object.
57  * @param index Digital output index.
58  * @return Digital output configuration object.
59  */
60 GoFx(GoDigital) GoOutput_DigitalAt(GoOutput output, k32u index);
61 
62 /**
63  * Gets the Analog output configuration object.
64  *
65  * @public @memberof GoOutput
66  * @param output GoOutput object.
67  * @return Analog configuration object.
68  */
69 GoFx(GoAnalog) GoOutput_Analog(GoOutput output);
70 
71 
72 kEndHeader()
73 #include <GoSdk/GoOutput.x.h>
74 
75 #endif
GoSerial GoOutput_Serial(GoOutput output)
Gets the Serial output configuration object.
GoEthernet GoOutput_Ethernet(GoOutput output)
Gets the Ethernet output configuration object.
Represents Digital output settings.
Represents output configuration.
Definition: GoOutput.h:15
Essential API declarations.
GoDigital GoOutput_DigitalAt(GoOutput output, k32u index)
Gets the Digital output configuration object at the specified index.
Represents Serial output settings.
GoAnalog GoOutput_Analog(GoOutput output)
Gets the Analog output configuration object.
Represents Ethernet output settings.
Definition: GoOutputTypes.h:14
k32u GoOutput_DigitalCount(GoOutput output)
Gets the count of Digital output configuration objects.
Represents Analog output settings.
Declares the Output Type classes.