GoWebScan API
GoWebScanSettingsGroup Class Reference

Description

Represents a container for user-configurable settings of a group within the system. Groups represent planes (top or bottom).

Inheritance diagram for GoWebScanSettingsGroup:
Inheritance graph

Public Member Functions

kStatus GoWebScanSettingsGroup_AddSection (GoWebScanSettingsGroup group, const GoWebScanSection *section)
 Adds a section to the group. More...
 
kStatus GoWebScanSettingsGroup_AddSensor (GoWebScanSettingsGroup group, GoWebScanSettingsSensor sensor)
 Adds a sensor, as defined by a GoWebScanSettingsSensor object, to the group. More...
 
kStatus GoWebScanSettingsGroup_ClearSections (GoWebScanSettingsGroup group)
 Clears all sections from the list. More...
 
kStatus GoWebScanSettingsGroup_ClearSensors (GoWebScanSettingsGroup group)
 Clears and disposes all sensors from the group. More...
 
kStatus GoWebScanSettingsGroup_Construct (GoWebScanSettingsGroup *group, GoWebScanSettings parent, kAlloc allocator)
 Constructs a GoWebScanSettingsGroup object. More...
 
GoWebScanSettings GoWebScanSettingsGroup_Parent (GoWebScanSettingsGroup group)
 Gets the settings of the system the group is in. More...
 
GoWebScanSystemPlane GoWebScanSettingsGroup_Plane (GoWebScanSettingsGroup group)
 Gets the system plane of a group. More...
 
kStatus GoWebScanSettingsGroup_RemoveSection (GoWebScanSettingsGroup group, kSize index)
 Removes a section from the group. More...
 
GoWebScanSectionGoWebScanSettingsGroup_SectionAt (GoWebScanSettingsGroup group, kSize index)
 Gets a pointer to the section at a specified index. More...
 
kSize GoWebScanSettingsGroup_SectionCount (GoWebScanSettingsGroup group)
 Gets the number of sections defined for the group. More...
 
k32s GoWebScanSettingsGroup_SectionId (GoWebScanSettingsGroup group, kSize index)
 Gets the section ID. More...
 
k32s GoWebScanSettingsGroup_SectionType (GoWebScanSettingsGroup group, kSize index)
 Gets the section type. More...
 
k32s GoWebScanSettingsGroup_SectionX0 (GoWebScanSettingsGroup group, kSize index)
 Gets the start of section along the X-axis (length), in system coordinates (mils). More...
 
k32s GoWebScanSettingsGroup_SectionX1 (GoWebScanSettingsGroup group, kSize index)
 Gets the end of section along the X-axis (length), in system coordinates (mils). More...
 
GoWebScanSettingsSensor GoWebScanSettingsGroup_SensorAt (GoWebScanSettingsGroup group, kSize index)
 Gets the GoWebScanSettingsSensor object representing a sensor at a specified index in the group. More...
 
kSize GoWebScanSettingsGroup_SensorCount (GoWebScanSettingsGroup group)
 Gets the number of sensors in the group. More...
 
kStatus GoWebScanSettingsGroup_SetPlane (GoWebScanSettingsGroup group, GoWebScanSystemPlane plane)
 Sets the system plane for the group. More...
 
kStatus GoWebScanSettingsGroup_SetSectionId (GoWebScanSettingsGroup group, kSize index, k32s value)
 Sets the section ID. More...
 
kStatus GoWebScanSettingsGroup_SetSectionType (GoWebScanSettingsGroup group, kSize index, k32s value)
 Sets the section type. More...
 
kStatus GoWebScanSettingsGroup_SetSectionX0 (GoWebScanSettingsGroup group, kSize index, k32s value)
 Sets the start of section along the X-axis (length), in system coordinates (mils). More...
 
kStatus GoWebScanSettingsGroup_SetSectionX1 (GoWebScanSettingsGroup group, kSize index, k32s value)
 Sets the end of section along the X-axis (length), in system coordinates (mils). More...
 
kStatus GoWebScanSettingsGroup_SetSensorCount (GoWebScanSettingsGroup group, kSize count)
 Sets the number of sensors in the group. More...
 

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