ArcGIS Runtime SDK for iOS: AGSAreaUnit Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSAreaUnit Class Reference

Description

Defines an area unit of measurement.

The area unit class is derived from AGSUnit.

Since
100
Inheritance diagram for AGSAreaUnit:
AGSUnit AGSObject

Instance Methods

(double) - convert:fromUnit:
 
(double) - convert:toUnit:
 
(double) - convertFromSquareMeters:
 
(double) - convertToSquareMeters:
 
(nullable instancetype) - initWithLinearUnit:
 
(nullable instancetype) - initWithUnitID:
 
(BOOL) - isEqualToUnit:
 
(nullable AGSLinearUnit *) - toLinearUnit
 

Class Methods

(nullable instancetype) + areaUnitWithLinearUnit:
 
(instancetype) + squareFeet
 
(instancetype) + squareKilometers
 
(instancetype) + squareMeters
 
(instancetype) + squareMiles
 
(nullable instancetype) + unitWithUnitID:
 
(nullable instancetype) + unitWithWKID:
 

Properties

NSString * abbreviation
 
NSString * displayName
 
NSString * name
 
NSString * pluralDisplayName
 
AGSAreaUnitID unitID
 

Method Documentation

◆ areaUnitWithLinearUnit:

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

Initializes an area unit from the corresponding linear unit.

Parameters
linearUnitThe linear unit that you want to create an area unit from.
Since
100

◆ convert:fromUnit:

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

Converts the value from the specified area unit into this unit.

Parameters
areato convert
fromUnitThe units the given value is already in.
Since
100

◆ convert:toUnit:

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

Converts the value from this unit to the specified area unit.

Parameters
areato convert.
toUnitThe units the converted value needs to be in
Since
100

◆ convertFromSquareMeters:

- (double) convertFromSquareMeters: (double)  area

Converts the value from sq. meters into this unit.

Parameters
areato convert
Since
100

◆ convertToSquareMeters:

- (double) convertToSquareMeters: (double)  area

Converts the value from this unit to sq. meters.

Parameters
areato convert.
Since
100

◆ initWithLinearUnit:

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

Initializes an area unit from the corresponding linear unit.

Parameters
linearUnitThe linear unit that you want to create an area unit from.
Since
100

◆ initWithUnitID:

- (nullable instancetype) initWithUnitID: (AGSAreaUnitID unitID

Initializes an area unit.

Parameters
unitIDarea unit ID
Since
100

◆ isEqualToUnit:

- (BOOL) isEqualToUnit: (AGSUnit *)  unit

Compares whether two units are equal.

Parameters
unitto compare this one to
Returns
YES if the units are equal
Since
100

◆ squareFeet

+ (instancetype) squareFeet

An area unit representing sq. feet

Since
100

◆ squareKilometers

+ (instancetype) squareKilometers

An area unit representing sq. kilometers

Since
100

◆ squareMeters

+ (instancetype) squareMeters

An area unit representing sq. meters

Since
100

◆ squareMiles

+ (instancetype) squareMiles

An area unit representing sq. miles

Since
100

◆ toLinearUnit

- (nullable AGSLinearUnit*) toLinearUnit

Returns the corresponding linear unit for this area unit.

Since
100

◆ unitWithUnitID:

+ (nullable instancetype) unitWithUnitID: (AGSAreaUnitID unitID

Initializes an area unit.

Parameters
unitIDarea unit ID
Since
100

◆ unitWithWKID:

+ (nullable instancetype) unitWithWKID: (NSInteger)  WKID

Create a unit with the given well-known ID (WKID). This allows you to create a unit from a WKID that is not in the associated UnitID enumeration.

Parameters
WKIDThe well-known ID of the unit
Since
100.7

Property Documentation

◆ abbreviation

- (NSString*) abbreviation
readnonatomiccopyinherited

Abbreviated name of the unit.

Since
100

◆ displayName

- (NSString*) displayName
readnonatomiccopyinherited

A user-friendly name of the measurement unit.

Since
100

◆ name

- (NSString*) name
readnonatomiccopyinherited

The name of the measurement unit.

Since
100

◆ pluralDisplayName

- (NSString*) pluralDisplayName
readnonatomiccopyinherited

A plural form of the user-friendly name.

Since
100

◆ unitID

- (AGSAreaUnitID) unitID
readnonatomicassign