GeoTessCPP  2.0.0
Software to facilitate storage and retrieval of 3D information about the Earth.
 All Classes Namespaces Files Functions Variables Typedefs Friends Defines
Public Member Functions
geotess::GeoTessHorizonDepth Class Reference

#include <GeoTessHorizonDepth.h>

Inheritance diagram for geotess::GeoTessHorizonDepth:
geotess::GeoTessHorizon

List of all members.

Public Member Functions

 GeoTessHorizonDepth (const double &dpth)
 GeoTessHorizonDepth (const double &dpth, const int &lyrIndex)
 GeoTessHorizonDepth (GeoTessHorizonDepth &other)
virtual ~GeoTessHorizonDepth ()
virtual string class_name ()
virtual double getRadius (const double *position, GeoTessProfile **profiles)
virtual double getRadius (GeoTessPosition &position)
virtual double getValue ()
GeoTessHorizonDepthoperator= (const GeoTessHorizonDepth &other)
virtual string str ()

Detailed Description

Defines a "surface" in a model that resides at a constant depth.

Author:
sballar

Constructor & Destructor Documentation

geotess::GeoTessHorizonDepth::GeoTessHorizonDepth ( const double &  dpth) [inline]

Constructor for a Horizon object that represents a constant depth within the Earth. Units are km below the surface of the GRS80 ellipsoid.

Since the layerIndex is not specified, the depth is not constrained to be within any particular layer.

Parameters:
dpthdepth in km below the surface of the GRS80 ellipsoid.
geotess::GeoTessHorizonDepth::GeoTessHorizonDepth ( const double &  dpth,
const int &  lyrIndex 
) [inline]

Constructor for a Horizon object that represents a constant depth in the Earth, in km. Depth is measured relative to the surface of the WGS84 ellipsoid in km.

Since the layerIndex is specified, the depth will be constrained to be within the specified layer.

Parameters:
dpthdepth below the surface of WGS84 ellipsoid, in km.
lyrIndexthe index of the layer within which the radius will be constrained.

Destructor.

Copy constructor.


Member Function Documentation

virtual string geotess::GeoTessHorizonDepth::class_name ( ) [inline, virtual]

Reimplemented from geotess::GeoTessHorizon.

virtual double geotess::GeoTessHorizonDepth::getRadius ( const double *  position,
GeoTessProfile **  profiles 
) [inline, virtual]

Return the radius of the Horizon at the specified geographic position and constrained by the specified array of Profiles, all of which are assumed to reside at the specified position.

Parameters:
positionthe unit vector representing the position where the radius is to be determined. This should correspond to the position of the supplied array of Profiles.
profilesa 1D array of profiles at the specified position. The number of elements must be equal to the number of layers in the model with the first layer being the deepest (closest to the center of the Earth) and the last layer being the shallowest (farthest from the center of the Earth).
Returns:
the radius of the Horizon at the specified position and perhaps constrained to reside in the specified layer. Units are km.

Reimplemented from geotess::GeoTessHorizon.

virtual double geotess::GeoTessHorizonDepth::getRadius ( GeoTessPosition position) [inline, virtual]

Return the radius of the Horizon at the position of the specified GeoTessPosition object.

Parameters:
position
Returns:
the radius of the Horizon at the specified position and perhaps constrained to reside in the specified layer. Units are km.
Exceptions:
GeoTessException

Reimplemented from geotess::GeoTessHorizon.

virtual double geotess::GeoTessHorizonDepth::getValue ( ) [inline, virtual]

HorizonDepth objects return depth, HorizonRadius object return radius, and HorizonLayer object return fraction.

Reimplemented from geotess::GeoTessHorizon.

GeoTessHorizonDepth& geotess::GeoTessHorizonDepth::operator= ( const GeoTessHorizonDepth other) [inline]

Overloaded assignment operator

virtual string geotess::GeoTessHorizonDepth::str ( ) [inline, virtual]

Reimplemented from geotess::GeoTessHorizon.


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