com.pb.routing.common

Class Weight

java.lang.Object

com.pb.routing.common.Weight

All Implemented Interfaces:

Serializable

public final class Weight
extends Object
implements Serializable

Represents weight.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Weight(double value, com.pb.routing.unit.WeightUnit unit) Creates a Weight instance with the specified value and unit.

Method Summary

Modifier and Type	Method and Description
Weight	convertTo(com.pb.routing.unit.WeightUnit unit) Returns a Weight that is this weight converted to the specified WeightUnit.
boolean	equals(Object o)
boolean	equivalent(Weight weight) Returns true if the specified Weight is equivalent to this Weight.
boolean	equivalent(Weight weight, double tolerance) Returns true if the specified Weight is equivalent within the specified tolerance to this Weight.
com.pb.routing.unit.WeightUnit	getUnit() Returns the units of weight.
double	getValue() Returns the amount of weight.
double	getValue(com.pb.routing.unit.WeightUnit unit) Returns the value of this weight converted to the specified unit.
int	hashCode()
boolean	isGreaterThan(Weight weight) Returns true if the specified Weight is less than this Weight; else false.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Weight

public Weight(double value,
              com.pb.routing.unit.WeightUnit unit)

Creates a Weight instance with the specified value and unit.

Parameters:

value - the amount of weight.

unit - the unit of the weight.

Method Detail

getValue

public double getValue()

Returns the amount of weight.

Returns:

the amount of weight.

getValue

public double getValue(com.pb.routing.unit.WeightUnit unit)

Returns the value of this weight converted to the specified unit.

Parameters:

unit - the unit to convert this Weight's value to.

Returns:

the value of this weight converted to the specified unit.

getUnit

public com.pb.routing.unit.WeightUnit getUnit()

Returns the units of weight.

Returns:

the units of weight.

convertTo

public Weight convertTo(com.pb.routing.unit.WeightUnit unit)

Returns a Weight that is this weight converted to the specified WeightUnit.

Parameters:

unit - the unit to convert this Weight to.

Returns:

a Weight that is this weight converted to the specified WeightUnit.

isGreaterThan

public boolean isGreaterThan(Weight weight)

Returns true if the specified Weight is less than this Weight; else false.

Parameters:

weight - the Weight to check for greatness.

Returns:

true if the specified Weight is less than this Weight; else false.

equivalent

public boolean equivalent(Weight weight)

Returns true if the specified Weight is equivalent to this Weight. Tolerance is 0.

Parameters:

weight - the Weight to check for equivalence.

Returns:

true if the specified Weight is equivalent to this Weight.

equivalent

public boolean equivalent(Weight weight,
                          double tolerance)

Returns true if the specified Weight is equivalent within the specified tolerance to this Weight.

Parameters:

weight - the Weight to check for equivalence.

tolerance - the tolerance of acceptable equivalence.

Returns:

true if the specified Weight is equivalent to this Weight.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object