SRM

Class Direction

java.lang.Object

SRM.Direction

All Implemented Interfaces:

Cloneable

public class Direction
extends Object
implements Cloneable

The Direction abstract contains a three element vector and a reference location.

Author:

David Shen

See Also:

BaseSRF_3D

Field Summary

Fields

Modifier and Type	Field and Description
protected Coord3D	_ref_coord The reference coordinate
protected double[]	_vec The vector values

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Direction(BaseSRF srf, Coord3D ref_coord, double[] vec) Constructor, requires an SRF, 3 reference coordinate values, and 3 direction values.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTo(Direction dir) Copies the vector component values of this direction to the input direction.
protected Coord3D	getInternalRefCoord() Returns the actual reference coordinate object associated with the Direction
Coord3D	getRefCoord() Returns a clone (copy) of the reference coordinate object
BaseSRF	getSRF() Returns the SRF this Direction belongs to.
double[]	getVec() Returns the direction component values.
double	getVectorComp(int n) Return the values of the Nth direction vector component.
double	getVectorComp1() Return the values of the 1st vector component
double	getVectorComp2() Return the values of the 2nd direction vector component
double	getVectorComp3() Return the values of the 3rd direction vector component
boolean	isEqual(Direction dir) Returns TRUE if the Direction parameters are "Equal"
Direction	makeClone() Returns the shallow copy of this object instance.
void	setVec(double[] vec) sets the direction vector component values
void	setVectorComp(double comp1, double comp2, double comp3) sets the values of the direction vector
void	setVectorComp(int n, double comp) sets the value of the Nth component of direction vector
String	toString() Gets the reference coordinate associated with the Returns the values of the vector as "[ val1, val2, val3 ]"

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_ref_coord

protected Coord3D _ref_coord

The reference coordinate

_vec

protected double[] _vec

The vector values

Constructor Detail

Direction

protected Direction(BaseSRF srf,
         Coord3D ref_coord,
         double[] vec)

Constructor, requires an SRF, 3 reference coordinate values, and 3 direction values.

Method Detail

getSRF

public BaseSRF getSRF()

Returns the SRF this Direction belongs to.

getRefCoord

public Coord3D getRefCoord()
                    throws SrmException

Returns a clone (copy) of the reference coordinate object

Throws:

SrmException

getVec

public double[] getVec()

Returns the direction component values.

getVectorComp1

public double getVectorComp1()

Return the values of the 1st vector component

getVectorComp2

public double getVectorComp2()

Return the values of the 2nd direction vector component

getVectorComp3

public double getVectorComp3()

Return the values of the 3rd direction vector component

getVectorComp

public double getVectorComp(int n)
                     throws SrmException

Return the values of the Nth direction vector component.

Throws:

SrmException

setVec

public void setVec(double[] vec)
            throws SrmException

sets the direction vector component values

Throws:

SrmException

setVectorComp

public void setVectorComp(double comp1,
                 double comp2,
                 double comp3)

sets the values of the direction vector

setVectorComp

public void setVectorComp(int n,
                 double comp)
                   throws SrmException

sets the value of the Nth component of direction vector

Throws:

SrmException

copyTo

public void copyTo(Direction dir)
            throws SrmException

Copies the vector component values of this direction to the input direction.

Throws:

SrmException

makeClone

public Direction makeClone()
                    throws SrmException

Returns the shallow copy of this object instance.

Throws:

SrmException

isEqual

public boolean isEqual(Direction dir)

Returns TRUE if the Direction parameters are "Equal"

toString

public String toString()

Gets the reference coordinate associated with the Returns the values of the vector as "[ val1, val2, val3 ]"

Overrides:

toString in class Object

getInternalRefCoord

protected Coord3D getInternalRefCoord()

Returns the actual reference coordinate object associated with the Direction