org.openpnp.model

Class Volume

java.lang.Object

org.openpnp.model.Volume

public class Volume
extends java.lang.Object

A class to represent a quantity of three dimensional space

Constructor Summary

Constructors

Constructor and Description
Volume()
Volume(double value, VolumeUnit units)

Method Summary

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

Volume

public Volume()

Volume

public Volume(double value,
              VolumeUnit units)

Method Detail

add

public Volume add(Volume volume)

subtract

public Volume subtract(Volume volume)

add

public Volume add(double d)

subtract

public Volume subtract(double d)

multiply

public Volume multiply(double d)

divide

public Volume divide(double d)

divide

public double divide(Volume volume)

divide

public Area divide(Length length)

divide

public Length divide(Area area)

modulo

public Volume modulo(Volume volume)

getValue

public double getValue()

setValue

public void setValue(double value)

getUnits

public VolumeUnit getUnits()

setUnits

public void setUnits(VolumeUnit units)

convertToUnits

public Volume convertToUnits(VolumeUnit units)

convertToUnits

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

parse

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

parse

public static Volume 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 VolumeUnit value and returns the value as an Volume 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(Volume other)