GoWebScanConfigGroup Class Reference

Description

Represents a container for group-level parameters which are translated from user parameters set in GoWebScanSettings. This class contains properties describing the group orientation, and contains a list of sensor configuration objects. This class is intended to be constructed from within a GoWebScanConfig object.

GoWebScanConfig organizes the configuration at the system, group, sensor, and node levels. Configuration of the groups within the system are represented by the GoWebScanConfigGroup class, sensors by the GoWebScanConfigSensor class, and nodes by the GoWebScanConfigNode class. GoWebScanConfig will construct and own these classes.

Inheritance diagram for GoWebScanConfigGroup:

Public Member Functions
kStatus	GoWebScanConfigGroup_Construct (GoWebScanConfigGroup *group, GoWebScanConfig config, GoWebScanSettingsGroup settingsGroup, GoWebScanCal calibration, kArrayList sensorInfo, kAlloc allocator)
	Constructs a GoWebScanConfigGroup object. More...
kSSize	GoWebScanConfigGroup_MaxNodeColumn (GoWebScanConfigGroup group)
	Gets the maximum node column ID within this group. More...
GoWebScanConfigNode	GoWebScanConfigGroup_NodeAt (GoWebScanConfigGroup group, kSSize index)
	Gets the configuration of a node at a specified index in the group. More...
kSSize	GoWebScanConfigGroup_NodeCount (GoWebScanConfigGroup group)
	Gets the count of nodes in this group. More...
GoWebScanConfig	GoWebScanConfigGroup_Parent (GoWebScanConfigGroup group)
	Gets the configuration of the system that the group is part of. More...
GoWebScanSystemPlane	GoWebScanConfigGroup_Plane (GoWebScanConfigGroup group)
	Gets the plane of the group. More...
GoWebScanSection *	GoWebScanConfigGroup_SectionAt (GoWebScanConfigGroup group, kSSize index)
	Gets the section at a specified index in the group's section list. More...
kSSize	GoWebScanConfigGroup_SectionCount (GoWebScanConfigGroup group)
	Gets the count of sections defined for this group. More...
GoWebScanConfigSensor	GoWebScanConfigGroup_SensorAt (GoWebScanConfigGroup group, kSSize index)
	Gets the configuration of a sensor at a specified index in the group. More...
kSSize	GoWebScanConfigGroup_SensorCount (GoWebScanConfigGroup group)
	Gets the count of sensors in this group. More...
kStatus	GoWebScanConfigGroup_UpdateCalibration (GoWebScanConfigGroup group, GoWebScanCal calibration)
	Update the calibration for this group. More...
GoWebScanYOrientation	GoWebScanConfigGroup_YOrientation (GoWebScanConfigGroup group)
	Gets the Y-orientation of the group. More...
GoWebScanSystemPlane	GoWebScanConfigGroup_ZOrientation (GoWebScanConfigGroup group)
	Gets the Z-orientation of the group (same as the group's plane). More...

---

The documentation for this class was generated from the following file:

• GoWebScanConfigGroup.h