org.jscience.physics.kinematics
Class Weight

java.lang.Object
  extended by org.jscience.physics.kinematics.Weight

public class Weight
extends java.lang.Object

The Weight class provides an object for encapsulating weight forces.


Constructor Summary
Weight(AbstractClassicalParticle p, AbstractDoubleVector doubleVector)
          Constructs a weight.
 
Method Summary
 Force createForce()
          DOCUMENT ME!
 AbstractClassicalParticle getParticle()
          DOCUMENT ME!
 AbstractDoubleVector getVector()
          DOCUMENT ME!
 double potentialEnergy(AbstractDoubleVector position)
          DOCUMENT ME!
 void setVector(AbstractDoubleVector doubleVector)
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Weight

public Weight(AbstractClassicalParticle p,
              AbstractDoubleVector doubleVector)
Constructs a weight.

Parameters:
p - DOCUMENT ME!
doubleVector - the weight vector.
Throws:
IllegalDimensionException - DOCUMENT ME!
java.lang.IllegalArgumentException - DOCUMENT ME!
Method Detail

getParticle

public AbstractClassicalParticle getParticle()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getVector

public AbstractDoubleVector getVector()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setVector

public void setVector(AbstractDoubleVector doubleVector)
DOCUMENT ME!

Parameters:
doubleVector - DOCUMENT ME!

potentialEnergy

public double potentialEnergy(AbstractDoubleVector position)
DOCUMENT ME!

Parameters:
position - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
IllegalDimensionException - DOCUMENT ME!
java.lang.IllegalArgumentException - DOCUMENT ME!

createForce

public Force createForce()
DOCUMENT ME!

Returns:
DOCUMENT ME!