DLSDisplaySettings Class

Inherits from

GEOCALCPBW_NAMESPACE::GeoBase

 

Description

The DLSDisplaySettings class is used for applying and retrieving settings to convert between DLS grid coordinate values.  These values are strings that reference a defining Meridian, Township, Range, Section, referencing position and offset.  A Legal Subdivision can also be determined from the primary defining values.

 

Public Enumerations

Enum

Description

DLSDataVersion

Identifies the version and Datum for the current DLS system

DLSRoadAllowanceHandling

Specifies how the road allowance offsets are handled

DLSDisplayOrder

Specifies the display method used for the point identification

DLSDisplayUnits

Specifies the units used for the current DLS system

DLSDescriptionFormat

Specified whether the offsets are from section boundaries or the nearest section corner.

 

Public Constructors

Constructor

Description

DLSDisplaySettings

Creates a new instance of the DLSDisplaySettings class

CreateDLSDisplaySettings

Creates a new instance of the DLSDisplaySettings class

 

Public Methods

Method

Description

get_DisplayOrder

Returns an enum indicating the Display order user for the current ATS

get_DisplayUnits

Returns an enum indicating the units used for current ATS offsets

get_Format

Returns the DLSDescriptionFormat of this DisplaySettings object

get_OverrideAllowanceToEast

Returns a default Easting road allowance offset value

get_OverrideAllowanceToNorth

Returns a default Northing road allowance offset value

get_PointDataVersion

Returns an enum that indicates the current Grid version and Datum

get_RoadAllowanceHandling

Returns an enum value indicating how road allowances are handled

set_DisplayOrder

Specifies the Display order user for the current ATS

set_DisplayUnits

Specifies the units used for current ATS offsets

set_Format

Sets the DLSDescriptionFormat of this DisplaySettings object

set_OverrideAllowanceToEast

Specifies a default Easting road allowance offset value

set_OverrideAllowanceToNorth

Specifies a default Northing road allowance offset value

set_PointDataVersion

Specifies the current Grid version and Datum

set_RoadAllowanceHandling

Specifies how road allowances are handled

HasFormatAvailable

Indicates whether the point data files for the specified version is available for use.

RetrieveSettings

Populates the settings from the specified StringPointTranslator's parameters.

ApplySettings

Assigns the settings to the specified StringPointTranslator's parameters.

DataVersionAsString

Returns the DLS data version string representation from its enumerated value.

GetSectionRecords

Returns the DLSSectionRecord of the specified StringPointTranslator according to the description of the record passed in.

GetMBRSectionRecords

Returns the MBRSectionRecord of the specified StringPointTranslator according to the SW and NE corners passed in.