Main Page | Packages | Class Hierarchy | Alphabetical List | Compound List | Namespace Members | Compound Members | Related Pages

SRM.BaseSRF_WithTangentPlaneSurface Class Reference

The BaseSRF_WithTangentPlaneSurface abstract class. More...

Inheritance diagram for SRM.BaseSRF_WithTangentPlaneSurface:

Inheritance graph
[legend]
List of all members.

Public Member Functions

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.

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

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

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

Detailed Description

The BaseSRF_WithTangentPlaneSurface abstract class.

Author:
David Shen
See also:
BaseSRF_3D, BaseSRF

Member Function Documentation

abstract CoordSurf SRM.BaseSRF_WithTangentPlaneSurface.createSurfaceCoordinate (  double  coord_surf_comp1,
double  coord_surf_comp2
)  [pure virtual]
 

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

Implemented in SRM.SRF_LocalTangentSpaceAzimuthalSpherical, SRM.SRF_LocalTangentSpaceCylindrical, and SRM.SRF_LocalTangentSpaceEuclidean.

abstract CoordSurf SRM.BaseSRF_WithTangentPlaneSurface.createSurfaceCoordinate (   )  [pure virtual]
 

Creates a surface coordinate object with default [ Double.NaN, Double.NaN ].

Returns:
a surface coordinate object

Implemented in SRM.SRF_LocalTangentSpaceAzimuthalSpherical, SRM.SRF_LocalTangentSpaceCylindrical, and SRM.SRF_LocalTangentSpaceEuclidean.

abstract CoordSurf SRM.BaseSRF_WithTangentPlaneSurface.getAssociatedSurfaceCoordinate (  Coord3D  coord  )  throws SrmException [pure virtual]
 

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
Note:
The input coordinate must have been created using this SRF.

Implemented in SRM.SRF_LocalTangentSpaceAzimuthalSpherical, SRM.SRF_LocalTangentSpaceCylindrical, and SRM.SRF_LocalTangentSpaceEuclidean.

abstract Coord3D SRM.BaseSRF_WithTangentPlaneSurface.getPromotedSurfaceCoordinate (  CoordSurf  surf_coord  )  throws SrmException [pure virtual]
 

Returns a 3D coordinate representing the same location as specified by a surface coordinate.

Parameters:
surf_coord in: a surface coordinate in this SRF
Returns:
a 3D coordinate object in this SRF
Note:
The input surface coordinate must have been created using this SRF.

Implemented in SRM.SRF_LocalTangentSpaceAzimuthalSpherical, SRM.SRF_LocalTangentSpaceCylindrical, and SRM.SRF_LocalTangentSpaceEuclidean.

double [] SRM.BaseSRF_WithTangentPlaneSurface.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
Note:
The input surface coordinate must have been created using this SRF.

The documentation for this class was generated from the following file:
Spatial Reference Model Java API Version 4.4.0 - January 21, 2010
Copyright © 2010 SEDRIS™ Docs by Doxygen 1.3.2