GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanConfigGroup.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanConfigGroup.h
3 * @brief Declares a GoWebScanConfigGroup object.
4 *
5 * @internal
6 * Copyright (C) 2017-2018 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 
11 #ifndef GO_WEB_SCAN_CONFIG_GROUP_H
12 #define GO_WEB_SCAN_CONFIG_GROUP_H
13 
17 #include <GoSdk/GoSdk.h>
18 
19 kBeginHeader()
20 
21 /**
22 * @class GoWebScanConfigGroup
23 * @extends kObject
24 * @ingroup GoWebScanSdk-Config
25 * @brief Represents a container for group-level parameters which are translated from user
26 * parameters set in GoWebScanSettings. This class contains properties describing
27 * the group orientation, and contains a list of sensor configuration objects. This
28 * class is intended to be constructed from within a GoWebScanConfig object.
29 *
30 * GoWebScanConfig organizes the configuration at the system, group, sensor, and node
31 * levels. Configuration of the groups within the system are represented by the
32 * GoWebScanConfigGroup class, sensors by the GoWebScanConfigSensor class, and nodes
33 * by the GoWebScanConfigNode class. GoWebScanConfig will construct and own these
34 * classes.
35 */
37 
38 // Forward declarations
39 typedef kObject GoWebScanConfig;
42 
43 /**
44  * Constructs a GoWebScanConfigGroup object.
45  *
46  * @public @memberof GoWebScanConfigGroup
47  * @param group Receives the constructed GoWebScanConfigGroup object.
48  * @param config Parent system-level configuration.
49  * @param settingsGroup User settings for the group.
50  * @param calibration System calibration. Set to kNULL if running system uncalibrated or if
51  * running system calibration.
52  * @param sensorInfo List of GoWebScanConfigSensorInfo structs representing information
53  * from each sensor in the system.
54  * @param allocator Memory allocator (or kNULL for default).
55  * @return Operation status.
56  */
57 GoWebScanFx(kStatus) GoWebScanConfigGroup_Construct(GoWebScanConfigGroup* group, GoWebScanConfig config, GoWebScanSettingsGroup settingsGroup, GoWebScanCal calibration, kArrayList sensorInfo, kAlloc allocator);
58 
59 /**
60  * Gets the configuration of the system that the group is part of.
61  *
62  * @public @memberof GoWebScanConfigGroup
63  * @param group GoWebScanConfigGroup object.
64  * @return GoWebScanConfig object representing system configuration.
65  */
66 GoWebScanFx(GoWebScanConfig) GoWebScanConfigGroup_Parent(GoWebScanConfigGroup group);
67 
68 /**
69 * Gets the plane of the group.
70 *
71 * @public @memberof GoWebScanConfigGroup
72 * @param group GoWebScanConfigGroup object.
73 * @return Plane of group.
74 */
75 GoWebScanFx(GoWebScanSystemPlane) GoWebScanConfigGroup_Plane(GoWebScanConfigGroup group);
76 
77 /**
78 * Gets the Y-orientation of the group.
79 *
80 * @public @memberof GoWebScanConfigGroup
81 * @param group GoWebScanConfigGroup object.
82 * @return Y-orientation of group.
83 * @see GoWebScanYOrientation
84 */
85 GoWebScanFx(GoWebScanYOrientation) GoWebScanConfigGroup_YOrientation(GoWebScanConfigGroup group);
86 
87 /**
88 * Gets the Z-orientation of the group (same as the group's plane).
89 *
90 * @public @memberof GoWebScanConfigGroup
91 * @param group GoWebScanConfigGroup object.
92 * @return Z-orientation of group.
93 */
94 GoWebScanFx(GoWebScanSystemPlane) GoWebScanConfigGroup_ZOrientation(GoWebScanConfigGroup group);
95 
96 /**
97 * Gets the maximum node column ID within this group. Each node column represents a camera in the
98 * system.
99 *
100 * @public @memberof GoWebScanConfigGroup
101 * @param group GoWebScanConfigGroup object.
102 * @return Maximum node column ID within this group.
103 */
104 GoWebScanFx(kSSize) GoWebScanConfigGroup_MaxNodeColumn(GoWebScanConfigGroup group);
105 
106 /**
107 * Gets the count of sensors in this group.
108 *
109 * @public @memberof GoWebScanConfigGroup
110 * @param group GoWebScanConfigGroup object.
111 * @return Sensor count.
112 */
113 GoWebScanFx(kSSize) GoWebScanConfigGroup_SensorCount(GoWebScanConfigGroup group);
114 
115 /**
116  * Gets the configuration of a sensor at a specified index in the group.
117  *
118  * @public @memberof GoWebScanConfigGroup
119  * @param group GoWebScanConfigGroup object.
120  * @param index Sensor index.
121  * @return Sensor configuration.
122  */
123 GoWebScanFx(GoWebScanConfigSensor) GoWebScanConfigGroup_SensorAt(GoWebScanConfigGroup group, kSSize index);
124 
125 /**
126 * Gets the count of nodes in this group. Each node represents a camera in the system.
127 *
128 * @public @memberof GoWebScanConfigGroup
129 * @param group GoWebScanConfigGroup object.
130 * @return Node count.
131 */
132 GoWebScanFx(kSSize) GoWebScanConfigGroup_NodeCount(GoWebScanConfigGroup group);
133 
134 /**
135 * Gets the configuration of a node at a specified index in the group.
136 *
137 * @public @memberof GoWebScanConfigGroup
138 * @param group GoWebScanConfigGroup object.
139 * @param index Node index.
140 * @return Node configuration.
141 */
142 GoWebScanFx(GoWebScanConfigNode) GoWebScanConfigGroup_NodeAt(GoWebScanConfigGroup group, kSSize index);
143 
144 /**
145 * Gets the count of sections defined for this group.
146 *
147 * @public @memberof GoWebScanConfigGroup
148 * @param group GoWebScanConfigGroup object.
149 * @return Section count.
150 */
151 GoWebScanFx(kSSize) GoWebScanConfigGroup_SectionCount(GoWebScanConfigGroup group);
152 
153 /**
154 * Gets the section at a specified index in the group's section list.
155 *
156 * @public @memberof GoWebScanConfigGroup
157 * @param group GoWebScanConfigGroup object.
158 * @param index Section index.
159 * @return Pointer to section.
160 */
161 GoWebScanFx(GoWebScanSection*) GoWebScanConfigGroup_SectionAt(GoWebScanConfigGroup group, kSSize index);
162 
163 kEndHeader()
164 #include <GoWebScanSdk/GoWebScanConfigGroup.x.h>
165 
166 #endif
Represents a container for node-level parameters which are translated from user parameters set in GoW...
GoWebScanConfigSensor GoWebScanConfigGroup_SensorAt(GoWebScanConfigGroup group, kSSize index)
Gets the configuration of a sensor at a specified index in the group.
GoWebScanYOrientation GoWebScanConfigGroup_YOrientation(GoWebScanConfigGroup group)
Gets the Y-orientation of the group.
Essential GoWebScan declarations.
Represents a container for sensor-level parameters which are translated from user parameters set in G...
kSSize GoWebScanConfigGroup_SensorCount(GoWebScanConfigGroup group)
Gets the count of sensors in this group.
Represents a container for group-level parameters which are translated from user parameters set in Go...
GoWebScanSystemPlane GoWebScanConfigGroup_ZOrientation(GoWebScanConfigGroup group)
Gets the Z-orientation of the group (same as the group's plane).
Represents a container for user-configurable settings of a group within the system. Groups represent planes (top or bottom).
Declares a GoWebScanCal object.
kSSize GoWebScanConfigGroup_MaxNodeColumn(GoWebScanConfigGroup group)
Gets the maximum node column ID within this group.
kStatus GoWebScanConfigGroup_Construct(GoWebScanConfigGroup *group, GoWebScanConfig config, GoWebScanSettingsGroup settingsGroup, GoWebScanCal calibration, kArrayList sensorInfo, kAlloc allocator)
Constructs a GoWebScanConfigGroup object.
Represents the top or bottom plane of the system.
kSSize GoWebScanConfigGroup_SectionCount(GoWebScanConfigGroup group)
Gets the count of sections defined for this group.
GoWebScanConfigNode GoWebScanConfigGroup_NodeAt(GoWebScanConfigGroup group, kSSize index)
Gets the configuration of a node at a specified index in the group.
Declares a GoWebScanProcess object.
kSSize GoWebScanConfigGroup_NodeCount(GoWebScanConfigGroup group)
Gets the count of nodes in this group.
Represents a container for the system calibration. The system calibration corrects for mounting diffe...
Represents a section of output system data. This can be defined by the user to allow for routing data...
Definition: GoWebScanSdkDef.h:494
Represents the Y-orientation of the sensors: Facing Toward (1) or Facing Away (0). The sensor logo and labels are visible when sensors are facing toward.
GoWebScanSystemPlane GoWebScanConfigGroup_Plane(GoWebScanConfigGroup group)
Gets the plane of the group.
GoWebScanConfig GoWebScanConfigGroup_Parent(GoWebScanConfigGroup group)
Gets the configuration of the system that the group is part of.
Represents a container for system-level parameters which are translated from user parameters set in G...
GoWebScanSection * GoWebScanConfigGroup_SectionAt(GoWebScanConfigGroup group, kSSize index)
Gets the section at a specified index in the group's section list.