com.esri.core.geometry
Class LinearUnit

java.lang.Object
  com.esri.core.geometry.Unit
      com.esri.core.geometry.LinearUnit

All Implemented Interfaces:

Serializable

public class LinearUnit
extends Unit

Unit for measurement of dimensions.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

static interface

LinearUnit.Code Linear Unit codes

Nested classes/interfaces inherited from class com.esri.core.geometry.Unit

Unit.EsriUnit, Unit.UnitType

Field Summary

Fields inherited from class com.esri.core.geometry.Unit

m_factor, mAbbreviation, mDisplayName, mID, mName, mPluralDisplayName, mWKID

Constructor Summary

LinearUnit(int WKID)

Method Summary

double	convertFromMeters(double meters) Converts meters to this LinearUnit.
double	convertToMeters(double thisUnitValue) Converts this linear units to meters.
boolean	equals(Object other) Indicates if this unit is the same type (linear, angular, or area) and the same unit (meter, degree, acre, etc.)as another.
String	getAbbreviation() Returns the abbreviated name of this unit.
double	getConversionFactor(Unit dstUnit) Returns a conversion factor from this unit to the destination unit.
String	getDisplayName() Returns the display name of this unit.
int	getID() Returns the unit's well-known ID.
String	getName() Returns the canonical name of the unit as defined in Projection Engine.
String	getPluralDisplayName() Returns the display name of this unit.
Unit.UnitType	getUnitType() Returns the unit type.
double	toMeters(double thisUnitValue) Deprecated. Method introduced at Beta. Will be removed at next release.

Methods inherited from class com.esri.core.geometry.Unit

convertUnits, convertUnits, create, getUnitToBaseFactor, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinearUnit

public LinearUnit(int WKID)

Parameters:

WKID -

Since:

1.0

Method Detail

getName

public String getName()

Returns the canonical name of the unit as defined in Projection Engine.

Specified by:

getName in class Unit

Returns:

A string representation of Projection Engine unit name.

Since:

1.0

getDisplayName

public String getDisplayName()

Returns the display name of this unit.

Specified by:

getDisplayName in class Unit

Returns:

A string value of unit display name.

Since:

1.0

getPluralDisplayName

public String getPluralDisplayName()

Returns the display name of this unit.

Specified by:

getPluralDisplayName in class Unit

Returns:

string value of plural display name

Since:

1.0

getAbbreviation

public String getAbbreviation()

Returns the abbreviated name of this unit.

Specified by:

getAbbreviation in class Unit

Returns:

A string value of abbreviation for unit.

Since:

1.0

getID

public int getID()

Returns the unit's well-known ID.

Specified by:

getID in class Unit

Returns:

Integer value for wkid.

Since:

1.0

getConversionFactor

public double getConversionFactor(Unit dstUnit)

Returns a conversion factor from this unit to the destination unit.

Specified by:

getConversionFactor in class Unit

Parameters:

dstUnit - The destination unit.

Returns:

A double conversion factor.

Since:

1.0

equals

public boolean equals(Object other)

Indicates if this unit is the same type (linear, angular, or area) and the same unit (meter, degree, acre, etc.)as another.

Overrides:

equals in class Unit

Parameters:

other - The other object.

Returns:

true, if equals

Since:

1.0

getUnitType

public Unit.UnitType getUnitType()

Returns the unit type.

Specified by:

getUnitType in class Unit

Returns:

the unit type

Since:

1.0

convertFromMeters

public double convertFromMeters(double meters)

Converts meters to this LinearUnit.

Parameters:

meters - The value in meters to convert.

Returns:

The linear unit value corresponding to the input parameter.

Since:

1.0

toMeters

@Deprecated
public double toMeters(double thisUnitValue)

Deprecated. Method introduced at Beta. Will be removed at next release.

To meters.

Parameters:

thisUnitValue - the this unit value

Returns:

the double

Since:

1.0

See Also:

convertToMeters(double)

convertToMeters

public double convertToMeters(double thisUnitValue)

Converts this linear units to meters.

Parameters:

thisUnitValue - The value in this linear units to convert.

Returns:

The value in meters corresponding to the input parameter.

Since:

1.0