org.jscience.geography.coordinates
Class BaseSRF_WithTangentPlaneSurface

java.lang.Object
  extended by org.jscience.geography.coordinates.BaseSRF
      extended by org.jscience.geography.coordinates.BaseSRF_3D
          extended by org.jscience.geography.coordinates.BaseSRF_WithTangentPlaneSurface
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
SRF_LocalTangentSpaceAzimuthalSpherical, SRF_LocalTangentSpaceCylindrical, SRF_LocalTangentSpaceEuclidean

public abstract class BaseSRF_WithTangentPlaneSurface
extends BaseSRF_3D

The BaseSRF_WithTangentPlaneSurface abstract class.

See Also:
BaseSRF_3D, BaseSRF

Field Summary
 
Fields inherited from class org.jscience.geography.coordinates.BaseSRF
_hsr, _internalSRFs, _myOpSeq, _mySrftCode, _orm
 
Constructor Summary
BaseSRF_WithTangentPlaneSurface()
           
 
Method Summary
abstract  CoordSurf createSurfaceCoordinate()
          Creates a surface coordinate object with default [ Double.NaN, Double.NaN ].
abstract  CoordSurf createSurfaceCoordinate(double coord_surf_comp1, double coord_surf_comp2)
          Creates a surface coordinate object with initial values.
abstract  CoordSurf getAssociatedSurfaceCoordinate(Coord3D coord)
          Returns a surface coordinate associated with a 3D coordinate.
abstract  Coord3D getPromotedSurfaceCoordinate(CoordSurf surf_coord)
          Returns a 3D coordinate representing the same location as specified by a surface coordinate.
 double[] getSurfaceCoordinateValues(CoordSurf coord_surf)
          Retrieves a coordinate surface component values
 
Methods inherited from class org.jscience.geography.coordinates.BaseSRF_3D
calculateEuclideanDistance, changeCoordinate3DSRF, changeDirectionSRF, changeOrientationSRF, checkDirection, checkOrientation, createCoordinate3D, createCoordinate3D, createDirection, createDirection, createOrientation, createOrientation, createOrientation, getCoordinate3DValues, getDirectionValues, getMemberCode, getNaturalSRFSetMember, getNaturalSRFSetMemberCode, getOrientationValues, instanceAbstractSpaceCoordinate
 
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_WithTangentPlaneSurface

public BaseSRF_WithTangentPlaneSurface()
Method Detail

createSurfaceCoordinate

public abstract CoordSurf createSurfaceCoordinate()
Creates a surface coordinate object with default [ Double.NaN, Double.NaN ].

Returns:
a surface coordinate object

createSurfaceCoordinate

public abstract CoordSurf createSurfaceCoordinate(double coord_surf_comp1,
                                                  double coord_surf_comp2)
Creates a surface coordinate object with initial values.

Parameters:
coord_surf_comp1 - in: the values of the first component of the surface coordinate
coord_surf_comp2 - in: the values of the second component of the surface coordinate
Returns:
a surface coordinate object

getSurfaceCoordinateValues

public double[] getSurfaceCoordinateValues(CoordSurf coord_surf)
                                    throws SrmException
Retrieves a coordinate surface component values

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

getAssociatedSurfaceCoordinate

public abstract CoordSurf getAssociatedSurfaceCoordinate(Coord3D coord)
                                                  throws SrmException
Returns a surface coordinate associated with a 3D coordinate.

Parameters:
coord - in: a 3D coordinate in this SRF
Returns:
a surface coordinate object in this SRF
Throws:
SrmException

getPromotedSurfaceCoordinate

public abstract Coord3D getPromotedSurfaceCoordinate(CoordSurf surf_coord)
                                              throws SrmException
Returns a 3D coordinate representing the same location as specified by a surface coordinate.

Parameters:
coord - in: a surface coordinate in this SRF
Returns:
a 3D coordinate object in this SRF
Throws:
SrmException