AGSLinearUnit.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 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 <ArcGIS/AGSUnit.h>



typedef NS_ENUM(NSInteger, AGSLinearUnitID) {
    AGSLinearUnitIDCentimeters = 1033,      
    AGSLinearUnitIDFeet = 9002,             
    AGSLinearUnitIDInches = 109008,         
    AGSLinearUnitIDKilometers = 9036,       
    AGSLinearUnitIDMeters = 9001,           
    AGSLinearUnitIDMiles = 9093,            
    AGSLinearUnitIDMillimeters = 1025,      
    AGSLinearUnitIDNauticalMiles = 9030,    
    AGSLinearUnitIDYards = 9096,            
    AGSLinearUnitIDOther = 0                
};

@class AGSAreaUnit;

@interface AGSLinearUnit : AGSUnit

#pragma mark -
#pragma mark initializers



-(nullable instancetype)initWithUnitID:(AGSLinearUnitID)unitID;

+(nullable instancetype)unitWithUnitID:(AGSLinearUnitID)unitID;

+(nullable instancetype)unitWithWKID:(NSInteger)WKID;

-(nullable instancetype)initWithAreaUnit:(AGSAreaUnit*)areaUnit;

+(nullable instancetype)linearUnitWithAreaUnit:(AGSAreaUnit*)areaUnit;

+(instancetype)meters;

+(instancetype)feet;

+(instancetype)miles;

+(instancetype)kilometers;

#pragma mark -
#pragma mark properties

@property (nonatomic, assign, readonly) AGSLinearUnitID unitID;

#pragma mark -
#pragma mark methods

-(nullable AGSAreaUnit*)toAreaUnit;

-(double)convertToMeters:(double)value;

-(double)convertFromMeters:(double)meters;

-(double)convert:(double)value toUnit:(AGSLinearUnit*)toUnit;

-(double)convert:(double)value fromUnit:(AGSLinearUnit*)fromUnit;

@end