LinearUnit (GRA 3.0.1 API)

java.lang.Object
- java.lang.Enum<LinearUnit>
- - com.mapinfo.midev.unit.LinearUnit

All Implemented Interfaces:

Serializable, Comparable<LinearUnit>
```
public enum LinearUnit
extends Enum<LinearUnit>
```
A unit of measure for length.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CENTIMETER` A LinearUnit representing centimeters.
`CHAIN` A LinearUnit representing chains (66 feet).
`CM` A LinearUnit representing centimeters.
`FOOT` A LinearUnit representing feet.
`FT` A LinearUnit representing feet.
`IN` A LinearUnit representing inches.
`INCH` A LinearUnit representing inches.
`KILOMETER` A LinearUnit representing kilometers.
`KM` A LinearUnit representing kilometers.
`LINK` A LinearUnit representing links (1/100 chain, 0.66 feet).
`M` A LinearUnit representing meters.
`METER` A LinearUnit representing meters.
`MI` A LinearUnit representing miles.
`MILE` A LinearUnit representing miles.
`MILLIMETER` A LinearUnit representing millimeters.
`MM` A LinearUnit representing millimeters.
`NAUTICAL_MILE` A LinearUnit representing nautical miles.
`PICA` A LinearUnit representing inches (12 point or 1/6 inch).
`POINT` A LinearUnit representing points (1/72 inch).
`ROD` A LinearUnit representing rods.
`SURVEY_FOOT` A LinearUnit representing US survey feet.
`TWIP` A LinearUnit representing twips (1/20 point or 1/1440 inch).
`YARD` A LinearUnit representing yards.
`YD` A LinearUnit representing yards.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`convert(double length, LinearUnit fromUnit, LinearUnit toUnit)` Convert the specified length to its equivalent value in another linear unit.
`double`	`getMetersPerUnit()` Get the number of meters equivalent to one of this unit of measure.
`static LinearUnit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LinearUnit`	`valueOfIgnoreCase(String name)` returns the LinearUnit with the specified name.
`static LinearUnit[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - INCH
```
public static final LinearUnit INCH
```
    A LinearUnit representing inches.
  - IN
```
public static final LinearUnit IN
```
    A LinearUnit representing inches.
  - FOOT
```
public static final LinearUnit FOOT
```
    A LinearUnit representing feet.
  - FT
```
public static final LinearUnit FT
```
    A LinearUnit representing feet.
  - YARD
```
public static final LinearUnit YARD
```
    A LinearUnit representing yards.
  - YD
```
public static final LinearUnit YD
```
    A LinearUnit representing yards.
  - MILE
```
public static final LinearUnit MILE
```
    A LinearUnit representing miles.
  - MI
```
public static final LinearUnit MI
```
    A LinearUnit representing miles.
  - MILLIMETER
```
public static final LinearUnit MILLIMETER
```
    A LinearUnit representing millimeters.
  - MM
```
public static final LinearUnit MM
```
    A LinearUnit representing millimeters.
  - CENTIMETER
```
public static final LinearUnit CENTIMETER
```
    A LinearUnit representing centimeters.
  - CM
```
public static final LinearUnit CM
```
    A LinearUnit representing centimeters.
  - METER
```
public static final LinearUnit METER
```
    A LinearUnit representing meters.
  - M
```
public static final LinearUnit M
```
    A LinearUnit representing meters.
  - KILOMETER
```
public static final LinearUnit KILOMETER
```
    A LinearUnit representing kilometers.
  - KM
```
public static final LinearUnit KM
```
    A LinearUnit representing kilometers.
  - SURVEY_FOOT
```
public static final LinearUnit SURVEY_FOOT
```
    A LinearUnit representing US survey feet.
  - NAUTICAL_MILE
```
public static final LinearUnit NAUTICAL_MILE
```
    A LinearUnit representing nautical miles.
  - LINK
```
public static final LinearUnit LINK
```
    A LinearUnit representing links (1/100 chain, 0.66 feet).
  - CHAIN
```
public static final LinearUnit CHAIN
```
    A LinearUnit representing chains (66 feet).
  - ROD
```
public static final LinearUnit ROD
```
    A LinearUnit representing rods.
  - TWIP
```
public static final LinearUnit TWIP
```
    A LinearUnit representing twips (1/20 point or 1/1440 inch).
  - POINT
```
public static final LinearUnit POINT
```
    A LinearUnit representing points (1/72 inch).
  - PICA
```
public static final LinearUnit PICA
```
    A LinearUnit representing inches (12 point or 1/6 inch).
- Method Detail
  - values
```
public static LinearUnit[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (LinearUnit c : LinearUnit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LinearUnit valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getMetersPerUnit
```
public double getMetersPerUnit()
```
    Get the number of meters equivalent to one of this unit of measure.
    
    Returns:
    
    The number of meters equivalent to one of this unit of measure.
  - convert
```
public static double convert(double length,
                             LinearUnit fromUnit,
                             LinearUnit toUnit)
```
    Convert the specified length to its equivalent value in another linear unit.
    
    Parameters:
    
    length - An length with unit fromUnit
    
    fromUnit - The linear unit of the specified length.
    
    toUnit - The linear unit for the converted value.
    
    Returns:
    
    The converted length in the specified units.
  - valueOfIgnoreCase
```
public static LinearUnit valueOfIgnoreCase(String name)
```
    returns the LinearUnit with the specified name.
    
    Parameters:
    
    name - name of LinearUnit constant to return
    
    Returns:
    
    LinearUnit with the specified name.
    
    Throws:
    
    IllegalArgumentException - is thrown if name is null or invalid

Enum LinearUnit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INCH

IN

FOOT

FT

YARD

YD

MILE

MI

MILLIMETER

MM

CENTIMETER

CM

METER

M

KILOMETER

KM

SURVEY_FOOT

NAUTICAL_MILE

LINK

CHAIN

ROD

TWIP

POINT

PICA

Method Detail

values

valueOf

getMetersPerUnit

convert

valueOfIgnoreCase