AGSAreaUnit.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, AGSAreaUnitID) {
    AGSAreaUnitIDAcres = 109402,                
    AGSAreaUnitIDHectares = 109401,             
    AGSAreaUnitIDSquareCentimeters = 109451,    
    AGSAreaUnitIDSquareDecimeters = 109450,     
    AGSAreaUnitIDSquareFeet = 109405,           
    AGSAreaUnitIDSquareKilometers = 109414,     
    AGSAreaUnitIDSquareMeters = 109404,         
    AGSAreaUnitIDSquareMillimeters = 109452,    
    AGSAreaUnitIDSquareMiles = 109439,          
    AGSAreaUnitIDSquareYards = 109442,          
    AGSAreaUnitIDOther = 0                      
};

@class AGSLinearUnit;

@interface AGSAreaUnit : AGSUnit

#pragma mark -
#pragma mark initializers



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

-(nullable instancetype)initWithLinearUnit:(AGSLinearUnit*)linearUnit;

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

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

+(nullable instancetype)areaUnitWithLinearUnit:(AGSLinearUnit*)linearUnit;

+(instancetype)squareFeet;

+(instancetype)squareMeters;

+(instancetype)squareMiles;

+(instancetype)squareKilometers;

#pragma mark -
#pragma mark properties

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

#pragma mark -
#pragma mark methods

-(nullable AGSLinearUnit*)toLinearUnit;

-(double)convertToSquareMeters:(double)area;

-(double)convertFromSquareMeters:(double)area;

-(double)convert:(double)area toUnit:(AGSAreaUnit*)toUnit;

-(double)convert:(double)area fromUnit:(AGSAreaUnit*)fromUnit;

@end