Defines a linear unit of measurement.
AGSLinearUnit
is derived from AGSUnit
.
- Since
- 100
◆ convert:fromUnit:
- (double) convert: |
|
(double) |
value |
fromUnit: |
|
(AGSLinearUnit *) |
fromUnit |
|
|
| |
Converts the value from the specified linear unit into this unit.
- Parameters
-
value | The value to convert. |
fromUnit | The units the given value is already in. |
- Since
- 100
◆ convert:toUnit:
- (double) convert: |
|
(double) |
value |
toUnit: |
|
(AGSLinearUnit *) |
toUnit |
|
|
| |
Converts the value from this unit to the specified linear unit.
- Parameters
-
value | The value to convert. |
toUnit | The units the converted value needs to be in. |
- Since
- 100
◆ convertFromMeters:
- (double) convertFromMeters: |
|
(double) |
meters |
|
Converts the value from meters into this unit.
- Parameters
-
meters | The meters value to convert |
- Since
- 100
◆ convertToMeters:
- (double) convertToMeters: |
|
(double) |
value |
|
Converts the value from this unit to meters.
- Parameters
-
value | The value to convert. |
- Since
- 100
◆ feet
A linear unit representing feet.
- Since
- 100
◆ initWithAreaUnit:
- (nullable instancetype) initWithAreaUnit: |
|
(AGSAreaUnit *) |
areaUnit |
|
Creates a linear unit from an AGSAreaUnit
.
- Parameters
-
areaUnit | The area unit used to create a linear unit. |
- Since
- 100
◆ initWithUnitID:
Creates a linear unit.
- Parameters
-
unitID | The linear unit ID. |
- Since
- 100
◆ isEqualToUnit:
- (BOOL) isEqualToUnit: |
|
(AGSUnit *) |
unit |
|
Compares whether two units are equal.
- Parameters
-
unit | to compare this one to |
- Returns
- YES if the units are equal
- Since
- 100
◆ kilometers
+ (instancetype) kilometers |
|
|
|
A linear unit representing kilometers.
- Since
- 100
◆ linearUnitWithAreaUnit:
+ (nullable instancetype) linearUnitWithAreaUnit: |
|
(AGSAreaUnit *) |
areaUnit |
|
Creates a linear unit from an AGSAreaUnit
.
- Parameters
-
areaUnit | The area unit used to create a linear unit. |
- Since
- 100
◆ meters
A linear unit representing meters.
- Since
- 100
◆ miles
A linear unit representing miles.
- Since
- 100
◆ toAreaUnit
Returns the corresponding area unit for this linear unit.
- Since
- 100
◆ unitWithUnitID:
Creates a linear unit.
- Parameters
-
unitID | The linear unit ID. |
- Since
- 100
◆ unitWithWKID:
+ (nullable instancetype) unitWithWKID: |
|
(NSInteger) |
WKID |
|
Creates 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 AGSLinearUnitID
enumeration.
- Parameters
-
WKID | The well-known ID of the unit. |
- Since
- 100.7
◆ 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
|
readnonatomiccopyinherited |
The name of the measurement unit.
- Since
- 100
◆ pluralDisplayName
- (NSString*) pluralDisplayName |
|
readnonatomiccopyinherited |
A plural form of the user-friendly name.
- Since
- 100
◆ unitID
The unit ID of the linear unit.
If an error occurs then the unit ID is AGSLinearUnitIDOther
.
- Since
- 100.0
◆ WKID
|
readnonatomicassigninherited |
The well-known ID for the unit, or 0
for a custom unit.
- Since
- 100.14