ilog.views.maps

Class IlvLinearUnit

java.lang.Object

ilog.views.maps.IlvUnit

ilog.views.maps.IlvLinearUnit

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvLinearUnit
extends IlvUnit

This class defines linear units. Linear units are used to measure lengths. The kernel unit of IlvLinearUnit is the meter. IlvLinearUnit has constants defining usual units :

• METER defines meters.
• KILOMETER defines kilometers.
• KMI defines international nautical miles.
• FT defines international feet.
• MI defines international statue miles (land miles).

Additional linear units can be retrieved using the GetRegisteredUnit method or listed using the GetRegisteredUnits method of the superclass, IlvUnit.

Since:

JViews 5.0

See Also:

IlvUnit, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IlvLinearUnit	FT The unit representing international feet.
static IlvLinearUnit	KILOMETER The unit representing kilometers.
static IlvLinearUnit	KMI The unit representing international nautical miles.
static IlvLinearUnit	METER The unit representing meters.
static IlvLinearUnit	MI The unit representing international statute miles.

Constructor Summary

Constructors

Constructor and Description
IlvLinearUnit(double metersPerUnit, String abbreviation, String fullname) Constructs a new linear unit.
IlvLinearUnit(IlvInputStream stream) Reads the object from an IlvInputStream object.
IlvLinearUnit(IlvLinearUnit source) Constructs a new linear unit by copying an existing one.

Method Summary

Modifier and Type	Method and Description
IlvUnit	copy() Returns a copy of this IlvLinearUnit.
boolean	equivalent(IlvUnit unit) Returns true if the specified unit is equivalent to this one.
double	fromKernel(double value) Converts the value specified in the kernel unit of the quantity measured by this unit, to values in this unit.
double	fromMeters(double meters) Converts meters to this unit.
double	getMetersPerUnit() Returns the number of meters per unit.
double	toKernel(double value) Converts the value specified in the units of this IlvUnit to the kernel unit (that is, meters).
double	toMeters(double unit) Converts this unit to meters.
void	write(IlvOutputStream stream) Writes the object to the specified IlvOutputStream.

Methods inherited from class ilog.views.maps.IlvUnit

equals, getAbbreviation, getLocalizedAbbreviation, getLocalizedName, getName, GetRegisteredUnit, GetRegisteredUnits, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

METER

public static final IlvLinearUnit METER

The unit representing meters.

KILOMETER

public static final IlvLinearUnit KILOMETER

The unit representing kilometers.

KMI

public static final IlvLinearUnit KMI

The unit representing international nautical miles.

FT

public static final IlvLinearUnit FT

The unit representing international feet.

MI

public static final IlvLinearUnit MI

The unit representing international statute miles.

Constructor Detail

IlvLinearUnit

public IlvLinearUnit(double metersPerUnit,
                     String abbreviation,
                     String fullname)

Constructs a new linear unit.

Parameters:

metersPerUnit - The number of meters per unit.

abbreviation - The abbreviation of the unit.

fullname - The name of the unit.

IlvLinearUnit

public IlvLinearUnit(IlvLinearUnit source)

Constructs a new linear unit by copying an existing one.

Parameters:

source - The source unit.

IlvLinearUnit

public IlvLinearUnit(IlvInputStream stream)
              throws IlvReadFileException

Reads the object from an IlvInputStream object.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - If the format is not correct.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to the specified IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvUnit

Parameters:

stream - The stream to write this unit to.

Throws:

IOException - If an I/O error occurs.

getMetersPerUnit

public final double getMetersPerUnit()

Returns the number of meters per unit.

fromMeters

public final double fromMeters(double meters)

Converts meters to this unit.

Parameters:

meters - The value to convert, expressed in meters.

Returns:

The value in this unit.

toMeters

public final double toMeters(double unit)

Converts this unit to meters.

Parameters:

unit - The value to convert, expressed in this unit.

Returns:

The value in meters.

toKernel

public final double toKernel(double value)

Converts the value specified in the units of this IlvUnit to the kernel unit (that is, meters).

Specified by:

toKernel in class IlvUnit

Parameters:

value - The value to convert.

Returns:

The value converted to kernel units.

fromKernel

public final double fromKernel(double value)

Converts the value specified in the kernel unit of the quantity measured by this unit, to values in this unit.

Specified by:

fromKernel in class IlvUnit

Parameters:

value - The value expressed in kernel units.

Returns:

The value converted to the units represented by this object.

equivalent

public final boolean equivalent(IlvUnit unit)

Returns true if the specified unit is equivalent to this one. Two units are equivalent if they have the same meters per unit.

Specified by:

equivalent in class IlvUnit

Parameters:

unit - The unit to compare to.

Returns:

true if the two units are equivalent.

copy

public final IlvUnit copy()

Returns a copy of this IlvLinearUnit.