GeoprocessingLinearUnit class final
A linear unit input or output parameter.
Corresponds to GPLinearUnit parameter type on the service.
Geoprocessing tasks support a set of linear units defined in the GeoprocessingLinearUnits.
When a GeoprocessingLinearUnit parameter is created with one of the supported GeoprocessingLinearUnits the value is sent to the service using defined linear unit type.
When a GeoprocessingLinearUnit parameter is created with a LinearUnit, the value is converted to meters if the type is not supported. For example if provided LinearUnit is international miles, the value is converted to meters since only the US Survey Miles unit is supported in geoprocessing. After GeoprocessingLinearUnit is created, the used linear unit type can be checked from GeoprocessingLinearUnit.getLinearUnit.
When GeoprocessingLinearUnit is created with a supported LinearUnit, then no conversion takes place and the value is sent to the service using the defined type.
When GeoprocessingLinearUnit is returned as an output parameter, you can get LinearUnit using GeoprocessingLinearUnit.getLinearUnit method.
- Inheritance
-
- Object
- GeoprocessingParameter
- GeoprocessingLinearUnit
Constructors
- GeoprocessingLinearUnit({double distance = 0.0, GeoprocessingLinearUnits unit = GeoprocessingLinearUnits.meter})
-
Create a geoprocessing linear unit parameter with the given distance and
linear unit.
factory
- GeoprocessingLinearUnit.withLinearUnit({required double distance, required LinearUnit linearUnit})
-
Create a geoprocessing linear unit parameter with the given distance and
linear unit.
factory
- GeoprocessingLinearUnit.withLinearUnitId({required double distance, required LinearUnitId linearUnitId})
-
Create a geoprocessing linear unit parameter with the given distance and
linear unit WKID.
factory
Properties
- distance ↔ double
-
The distance value of this parameter.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- unit ↔ GeoprocessingLinearUnits
-
The geoprocessing unit of this parameter.
getter/setter pair
Methods
-
getLinearUnit(
) → LinearUnit - Gets the geometry linear unit that corresponds to the unit of this parameter.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited