AGSCoordinateFormatter.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc
 
#import <Foundation/Foundation.h>
#import <ArcGIS/AGSObject.h>
 
 
 
typedef NS_ENUM(NSInteger, AGSGARSConversionMode) {
    AGSGARSConversionModeLowerLeft = 0,     
    AGSGARSConversionModeCenter = 1,        
};
 
typedef NS_ENUM(NSInteger, AGSMGRSConversionMode) {
    AGSMGRSConversionModeAutomatic = 0,         
    AGSMGRSConversionModeNew180InZone01 = 1,    
    AGSMGRSConversionModeNew180InZone60 = 2,    
    AGSMGRSConversionModeOld180InZone01 = 3,    
    AGSMGRSConversionModeOld180InZone60 = 4,    
};
 
typedef NS_ENUM(NSInteger, AGSUTMConversionMode) {
    AGSUTMConversionModeLatitudeBandIndicators = 0, 
    AGSUTMConversionModeNorthSouthIndicators = 1,   
};
 
typedef NS_ENUM(NSInteger, AGSLatitudeLongitudeFormat) {
    AGSLatitudeLongitudeFormatDecimalDegrees = 0,           
    AGSLatitudeLongitudeFormatDegreesDecimalMinutes = 1,    
    AGSLatitudeLongitudeFormatDegreesMinutesSeconds = 2,    
};
 
@class AGSPoint;
@class AGSSpatialReference;
 
@interface AGSCoordinateFormatter : AGSObject
 
#pragma mark -
#pragma mark initializers
 
 
 
#pragma mark -
#pragma mark properties
 
#pragma mark -
#pragma mark methods
 
// Strings to Points
 
+(nullable AGSPoint*)pointFromGARSString:(NSString*)GARSString
                        spatialReference:(nullable AGSSpatialReference*)spatialReference
                          conversionMode:(AGSGARSConversionMode)conversionMode;
 
+(nullable AGSPoint*)pointFromGEOREFString:(NSString*)GEOREFString
                          spatialReference:(nullable AGSSpatialReference*)spatialReference;
 
 
+(nullable AGSPoint*)pointFromLatitudeLongitudeString:(NSString*)latLongString
                                     spatialReference:(nullable AGSSpatialReference*)spatialReference;
 
+(nullable AGSPoint*)pointFromMGRSString:(NSString*)MGRSString
                        spatialReference:(nullable AGSSpatialReference*)spatialReference
                          conversionMode:(AGSMGRSConversionMode)conversionMode;
 
+(nullable AGSPoint*)pointFromUSNGString:(NSString*)USNGString
                        spatialReference:(nullable AGSSpatialReference*)spatialReference;
 
 
 +(nullable AGSPoint*)pointFromUTMString:(NSString*)UTMString
                       spatialReference:(nullable AGSSpatialReference*)spatialReference
                         conversionMode:(AGSUTMConversionMode)conversionMode;
 
// Points to Strings
 
+(nullable NSString*)GARSStringFromPoint:(AGSPoint*)point;
 
 
+(nullable NSString*)GEOREFStringFromPoint:(AGSPoint*)point
                                 precision:(NSInteger)precision;
 
+(nullable NSString*)LatitudeLongitudeStringFromPoint:(AGSPoint*)point
                                               format:(AGSLatitudeLongitudeFormat)format
                                        decimalPlaces:(NSInteger)decimalPlaces;
 
+(nullable NSString*)MGRSStringFromPoint:(AGSPoint*)point
                          conversionMode:(AGSMGRSConversionMode)conversionMode
                               precision:(NSInteger)precision
                               addSpaces:(BOOL)addSpaces;
 
+(nullable NSString*)USNGStringFromPoint:(AGSPoint*)point
                               precision:(NSInteger)precision
                               addSpaces:(BOOL)addSpaces;
 
 
+(nullable NSString*)UTMStringFromPoint:(AGSPoint*)point
                         conversionMode:(AGSUTMConversionMode)conversionMode
                              addSpaces:(BOOL)addSpaces;
 
@end