Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
GoSensorInfo.h
Go to the documentation of this file.
1 /**
2 * @file GoSensorInfo.h
3 * @brief Declares the GoSensorInfo 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_SENSOR_INFO_H
11 #define GO_SDK_SENSOR_INFO_H
12
13 #include <GoSdk/GoSdkDef.h>
14 kBeginHeader()
15 #include <kApi/Io/kSerializer.h>
16
17 /**
18 * @class GoSensorInfo
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents read-only sensor information.
22 */
23 typedef kObject GoSensorInfo;
24
25
26 /**
27 * Gets the source ID of the sensor information.
28 *
29 * @public @memberof GoSensorInfo
30 * @param info GoSensorInfo object.
31 * @return The information source sensor ID.
32 */
33 GoFx(k32u) GoSensorInfo_Id(GoSensorInfo info);
34
35 /**
36 * Gets the firmware version of the sensor which provided the sensor information.
37 *
38 * @public @memberof GoSensorInfo
39 * @param info GoSensorInfo object.
40 * @return The firmware version.
41 */
42 GoFx(kVersion) GoSensorInfo_Firmware(GoSensorInfo info);
43
44 /**
45 * Gets the model string of the sensor which provided the sensor information.
46 *
47 * @public @memberof GoSensorInfo
48 * @param info GoSensorInfo object.
49 * @param model A character array pointer.
50 * @param capacity The character array capacity.
51 * @return Operation status.
52 */
53 GoFx(kStatus) GoSensorInfo_Model(GoSensorInfo info, kChar* model, k32u capacity);
54
55 /**
56 * Gets the role of the sensor which provided the sensor information.
57 *
58 * @public @memberof GoSensorInfo
59 * @param info GoSensorInfo object.
60 * @return The sensor role.
61 */
62 GoFx(GoRole) GoSensorInfo_Role(GoSensorInfo info);
63
64 /**
65 * Indicates whether the device providing the sensor information has a buddy device connected.
66 *
67 * @public @memberof GoSensorInfo
68 * @param info GoSensorInfo object.
69 * @return kTRUE if the device has a buddy and kFALSE otherwise.
70 */
71 GoFx(kBool) GoSensorInfo_HasBuddy(GoSensorInfo info);
72
73 /**
74 * Gets the ID of the buddy device which provided the sensor information.
75 *
76 * @public @memberof GoSensorInfo
77 * @param info GoSensorInfo object.
78 * @return The buddy device ID. 0 is returned if there is no buddy assigned.
79 */
80 GoFx(k32u) GoSensorInfo_BuddyId(GoSensorInfo info);
81
82 /**
83 * Gets the user currently connected to the device which provided the sensor information.
84 *
85 * @public @memberof GoSensorInfo
86 * @param info GoSensorInfo object.
87 * @return The user currently connected to the device.
88 */
89 GoFx(GoUser) GoSensorInfo_User(GoSensorInfo info);
90
91 /**
92 * Gets the state of the device which provided the sensor information.
93 *
94 * @public @memberof GoSensorInfo
95 * @param info GoSensorInfo object.
96 * @return Device state.
97 */
98 GoFx(GoState) GoSensorInfo_State(GoSensorInfo info);
99
100 /**
101 * Gets the alignment state of the device which provided the sensor information.
102 *
103 * @public @memberof GoSensorInfo
104 * @param info GoSensorInfo object.
105 * @return Alignment state.
106 */
107 GoFx(GoAlignmentState) GoSensorInfo_TransformState(GoSensorInfo info);
108
109 kEndHeader()
110
111 #include <GoSdk/GoSensorInfo.x.h>
112
113 #endif
GoSensorInfo
Represents read-only sensor information.
Definition: GoSensorInfo.h:14
GoSensorInfo::GoSensorInfo_Model
kStatus GoSensorInfo_Model(GoSensorInfo info, kChar *model, k32u capacity)
Gets the model string of the sensor which provided the sensor information.
GoRole
Represents a user role.
GoSensorInfo::GoSensorInfo_User
GoUser GoSensorInfo_User(GoSensorInfo info)
Gets the user currently connected to the device which provided the sensor information.
GoAlignmentState
Represents an alignment state.
GoSensorInfo::GoSensorInfo_TransformState
GoAlignmentState GoSensorInfo_TransformState(GoSensorInfo info)
Gets the alignment state of the device which provided the sensor information.
GoSdkDef.h
Essential SDK declarations.
GoSensorInfo::GoSensorInfo_BuddyId
k32u GoSensorInfo_BuddyId(GoSensorInfo info)
Gets the ID of the buddy device which provided the sensor information.
GoSensorInfo::GoSensorInfo_HasBuddy
kBool GoSensorInfo_HasBuddy(GoSensorInfo info)
Indicates whether the device providing the sensor information has a buddy device connected.
GoSensorInfo::GoSensorInfo_State
GoState GoSensorInfo_State(GoSensorInfo info)
Gets the state of the device which provided the sensor information.
GoUser
Represents a user id.
GoSensorInfo::GoSensorInfo_Role
GoRole GoSensorInfo_Role(GoSensorInfo info)
Gets the role of the sensor which provided the sensor information.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoSensorInfo::GoSensorInfo_Id
k32u GoSensorInfo_Id(GoSensorInfo info)
Gets the source ID of the sensor information.
GoSensorInfo::GoSensorInfo_Firmware
kVersion GoSensorInfo_Firmware(GoSensorInfo info)
Gets the firmware version of the sensor which provided the sensor information.
GoState
Represents the current state of a sensor object.