Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoMultiplexBank.h
Go to the documentation of this file.
1 /**
2  * @file GoMultiplexBank.h
3  * @brief Declares the GoMultiplexBank class.
4  *
5  * @internal
6  * Copyright (C) 2016-2021 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_MULTIPLEXBANK_H
11 #define GO_MULTIPLEXBANK_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoSensor.h>
15 
16 /**
17  * @class GoMultiplexBank
18  * @extends kObject
19  * @note Supported with G1, G2
20  * @ingroup GoSdk
21  * @brief Represents a bank of related sensors to be used in multiplexing.
22  */
23 typedef kObject GoMultiplexBank;
24 
25 /**
26  * Adds a sensor to the given multiplexing bank.
27  *
28  * @public @memberof GoMultiplexBank
29  * @note Supported with G1, G2
30  * @version Introduced in firmware 4.0.10.27
31  * @param bank GoMultiplexBank object.
32  * @param sensor A connected handle to the sensor to add.
33  * @return Operation status.
34  */
36 
37 /**
38  * Removes a sensor from the given multiplexing bank.
39  *
40  * @public @memberof GoMultiplexBank
41  * @note Supported with G1, G2
42  * @version Introduced in firmware 4.0.10.27
43  * @param bank GoMultiplexBank object.
44  * @param id The ID of the sensor in the bank to the remove.
45  * @return Operation status.
46  */
48 
49 /**
50  * Returns the count corresponding to the number of sensors in the multiplexing bank.
51  *
52  * @public @memberof GoMultiplexBank
53  * @note Supported with G1, G2
54  * @version Introduced in firmware 4.0.10.27
55  * @param bank GoMultiplexBank object.
56  * @return The multiplexing bank's sensor count.
57  */
59 
60 /**
61  * Gets a sensor handle from the given index.
62  *
63  * @public @memberof GoMultiplexBank
64  * @note Supported with G1, G2
65  * @version Introduced in firmware 4.0.10.27
66  * @param bank GoMultiplexBank object.
67  * @param index Multiplexing bank index from which to obtain a sensor handle.
68  * @return A GoSensor object.
69  */
71 
72 /**
73  * Returns a boolean value representing whether a sensor is in the multiplexing bank.
74  *
75  * @public @memberof GoMultiplexBank
76  * @note Supported with G1, G2
77  * @version Introduced in firmware 4.0.10.27
78  * @param bank GoMultiplexBank object.
79  * @param id The sensor ID to search for.
80  * @return kTRUE if the sensor is in the multiplexing bank, kFALSE otherwise.
81  */
83 
84 /**
85  * Gets the ID of the given multiplexing bank.
86  *
87  * @public @memberof GoMultiplexBank
88  * @note Supported with G1, G2
89  * @version Introduced in firmware 4.0.10.27
90  * @param bank GoMultiplexBank object.
91  * @return The multiplexing bank ID.
92  */
94 
95 #include <GoSdk/GoMultiplexBank.x.h>
96 
97 #endif
Declares the GoSensor class.
GoSensor GoMultiplexBank_SensorAt(GoMultiplexBank bank, kSize index)
Gets a sensor handle from the given index.
Represents a bank of related sensors to be used in multiplexing.
Essential SDK declarations.
k32u GoMultiplexBank_Id(GoMultiplexBank bank)
Gets the ID of the given multiplexing bank.
kBool GoMultiplexBank_HasSensor(GoMultiplexBank bank, k32u id)
Returns a boolean value representing whether a sensor is in the multiplexing bank.
kStatus GoMultiplexBank_RemoveSensor(GoMultiplexBank bank, k32u id)
Removes a sensor from the given multiplexing bank.
kSize GoMultiplexBank_SensorCount(GoMultiplexBank bank)
Returns the count corresponding to the number of sensors in the multiplexing bank.
Represents a Gocator sensor.
kStatus GoMultiplexBank_AddSensor(GoMultiplexBank bank, GoSensor sensor)
Adds a sensor to the given multiplexing bank.