AGSAngularUnit Class Reference

Description

Defines an angular unit of measurement.

The angular unit class is derived from AGSUnit.

See also

AGSUnit

Since

100

Inheritance diagram for AGSAngularUnit:

Instance Methods
(double)	- convert:fromUnit:
(double)	- convert:toUnit:
(double)	- convertFromRadians:
(double)	- convertToRadians:
(nullable instancetype)	- initWithUnitID:
(BOOL)	- isEqualToUnit:

Class Methods
(instancetype)	+ degrees
(instancetype)	+ radians
(nullable instancetype)	+ unitWithUnitID:
(nullable instancetype)	+ unitWithWKID:

Properties
NSString *	abbreviation
NSString *	displayName
NSString *	name
NSString *	pluralDisplayName
AGSAngularUnitID	unitID
NSInteger	WKID

Method Documentation

convert:fromUnit:

- (double) convert:		(double)	value
fromUnit:		(AGSAngularUnit *)	fromUnit

Converts the value from the specified angular 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)	angle
toUnit:		(AGSAngularUnit *)	toUnit

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

Parameters

angle	The angle value to convert.
toUnit	The units the converted value needs to be in.

Since

100

convertFromRadians:

- (double) convertFromRadians:

(double)

radians

Converts the value from radians into this unit.

Parameters

radians

The radians value to convert

Since

100

convertToRadians:

- (double) convertToRadians:

(double)

angle

Converts the value from this unit to radians.

Parameters

angle

The angle value to convert.

Since

100

degrees

+ (instancetype) degrees

An angular unit representing degrees.

Since

100

initWithUnitID:

- (nullable instancetype) initWithUnitID:

(AGSAngularUnitID)

unitID

Creates an angular unit.

Parameters

unitID

The angular unit ID of the unit.

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

radians

+ (instancetype) radians

An angular unit representing radians.

Since

100

unitWithUnitID:

+ (nullable instancetype) unitWithUnitID:

(AGSAngularUnitID)

unitID

Creates an angular unit.

Parameters

unitID

The angular unit ID of the unit.

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

WKID	The 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

- (AGSAngularUnitID) unitID

readnonatomicassign

WKID

- (NSInteger) WKID

readnonatomicassigninherited

The well-known ID for the unit, or 0 for a custom unit.

Since

100.14