org.openpnp.model

Class Area

java.lang.Object

org.openpnp.model.Area

public class Area
extends java.lang.Object

A class to represent a quantity of 2D space

Constructor Summary

Constructors

Constructor and Description
Area()
Area(double value, AreaUnit units)

Method Summary

Modifier and Type	Method and Description
Area	add(Area area)
Area	add(double d)
int	compareTo(Area other)
Area	convertToUnits(AreaUnit units)
static double	convertToUnits(double value, AreaUnit fromUnits, AreaUnit toUnits)
double	divide(Area area)
Area	divide(double d)
Length	divide(Length length)
boolean	equals(java.lang.Object obj)
AreaUnit	getUnits()
double	getValue()
int	hashCode()
Area	modulo(Area area)
Area	multiply(double d)
Volume	multiply(Length length)
static Area	parse(java.lang.String s)
static Area	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 an AreaUnit value and returns the value as an Area object.
void	setUnits(AreaUnit units)
void	setValue(double value)
Area	subtract(Area area)
Area	subtract(double d)
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

Area

public Area()

Area

public Area(double value,
            AreaUnit units)

Method Detail

add

public Area add(Area area)

subtract

public Area subtract(Area area)

add

public Area add(double d)

subtract

public Area subtract(double d)

multiply

public Area multiply(double d)

multiply

public Volume multiply(Length length)

divide

public Area divide(double d)

divide

public double divide(Area area)

divide

public Length divide(Length length)

modulo

public Area modulo(Area area)

getValue

public double getValue()

setValue

public void setValue(double value)

getUnits

public AreaUnit getUnits()

setUnits

public void setUnits(AreaUnit units)

convertToUnits

public Area convertToUnits(AreaUnit units)

convertToUnits

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

parse

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

parse

public static Area 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 an AreaUnit value and returns the value as an Area 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

compareTo

public int compareTo(Area other)