SRM.Direction Class Reference

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

List of all members.

Public Member Functions
BaseSRF	getSRF ()
	Returns the SRF this Direction belongs to.
Coord3D	getRefCoord () throws SrmException
	Returns a clone (copy) of the reference coordinate object.
double[]	getVec ()
	Returns the direction component values.
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.
double	getVectorComp (int n) throws SrmException
	Return the values of the Nth direction vector component.
void	setVec (double[] vec) throws SrmException
	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) throws SrmException
	sets the value of the Nth component of direction vector
void	copyTo (Direction dir) throws SrmException
	Copies the vector component values of this direction to the input direction.
Direction	makeClone () throws SrmException
	Returns the shallow copy of this object instance.
boolean	isEqual (Direction dir)
	Returns TRUE if the Direction parameters are "Equal".
String	toString ()
	Gets the reference coordinate associated with the Returns the values of the vector as "[ val1, val2, val3 ]".
Protected Member Functions
	Direction (BaseSRF srf, Coord3D ref_coord, double vec[])
	Constructor, requires an SRF, 3 reference coordinate values, and 3 direction values.
Coord3D	getInternalRefCoord ()
	Returns the actual reference coordinate object associated with the Direction.
Protected Attributes
Coord3D	_ref_coord
	The reference coordinate.
double[]	_vec = new double[3]
	The vector values.

---

Detailed Description

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

Author:

David Shen

See also:

BaseSRF_3D

---

Member Function Documentation

void SRM.Direction.copyTo (  Direction  dir  )  throws SrmException

Copies the vector component values of this direction to the input direction. Note: The reference coordinate of this and input direction must be the same.

double SRM.Direction.getVectorComp (  int  n  )  throws SrmException

Return the values of the Nth direction vector component. Note: N within [ 1, 2, 3 ]

boolean SRM.Direction.isEqual (  Direction  dir  )

Returns TRUE if the Direction parameters are "Equal". Note: Two variables of type "double" are equal if their difference is within epsilon=Const.EPSILON

Direction SRM.Direction.makeClone (   )  throws SrmException

Returns the shallow copy of this object instance. Note: The cloned object will reference the same object as the original object.

void SRM.Direction.setVectorComp (  int  n, double  comp )  throws SrmException

sets the value of the Nth component of direction vector Note: N within [ 1, 2, 3 ]

---

The documentation for this class was generated from the following file:

• Direction.java

---

Spatial Reference Model Java API	Version 4.4.0 - January 21, 2010
Copyright © 2010 SEDRIS™	Docs by Doxygen 1.3.2