AGSGeoprocessingLinearUnit Class Reference

Description

A geoprocessing parameter for linear distances.

Instances of this class represent a parameter for linear distances that can be used as input to a geoprocessing job or returned as the result of the job.

Since

100

Inheritance diagram for AGSGeoprocessingLinearUnit:

Instance Methods
(instancetype)	- initWithDistance:
(instancetype)	- initWithDistance:geoprocessingLinearUnit:
(instancetype)	- initWithDistance:linearUnit:
(instancetype)	- initWithDistance:unitID:
(AGSLinearUnit *)	- linearUnit

Class Methods
(instancetype)	+ geoprocessingLinearUnit
(instancetype)	+ geoprocessingLinearUnitWithDistance:
(instancetype)	+ geoprocessingLinearUnitWithDistance:geoprocessingUnit:
(instancetype)	+ geoprocessingLinearUnitWithDistance:linearUnit:
(instancetype)	+ geoprocessingLinearUnitWithDistance:unitID:
(instancetype)	+ geoprocessingParameter

Properties
double	distance
AGSGeoprocessingLinearUnits	geoprocessingLinearUnit
AGSGeoprocessingParameterType	type

Method Documentation

geoprocessingLinearUnit

+ (instancetype) geoprocessingLinearUnit

geoprocessingLinearUnitWithDistance:

+ (instancetype) geoprocessingLinearUnitWithDistance:

(double)

distance

Intialize this parameter with the given distance value

Parameters

distance

value

Since

100

geoprocessingLinearUnitWithDistance:geoprocessingUnit:

+ (instancetype) geoprocessingLinearUnitWithDistance:		(double)	distance
geoprocessingUnit:		(AGSGeoprocessingLinearUnits)	geoprocessingUnit

Intialize this parameter with the given distance value

Parameters

distance	value
geoprocessingUnit	specifying unit of measurement for the distance value

Since

100

geoprocessingLinearUnitWithDistance:linearUnit:

+ (instancetype) geoprocessingLinearUnitWithDistance:		(double)	distance
linearUnit:		(AGSLinearUnit *)	linearUnit

Intialize this parameter with the given distance value

Parameters

distance	value
linearUnit	specifying unit of measurement for the distance value

Since

100

geoprocessingLinearUnitWithDistance:unitID:

+ (instancetype) geoprocessingLinearUnitWithDistance:		(double)	distance
unitID:		(AGSLinearUnitID)	unitID

Intialize this parameter with the given distance value

Parameters

distance	value
unitID	specifying unit of measurement for the distance value

Since

100

geoprocessingParameter

+ (instancetype) geoprocessingParameter

Deprecated:

100.9. Do not use this method, it creates an invalid and incomplete object.

initWithDistance:

- (instancetype) initWithDistance:

(double)

distance

Intialize this parameter with the given distance value

Parameters

distance

value

Since

100

initWithDistance:geoprocessingLinearUnit:

- (instancetype) initWithDistance:		(double)	distance
geoprocessingLinearUnit:		(AGSGeoprocessingLinearUnits)	geoprocessingLinearUnit

Intialize this parameter with the given distance value

Parameters

distance	value
geoprocessingLinearUnit	specifying unit of measurement for the distance value

Since

100

initWithDistance:linearUnit:

- (instancetype) initWithDistance:		(double)	distance
linearUnit:		(AGSLinearUnit *)	linearUnit

Intialize this parameter with the given distance value

Parameters

distance	value
linearUnit	specifying unit of measurement for the distance value

Since

100

initWithDistance:unitID:

- (instancetype) initWithDistance:		(double)	distance
unitID:		(AGSLinearUnitID)	unitID

Intialize this parameter with the given distance value

Parameters

distance	value
unitID	specifying unit of measurement for the distance value

Since

100

linearUnit

- (AGSLinearUnit*) linearUnit

The units of measurement for the distance value

Since

100

Property Documentation

distance

- (double) distance

readwritenonatomicassign

The distance value for this parameter

Since

100

geoprocessingLinearUnit

- (AGSGeoprocessingLinearUnits) geoprocessingLinearUnit

readwritenonatomicassign

The units of measurement for the distance value

Since

100

type

- (AGSGeoprocessingParameterType) type

readnonatomicassigninherited

The data type of the parameter.

Since

100