org.openpnp.model

Class Length

java.lang.Object

org.openpnp.model.Length

public class Length
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Length.Field

Constructor Summary

Constructors

Constructor and Description
Length()
Length(double value, LengthUnit units)

Method Summary

Modifier and Type	Method and Description
Length	add(double d)
Length	add(Length length)
int	compareTo(Length other)
static double	convertToUnits(double value, LengthUnit fromUnits, LengthUnit toUnits)
Length	convertToUnits(LengthUnit units)
Length	divide(double d)
double	divide(Length length)
boolean	equals(java.lang.Object obj)
LengthUnit	getUnits()
double	getValue()
int	hashCode()
boolean	isInitialized()
Length	modulo(Length length)
Length	multiply(double d)
Area	multiply(Length length)
static Length	parse(java.lang.String s)
static Length	parse(java.lang.String s, boolean requireUnits) Takes a value in the format of a double followed by any number of spaces followed by the shortName of a LengthUnit value and returns the value as a Length object.
static Location	setLocationField(Configuration configuration, Location location, Length length, Length.Field field) Sets the specified field on the passed Location object.
static Location	setLocationField(Configuration configuration, Location location, Length length, Length.Field field, boolean defaultToOldUnits)
void	setUnits(LengthUnit units)
void	setValue(double value)
Length	subtract(double d)
Length	subtract(Length length)
java.lang.String	toString()
java.lang.String	toString(java.lang.String fmt) Performs the same function as toString() but allows the caller to specify the format String that is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

Length

public Length()

Length

public Length(double value,
              LengthUnit units)

Method Detail

add

public Length add(Length length)

subtract

public Length subtract(Length length)

multiply

public Area multiply(Length length)

add

public Length add(double d)

subtract

public Length subtract(double d)

multiply

public Length multiply(double d)

divide

public Length divide(double d)

divide

public double divide(Length length)

modulo

public Length modulo(Length length)

getValue

public double getValue()

setValue

public void setValue(double value)

getUnits

public LengthUnit getUnits()

setUnits

public void setUnits(LengthUnit units)

convertToUnits

public Length convertToUnits(LengthUnit units)

convertToUnits

public static double convertToUnits(double value,
                                    LengthUnit fromUnits,
                                    LengthUnit toUnits)

parse

public static Length parse(java.lang.String s)

parse

public static Length parse(java.lang.String s,
                           boolean requireUnits)

Takes a value in the format of a double followed by any number of spaces followed by the shortName of a LengthUnit value and returns the value as a Length object. Returns null if the value could not be parsed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String fmt)

Performs the same function as toString() but allows the caller to specify the format String that is used. The format String should contain %f and %s in that order for value and units.getShortName().

Parameters:

fmt -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

setLocationField

public static Location setLocationField(Configuration configuration,
                                        Location location,
                                        Length length,
                                        Length.Field field,
                                        boolean defaultToOldUnits)

setLocationField

public static Location setLocationField(Configuration configuration,
                                        Location location,
                                        Length length,
                                        Length.Field field)

Sets the specified field on the passed Location object. Enforces application specific unit conversion. If the new Length value does not have units set, this method will set the units of the Length to the system default units. If the Location itself does not have units set, the Location's units are set to the Length's units. Finally, if the Location's units have changed, the entire Location is converted to the new units and the new object is returned.

Parameters:

configuration -

location -

length -

field -

Returns:

compareTo

public int compareTo(Length other)

isInitialized

public boolean isInitialized()

Returns:

true, if non-zero, assuming no initialized value can be zero.