Main Page | Packages | Class Hierarchy | Alphabetical List | Compound List | Compound Members

SRM.BaseSRF_2D Class Reference

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

Inheritance diagram for SRM.BaseSRF_2D:

Inheritance graph
[legend]
List of all members.

Public Member Functions

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) throws SrmException
 Retrieves the 2D coordinate component values.

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


Static Public Member Functions

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

Detailed Description

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

Author:
David Shen
See also:
BaseSRF, BaseSRF_3D

Member Function Documentation

double SRM.BaseSRF_2D.calculateEuclideanDistance (  Coord2D  coord1,
Coord2D  coord2
)  throws SrmException [static]
 

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).
Note:
The input coordinates do not need to be from the same SRF.

This method will make (and cache) internal conversions when the inputs coordinates are from SRFs other than SRF_Celestiocentric.

SRM_Coordinate_Valid_Region_Code SRM.BaseSRF_2D.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

abstract Coord2D SRM.BaseSRF_2D.createCoordinate2D (  double  coord_comp1,
double  coord_comp2
)  [pure virtual]
 

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

Implemented in SRM.SRF_LocalSpaceAzimuthal, SRM.SRF_LocalSpacePolar, and SRM.SRF_LocalSpaceRectangular2D.

abstract Coord2D SRM.BaseSRF_2D.createCoordinate2D (   )  [pure virtual]
 

Creates a 2D coordinate object.

Returns:
a 2D coordinate object The initial coordinate value is defaulted to [ Double.NaN, Double.NaN ].

Implemented in SRM.SRF_LocalSpaceAzimuthal, SRM.SRF_LocalSpacePolar, and SRM.SRF_LocalSpaceRectangular2D.

double [] SRM.BaseSRF_2D.getCoordinate2DValues (  Coord2D  coord  )  throws SrmException
 

Retrieves the 2D coordinate component values.

Note:
The input coordinate must have been created using this SRF.
Parameters:
coord in: a 2D coordinate
Returns:
an array of size 2 containing the component values for the 2D coordinate

The documentation for this class was generated from the following file:
Spatial Reference Model Java API Version 4.0.0 - 29 Jul 2004
Copyright © 2004 SEDRIS™ Docs by Doxygen 1.3.2