org.jscience.geography.coordinates
Class Orientation

java.lang.Object
  extended by org.jscience.geography.coordinates.Orientation
All Implemented Interfaces:
java.lang.Cloneable

public class Orientation
extends java.lang.Object
implements java.lang.Cloneable

The Orientation abstract contains a 3x3 matrix and a reference location.

See Also:
BaseSRF_3D

Constructor Summary
protected Orientation(BaseSRF srf, Coord3D ref_coord, double[][] mtx)
          Constructor, requires an SRF, 3 reference coordinate values, and 3 direction values.
 
Method Summary
 void copyTo(Orientation ori)
          Copies the matrix component values of this orientation to the input orientation.
 void getDirectionComp(int n, Direction dir)
          Returns the Nth row of the Orientation matrix 3x3 in the form of a Direction object.
 void getDirectionComp1(Direction dir)
          Returns the 1st row of the Orientation matrix 3x3 in the form of a Direction object.
 void getDirectionComp2(Direction dir)
          Returns the 2nd row of the Orientation matrix 3x3 in the form of a Direction object.
 void getDirectionComp3(Direction dir)
          Returns the 3rd row of the Orientation matrix 3x3 in the form of a Direction object.
protected  Coord3D getInternalRefCoord()
           
 double[][] getMatrix()
           
 Coord3D getRefCoord()
           
 BaseSRF getSRF()
           
 boolean isEqual(Orientation ori)
          Returns TRUE if the Orientaqtion parameters are "Equal"
 Orientation makeClone()
          Returns the shallow copy of this object instance.
 void setDirectionComp(Direction dir1, Direction dir2, Direction dir3)
          Sets rows of the Orientation matrix 3x3 using the vectors from 3 Direction objects.
 void setDirectionComp(int n, Direction dir)
          Sets Nth rows of the Orientation matrix 3x3 using the vector from the Direction object.
 void setMatrix(double[][] mtx)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Orientation

protected Orientation(BaseSRF srf,
                      Coord3D ref_coord,
                      double[][] mtx)
Constructor, requires an SRF, 3 reference coordinate values, and 3 direction values.

Method Detail

getSRF

public BaseSRF getSRF()

getRefCoord

public Coord3D getRefCoord()
                    throws SrmException
Throws:
SrmException

getMatrix

public double[][] getMatrix()

getDirectionComp1

public void getDirectionComp1(Direction dir)
                       throws SrmException
Returns the 1st row of the Orientation matrix 3x3 in the form of a Direction object.

Throws:
SrmException

getDirectionComp2

public void getDirectionComp2(Direction dir)
                       throws SrmException
Returns the 2nd row of the Orientation matrix 3x3 in the form of a Direction object.

Throws:
SrmException

getDirectionComp3

public void getDirectionComp3(Direction dir)
                       throws SrmException
Returns the 3rd row of the Orientation matrix 3x3 in the form of a Direction object.

Throws:
SrmException

getDirectionComp

public void getDirectionComp(int n,
                             Direction dir)
                      throws SrmException
Returns the Nth row of the Orientation matrix 3x3 in the form of a Direction object.

Throws:
SrmException

setDirectionComp

public void setDirectionComp(Direction dir1,
                             Direction dir2,
                             Direction dir3)
                      throws SrmException
Sets rows of the Orientation matrix 3x3 using the vectors from 3 Direction objects.

Throws:
SrmException

setDirectionComp

public void setDirectionComp(int n,
                             Direction dir)
                      throws SrmException
Sets Nth rows of the Orientation matrix 3x3 using the vector from the Direction object.

Throws:
SrmException

setMatrix

public void setMatrix(double[][] mtx)
               throws SrmException
Throws:
SrmException

makeClone

public Orientation makeClone()
                      throws SrmException
Returns the shallow copy of this object instance.

Throws:
SrmException

copyTo

public void copyTo(Orientation ori)
            throws SrmException
Copies the matrix component values of this orientation to the input orientation.

Throws:
SrmException

isEqual

public boolean isEqual(Orientation ori)
Returns TRUE if the Orientaqtion parameters are "Equal"


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getInternalRefCoord

protected Coord3D getInternalRefCoord()