org.jscience.geography.coordinates
Class BaseSRF_2D

java.lang.Object
  extended by org.jscience.geography.coordinates.BaseSRF
      extended by org.jscience.geography.coordinates.BaseSRF_2D
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
SRF_LocalSpaceAzimuthal, SRF_LocalSpacePolar, SRF_LocalSpaceRectangular2D

public abstract class BaseSRF_2D
extends BaseSRF

The BaseSRF_2D abstract class is the base class for the 2D SRFs.

See Also:
BaseSRF, BaseSRF_3D

Field Summary
 
Fields inherited from class org.jscience.geography.coordinates.BaseSRF
_hsr, _internalSRFs, _myOpSeq, _mySrftCode, _orm
 
Constructor Summary
BaseSRF_2D()
           
 
Method Summary
static double calculateEuclideanDistance(Coord2D coord1, Coord2D coord2)
          Returns the euclidean distance between two coordinates.
 SRM_Coordinate_Valid_Region_Code changeCoordinate2DSRF(Coord2D src, Coord2D tgt)
          Changes a coordinate's values to this SRF.
abstract  Coord2D createCoordinate2D()
          Creates a 2D coordinate object.
abstract  Coord2D createCoordinate2D(double coord_comp1, double coord_comp2)
          Creates a 2D coordinate object.
 double[] getCoordinate2DValues(Coord2D coord)
          Retrieves the 2D coordinate component values.
 
Methods inherited from class org.jscience.geography.coordinates.BaseSRF
calculateEuclideanDistance, changeCoordinateSRF, checkCoordinate, createSRFSetMember, createStandardSRF, get_hsr, get_orm, getSRFCode, getSRFSetCode, getSRFSetMemberCode, getSRFTemplateCode, isEqual, makeClone, setSrfCode, setSrfSetCode, setSrfSetMemberCode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BaseSRF_2D

public BaseSRF_2D()
Method Detail

createCoordinate2D

public abstract Coord2D createCoordinate2D()
Creates a 2D coordinate object.

Returns:
a 2D coordinate object

createCoordinate2D

public abstract Coord2D createCoordinate2D(double coord_comp1,
                                           double coord_comp2)
Creates a 2D coordinate object.

Parameters:
coord_comp1 - in: the values of the first component of the 2D coordinate
coord_comp2 - in: the values of the second component of the 2D coordinate
Returns:
a 2D coordinate object

getCoordinate2DValues

public double[] getCoordinate2DValues(Coord2D coord)
                               throws SrmException
Retrieves the 2D coordinate component values.

Parameters:
coord - in: a 2D coordinate
Returns:
an array of size 2 containing the component values for the 2D coordinate
Throws:
SrmException

changeCoordinate2DSRF

public SRM_Coordinate_Valid_Region_Code changeCoordinate2DSRF(Coord2D src,
                                                              Coord2D tgt)
                                                       throws SrmException
Changes a coordinate's values to this SRF.

Parameters:
src - in: the source coordinate in some other 2D SRF
tgt - in out: the target coordinate in this 2D SRF
Returns:
the Valid Region of the target coordinate
Throws:
SrmException

calculateEuclideanDistance

public static double calculateEuclideanDistance(Coord2D coord1,
                                                Coord2D coord2)
                                         throws SrmException
Returns the euclidean distance between two coordinates.

Parameters:
coord1 - in: a coordinate in some SRF
coord2 - in: a coordinate in some SRF
Returns:
the Euclidean distance between the two Coord2D coordinates (in meters).
Throws:
SrmException