com.esri.arcgis.geometry
Interface IConversionNotation

All Superinterfaces:

IConversionMGRS, Serializable

All Known Implementing Classes:

Point

public interface IConversionNotation
extends IConversionMGRS, Serializable

Provides access to functions that convert to and from various geographic string notations.

Description

IConversionNotation contains methods for converting both projected and geographic (lat/lon) coordinates to and from various string notations. The notations include United States National Grid (USNG), Universal Transverse Mercator (UTM), GEOREF, and GARS. It's also possible to use decimal degrees, degrees decimal minutes, and degrees minutes seconds.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	getDDFromCoords(int precision) Returns the decimal degrees description of a point.
String	getDDMFromCoords(int precision) Returns the degrees decimal minutes description of a point.
String	getDMSFromCoords(int precision) Returns the degrees/minutes/seconds description of a point.
String	getGARSFromCoords() Returns the GARS description of a point.
String	getGeoRefFromCoords(int numDigits, boolean numericRounding) Returns the GeoRef description of a point.
String	getUSNGFromCoords(int numDigits, boolean numericRounding, boolean addSpaces) Returns the USNG description of a point.
String	getUTMFromCoords(int utmOptions) Returns the UTM description of a point.
void	putCoordsFromDD(String dDString) Creates the coordinates of a point from the decimal degrees description.
void	putCoordsFromDDM(String dDMString) Creates the coordinates of a point from the degrees decimal minutes description.
void	putCoordsFromDMS(String dMSString) Creates the coordinates of a point from the degrees/minutes/seconds description.
void	putCoordsFromGARS(int mode, String gARSString) Creates the coordinates of a point from the GARS description.
void	putCoordsFromGeoRef(String geoRefString) Creates the coordinates of a point from the GeoRef description.
void	putCoordsFromUSNG(String uSNGString) Creates the coordinates of a point from the USNG description.
void	putCoordsFromUTM(int utmOptions, String uTMString) Creates the coordinates of a point from the UTM description.

Methods inherited from interface com.esri.arcgis.geometry.IConversionMGRS

createMGRS, putCoordsFromMGRS

Method Detail

getUSNGFromCoords

String getUSNGFromCoords(int numDigits,
                         boolean numericRounding,
                         boolean addSpaces)
                         throws IOException,
                                AutomationException

Returns the USNG description of a point.

Description

The GetUSNGFromCoords method returns a USNG string. The United States National Grid (USNG) is a simplified version of the Military Grid Reference System (MGRS) and is an alphanumeric way to represent a location. The Point must have a spatial reference that includes a coordinate system. It does not have to a be a geographic coordinate system. The precision parameter controls the length of the string. The sample USNG string below has a precision of 5 which means it is to the closest meter. The geographic coordinates are using the WGS 1984 geographic coordinate system. The first two numbers in the string are the UTM zone number.

latitude = 40.0

longitude = -100.0

USNG = 14TMK1463928236

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

numDigits - The numDigits (in)

numericRounding - The numericRounding (in)

addSpaces - The addSpaces (in)

Returns:

The uSNGString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUTMFromCoords

String getUTMFromCoords(int utmOptions)
                        throws IOException,
                               AutomationException

Returns the UTM description of a point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

utmOptions - A com.esri.arcgis.geometry.esriUTMConversionOptionsEnum constant (in)

Returns:

The uTMString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGARSFromCoords

String getGARSFromCoords()
                         throws IOException,
                                AutomationException

Returns the GARS description of a point.

Description

The GetGARSFromCoords method returns an alphanumeric string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The Global Area Reference System (GARS) is used for military referencing. More information is at http://earth-info.nga.mil/GandG/coordsys/grids/gars.html

longitude = -100.0

latitude = 40.0

GARS = 161LW37

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The gARSString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeoRefFromCoords

String getGeoRefFromCoords(int numDigits,
                           boolean numericRounding)
                           throws IOException,
                                  AutomationException

Returns the GeoRef description of a point.

Description

The GetGeoRefFromCoords method returns an alphanumeric string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The World Geographic Reference System (GEOREF) is used for military referencing. More information is at http://earth-info.nga.mil/GandG/coordsys/grids/referencesys.html.

longitude = -100.0

latitude = 40.0

Georef = FJFL000000 (precision is 3 which determines a location to 0.1 minute)

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

numDigits - The numDigits (in)

numericRounding - The numericRounding (in)

Returns:

The geoRefString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDDFromCoords

String getDDFromCoords(int precision)
                       throws IOException,
                              AutomationException

Returns the decimal degrees description of a point.

Description

The GetDDFromCoords method returns a formatted string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The returned values are in decimal degrees and have direction (hemisphere) information. The precision parameter controls the number of decimal places used in the output values. The sample output below has a precision of 6.

longitude = -100.0
latitude = 40.0
Output = "40.000000N 100.000000W"

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

precision - The precision (in)

Returns:

The dDString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDDMFromCoords

String getDDMFromCoords(int precision)
                        throws IOException,
                               AutomationException

Returns the degrees decimal minutes description of a point.

Description

The GetDDMFromCoords method returns a formatted string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The returned values are in degrees and decimal minutes and have direction (hemisphere) information. The precision parameter controls the number of decimal places used in the output decimal minute values. The sample output below has a precision of 4.

longitude = -100.0
latitude = 40.0
output = "40 00.0000N 100 00.0000W"

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

precision - The precision (in)

Returns:

The dDMString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDMSFromCoords

String getDMSFromCoords(int precision)
                        throws IOException,
                               AutomationException

Returns the degrees/minutes/seconds description of a point.

Description

The GetDMSFromCoords method returns a formatted string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The returned values are in degrees minutes and decimal seconds and have direction (hemisphere) information. The precision parameter controls the number of decimal places used in the output second values. The sample below has a precision of 4.

longitude = -100.0
latitude = 40.0
Output = "40 00 00.0000N 100 00 00.0000W"

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

precision - The precision (in)

Returns:

The dMSString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsFromUSNG

void putCoordsFromUSNG(String uSNGString)
                       throws IOException,
                              AutomationException

Creates the coordinates of a point from the USNG description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

uSNGString - The uSNGString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsFromUTM

void putCoordsFromUTM(int utmOptions,
                      String uTMString)
                      throws IOException,
                             AutomationException

Creates the coordinates of a point from the UTM description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

utmOptions - A com.esri.arcgis.geometry.esriUTMConversionOptionsEnum constant (in)

uTMString - The uTMString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsFromGARS

void putCoordsFromGARS(int mode,
                       String gARSString)
                       throws IOException,
                              AutomationException

Creates the coordinates of a point from the GARS description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

mode - A com.esri.arcgis.geometry.esriGARSModeEnum constant (in)

gARSString - The gARSString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsFromGeoRef

void putCoordsFromGeoRef(String geoRefString)
                         throws IOException,
                                AutomationException

Creates the coordinates of a point from the GeoRef description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

geoRefString - The geoRefString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsFromDD

void putCoordsFromDD(String dDString)
                     throws IOException,
                            AutomationException

Creates the coordinates of a point from the decimal degrees description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

dDString - The dDString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsFromDDM

void putCoordsFromDDM(String dDMString)
                      throws IOException,
                             AutomationException

Creates the coordinates of a point from the degrees decimal minutes description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

dDMString - The dDMString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoordsFromDMS

void putCoordsFromDMS(String dMSString)
                      throws IOException,
                             AutomationException

Creates the coordinates of a point from the degrees/minutes/seconds description.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

dMSString - The dMSString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.