GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanConfigSensor.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanConfigSensor.h
3 * @brief Declares a GoWebScanConfigSensor 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_SENSOR_H
12 #define GO_WEB_SCAN_CONFIG_SENSOR_H
13 
19 #include <GoSdk/GoSdk.h>
20 
21 kBeginHeader()
22 
23 /**
24 * @class GoWebScanConfigSensor
25 * @extends kObject
26 * @ingroup GoWebScanSdk-Config
27 * @brief Represents a container for sensor-level parameters which are translated from user
28 * parameters set in GoWebScanSettings. This class contains properties describing
29 * the sensor orientation and contains a list of node configuration objects. In
30 * systems with vision sensors, this class represents a profile-vision sensor pair
31 * (sensors mounted together). This class is intended to be constructed from
32 * within a GoWebScanConfig object.
33 *
34 * GoWebScanConfig organizes the configuration at the system, group, sensor, and node
35 * levels. Configuration of the groups within the system are represented by the
36 * GoWebScanConfigGroup class, sensors by the GoWebScanConfigSensor class, and nodes
37 * by the GoWebScanConfigNode class. GoWebScanConfig will construct and own these
38 * classes.
39 */
41 
42 // Forward declarations
43 typedef kObject GoWebScanConfig;
46 
47 /**
48  * Constructs a GoWebScanConfigSensor object.
49  *
50  * @public @memberof GoWebScanConfigSensor
51  * @param sensor Receives the constructed GoWebScanConfigSensor object.
52  * @param group Parent group configuration.
53  * @param settingsSensor User settings for the sensor.
54  * @param index Index of sensor in group.
55  * @param calibration System calibration. Set to kNULL if running system uncalibrated or if
56  * running system calibration.
57  * @param sensorInfo List of GoWebScanConfigSensorInfo structs representing information
58  * from each sensor in the system.
59  * @param allocator Memory allocator (or kNULL for default).
60  * @return Operation status.
61  */
62 GoWebScanFx(kStatus) GoWebScanConfigSensor_Construct(GoWebScanConfigSensor* sensor, GoWebScanConfigGroup group, GoWebScanSettingsSensor settingsSensor,
63  kSize index, GoWebScanCal calibration, const GoWebScanConfigSensorInfo* sensorInfo, kAlloc allocator);
64 
65 /**
66 * Gets the configuration of the group that the sensor is part of.
67 *
68 * @public @memberof GoWebScanConfigSensor
69 * @param sensor GoWebScanConfigSensor object.
70 * @return GoWebScanConfigGroup object representing group configuration.
71 */
72 GoWebScanFx(GoWebScanConfigGroup) GoWebScanConfigSensor_Parent(GoWebScanConfigSensor sensor);
73 
74 /**
75  * Gets the serial number of the sensor. In systems with vision sensors, this is the profile
76  * sensor's ID.
77  *
78  * @public @memberof GoWebScanConfigSensor
79  * @param sensor GoWebScanConfigSensor object.
80  * @return Profile sensor ID.
81  */
82 GoWebScanFx(k32s) GoWebScanConfigSensor_ProfileId(GoWebScanConfigSensor sensor);
83 
84 /**
85  * Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with
86  * vision). For systems without vision, this will return GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER.
87  *
88  * @public @memberof GoWebScanConfigSensor
89  * @param sensor GoWebScanConfigSensor object.
90  * @return Vision sensor ID.
91  */
92 GoWebScanFx(k32s) GoWebScanConfigSensor_VisionId(GoWebScanConfigSensor sensor);
93 
94 /**
95 * Gets the plane of the group the sensor is part of.
96 *
97 * @public @memberof GoWebScanConfigSensor
98 * @param sensor GoWebScanConfigSensor object.
99 * @return Plane of group sensor is located in.
100 */
101 GoWebScanFx(k32s) GoWebScanConfigSensor_Plane(GoWebScanConfigSensor sensor);
102 
103 /**
104  * Gets the sensor column within group. Each sensor resides in a particular sensor column
105  * within the group. The columns increase left-to-right or right-to-left based on the X
106  * orientation. The column includes disabled/missing devices.
107  *
108  * @public @memberof GoWebScanConfigSensor
109  * @param sensor GoWebScanConfigSensor object.
110  * @return Sensor column.
111  */
112 GoWebScanFx(kSSize) GoWebScanConfigSensor_Column(GoWebScanConfigSensor sensor);
113 
114 /**
115  * Gets the sensor index within group (excludes disabled/missing devices).
116  *
117  * @public @memberof GoWebScanConfigSensor
118  * @param sensor GoWebScanConfigSensor object.
119  * @return Sensor index.
120  */
121 GoWebScanFx(kSSize) GoWebScanConfigSensor_Index(GoWebScanConfigSensor sensor);
122 
123 /**
124  * Gets the X-orientation of the sensor. Normal (1) or opposite (0). Normal is defined as sensor
125  * X-axis aligned to the system X-axis in standard orientation (Refer to GoWebScanConfig for
126 * a description of standard orientation).
127  *
128  * @public @memberof GoWebScanConfigSensor
129  * @param sensor GoWebScanConfigSensor object.
130  * @return Sensor X-orientation.
131  * @see GoWebScanConfig
132  */
133 GoWebScanFx(k32s) GoWebScanConfigSensor_XOrientation(GoWebScanConfigSensor sensor);
134 
135 /**
136  * Gets the Y-orientation of the sensor. Normal (1) or opposite (0). Normal is defined as sensor
137  * Y-axis opposite to the system Y-axis in standard orientation (Refer to GoWebScanConfig for
138 * a description of standard orientation).
139  *
140  * @public @memberof GoWebScanConfigSensor
141  * @param sensor GoWebScanConfigSensor object.
142  * @return Sensor Y-orientation.
143  * @see GoWebScanConfig
144  */
145 GoWebScanFx(k32s) GoWebScanConfigSensor_YOrientation(GoWebScanConfigSensor sensor);
146 
147 /**
148  * Gets the Z-orientation of the sensor. Normal (1) or opposite (0). Normal is defined as sensor
149  * Z-axis opposite to the system Z-axis in standard orientation (Refer to GoWebScanConfig for
150 * a description of standard orientation).
151  *
152  * @public @memberof GoWebScanConfigSensor
153  * @param sensor GoWebScanConfigSensor object.
154  * @return Sensor Z-orientation.
155  * @see GoWebScanConfig
156  */
157 GoWebScanFx(k32s) GoWebScanConfigSensor_ZOrientation(GoWebScanConfigSensor sensor);
158 
159 /**
160 * Gets the sensor calibration-edge-orientation: Normal (1) or opposite (0).
161 *
162 * @public @memberof GoWebScanConfigSensor
163 * @param sensor GoWebScanConfigSensor object.
164 * @return Sensor calibration edge orientation.
165 */
166 GoWebScanFx(k32s) GoWebScanConfigSensor_EOrientation(GoWebScanConfigSensor sensor);
167 
168 /**
169 * Gets the count of nodes in the sensor.
170 *
171 * @public @memberof GoWebScanConfigSensor
172 * @param sensor GoWebScanConfigSensor object.
173 * @return Sensor's node count.
174 */
175 GoWebScanFx(kSSize) GoWebScanConfigSensor_NodeCount(GoWebScanConfigSensor sensor);
176 
177 /**
178 * Gets the configuration of a node at a specified index in the sensor.
179 *
180 * @public @memberof GoWebScanConfigSensor
181 * @param sensor GoWebScanConfigSensor object.
182 * @param index Node index.
183 * @return Node configuration.
184 */
185 GoWebScanFx(GoWebScanConfigNode) GoWebScanConfigSensor_NodeAt(GoWebScanConfigSensor sensor, kSSize index);
186 
187 /**
188 * Gets the list of obstructions defined for the sensor.
189 *
190 * @public @memberof GoWebScanConfigSensor
191 * @param sensor GoWebScanConfigSensor object.
192 * @return List of obstructions. Type GoWebScanObstruction.
193 */
194 GoWebScanFx(kArrayList) GoWebScanConfigSensor_Obstructions(GoWebScanConfigSensor sensor);
195 
196 kEndHeader()
197 #include <GoWebScanSdk/GoWebScanConfigSensor.x.h>
198 
199 #endif
Represents a container for node-level parameters which are translated from user parameters set in GoW...
GoWebScanConfigNode GoWebScanConfigSensor_NodeAt(GoWebScanConfigSensor sensor, kSSize index)
Gets the configuration of a node at a specified index in the sensor.
GoWebScanConfigGroup GoWebScanConfigSensor_Parent(GoWebScanConfigSensor sensor)
Gets the configuration of the group that the sensor is part of.
kStatus GoWebScanConfigSensor_Construct(GoWebScanConfigSensor *sensor, GoWebScanConfigGroup group, GoWebScanSettingsSensor settingsSensor, kSize index, GoWebScanCal calibration, const GoWebScanConfigSensorInfo *sensorInfo, kAlloc allocator)
Constructs a GoWebScanConfigSensor object.
Essential GoWebScan declarations.
Represents information from each sensor in the system, collected and provided by the user application...
Definition: GoWebScanConfig.h:77
k32s GoWebScanConfigSensor_YOrientation(GoWebScanConfigSensor sensor)
Gets the Y-orientation of the sensor.
Represents a container for sensor-level parameters which are translated from user parameters set in G...
Represents a container for group-level parameters which are translated from user parameters set in Go...
Declares a GoWebScanCal object.
kSSize GoWebScanConfigSensor_Index(GoWebScanConfigSensor sensor)
Gets the sensor index within group (excludes disabled/missing devices).
k32s GoWebScanConfigSensor_XOrientation(GoWebScanConfigSensor sensor)
Gets the X-orientation of the sensor.
kSSize GoWebScanConfigSensor_Column(GoWebScanConfigSensor sensor)
Gets the sensor column within group.
kSSize GoWebScanConfigSensor_NodeCount(GoWebScanConfigSensor sensor)
Gets the count of nodes in the sensor.
kArrayList GoWebScanConfigSensor_Obstructions(GoWebScanConfigSensor sensor)
Gets the list of obstructions defined for the sensor.
k32s GoWebScanConfigSensor_EOrientation(GoWebScanConfigSensor sensor)
Gets the sensor calibration-edge-orientation: Normal (1) or opposite (0).
k32s GoWebScanConfigSensor_ProfileId(GoWebScanConfigSensor sensor)
Gets the serial number of the sensor.
k32s GoWebScanConfigSensor_ZOrientation(GoWebScanConfigSensor sensor)
Gets the Z-orientation of the sensor.
Declares a GoWebScanProcess object.
Represents a container for the system calibration. The system calibration corrects for mounting diffe...
k32s GoWebScanConfigSensor_Plane(GoWebScanConfigSensor sensor)
Gets the plane of the group the sensor is part of.
Represents a container for user-configurable settings of a sensor within the system. For systems with vision, a GoWebScanSettingsSensor object represents a pair of vision and profile sensors (sensor mounted together).
k32s GoWebScanConfigSensor_VisionId(GoWebScanConfigSensor sensor)
Gets the serial number of the vision sensor in a profile-vision sensor pair (for systems with vision)...
Declares a GoWebScanConfigGroup object.
Represents a container for system-level parameters which are translated from user parameters set in G...
Declares a GoWebScanConfig object.