Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoAccelSensorPortAlloc.h
Go to the documentation of this file.
1 /**
2 * @file GoAccelSensorPortAlloc.h
3 * @brief Declares the GoAccelSensorPortAlloc class.
4 *
5 * @internal
6 * Copyright (C) 2016-2022 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_ACCEL_SENSOR_PORT_ALLOC_H
11 #define GO_ACCEL_SENSOR_PORT_ALLOC_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 typedef kObject GoAccelSensorPortAlloc;
16
17 typedef struct GoAccelSensorPortAllocPorts
18 {
19 k16u controlPort;
20 k16u upgradePort;
21 k16u healthPort;
22 k16u privateDataPort;
23 k16u publicDataPort;
24 k16u webPort;
25 } GoAccelSensorPortAllocPorts;
26
27 GoFx(kStatus) GoAccelSensorPortAlloc_Construct(GoAccelSensorPortAlloc* portAlloc, kAlloc allocator);
28
29 GoFx(kStatus) GoAccelSensorPortAlloc_SetPortRange(GoAccelSensorPortAlloc portAlloc, k16u startPort, k16u endPort);
30 GoFx(kStatus) GoAccelSensorPortAlloc_GetPortRange(GoAccelSensorPortAlloc portAlloc, k16u* startPort, k16u* endPort);
31 GoFx(kStatus) GoAccelSensorPortAlloc_GetPortRangeLimits(GoAccelSensorPortAlloc portAlloc, k16u* startLimit, k16u* endLimit, k16u* minNumPorts);
32
33 GoFx(kStatus) GoAccelSensorPortAlloc_AllocatePorts(GoAccelSensorPortAlloc portAlloc, k32u sensorId, GoAccelSensorPortAllocPorts* sensorPorts);
34 GoFx(kStatus) GoAccelSensorPortAlloc_AllocateRestoredPorts(GoAccelSensorPortAlloc portAlloc, k32u sensorId, GoAccelSensorPortAllocPorts* sensorPorts);
35
36 GoFx(kBool) GoAccelSensorPortAlloc_UserSelectedPortsFree(GoAccelSensorPortAlloc portAlloc, GoAccelSensorPortAllocPorts* sensorPorts, kBool doAllocationCheck);
37 GoFx(kStatus) GoAccelSensorPortAlloc_RemoveAllocatedPorts(GoAccelSensorPortAlloc portAlloc, k32u sensorId, GoAccelSensorPortAllocPorts* sensorPorts);
38
39 // Used for unit testing.
40 GoFx(kStatus) GoAccelSensorPortAlloc_PurgeAllAllocatedPorts(GoAccelSensorPortAlloc portAlloc);
41
42 #include <GoSdk/Internal/GoAccelSensorPortAlloc.x.h>
43
44 #endif // GO_ACCEL_SENSOR_PORT_ALLOC_H
k32u
k16u
kAlloc
GoSdkDef.h
Essential SDK declarations.
kObject
kStatus
kBool