Gocator API

- Home
- Types
- Files

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