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 | Static Public Member Functions
geotess::GeoTessProfileConstant Class Reference

#include <GeoTessProfileConstant.h>

Inheritance diagram for geotess::GeoTessProfileConstant:
geotess::GeoTessProfile

List of all members.

Public Member Functions

 GeoTessProfileConstant (float radBot, float radTop, GeoTessData *dat)
virtual int class_size () const
virtual GeoTessData ** getData ()
virtual GeoTessDatagetData (int i)
virtual const GeoTessDatagetData (int i) const
virtual const GeoTessDatagetDataBottom () const
virtual GeoTessDatagetDataBottom ()
virtual const GeoTessDatagetDataTop () const
virtual GeoTessDatagetDataTop ()
virtual int getNData () const
virtual int getNRadii () const
virtual float * getRadii ()
virtual float getRadius (int i) const
virtual float getRadiusBottom () const
virtual float getRadiusTop () const
virtual const GeoTessProfileTypegetType () const
virtual double getValue (int attributeIndex, int nodeIndex) const
virtual double getValue (const GeoTessInterpolatorType &rInterpType, int attributeIndex, double radius, bool allowRadiusOutOfRange) const
virtual double getValueTop (int attributeIndex) const
virtual bool isNaN (int nodeIndex, int attributeIndex)
virtual bool operator== (const GeoTessProfile &p) const
virtual void setData (const vector< GeoTessData * > &inData)
virtual void setData (int index, GeoTessData *inData)
virtual void setRadii (const vector< float > &newRadii)

Static Public Member Functions

static string class_name ()

Detailed Description

A Profile object that defines two radii, one at the bottom and other at the top of the associated layer, and a single Data object that represents the model values throughout the layer.


Constructor & Destructor Documentation

geotess::GeoTessProfileConstant::GeoTessProfileConstant ( float  radBot,
float  radTop,
GeoTessData dat 
) [inline]

Default constructor.


Member Function Documentation

static string geotess::GeoTessProfileConstant::class_name ( ) [inline, static]

Returns the class name.

Reimplemented from geotess::GeoTessProfile.

virtual int geotess::GeoTessProfileConstant::class_size ( ) const [inline, virtual]

Returns the class size.

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessData** geotess::GeoTessProfileConstant::getData ( ) [inline, virtual]

Retrieve a shallow copy of all of the Data objects associated with this Profile.

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessData* geotess::GeoTessProfileConstant::getData ( int  i) [inline, virtual]

Retrieve a reference the i'th Data object

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileConstant::getData ( int  i) const [inline, virtual]

Retrieve a reference the i'th Data object

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileConstant::getDataBottom ( ) const [inline, virtual]

Get the Data object at the bottom of the profile.

Reimplemented from geotess::GeoTessProfile.

Get the Data object at the bottom of the profile.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileConstant::getDataTop ( ) const [inline, virtual]

Get the Data object at the top of the profile.

Reimplemented from geotess::GeoTessProfile.

Get the Data object at the top of the profile.

Reimplemented from geotess::GeoTessProfile.

virtual int geotess::GeoTessProfileConstant::getNData ( ) const [inline, virtual]

Get the number of Data objects that comprise this profile.

Reimplemented from geotess::GeoTessProfile.

virtual int geotess::GeoTessProfileConstant::getNRadii ( ) const [inline, virtual]

Get the number of radii that comprise this profile.

Reimplemented from geotess::GeoTessProfile.

virtual float* geotess::GeoTessProfileConstant::getRadii ( ) [inline, virtual]

Retrieve a deep copy of the radii values in km.

Reimplemented from geotess::GeoTessProfile.

virtual float geotess::GeoTessProfileConstant::getRadius ( int  i) const [inline, virtual]

Get the i'th radius value in this profile in km. Radii are in order of increasing radius.

Reimplemented from geotess::GeoTessProfile.

virtual float geotess::GeoTessProfileConstant::getRadiusBottom ( ) const [inline, virtual]

Get the radius at the bottom of the profile, in km.

Reimplemented from geotess::GeoTessProfile.

virtual float geotess::GeoTessProfileConstant::getRadiusTop ( ) const [inline, virtual]

Get the radius at the top of the profile, in km.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessProfileType& geotess::GeoTessProfileConstant::getType ( ) const [inline, virtual]

Returns ProfileType (CONSTANT).

Returns:
ProfileType (CONSTANT).

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileConstant::getValue ( int  attributeIndex,
int  nodeIndex 
) const [inline, virtual]

Retrieve the value of the specified attribute interpolated from this profile at the specified radius index

Parameters:
attributeIndex
nodeIndex
Returns:
double

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileConstant::getValue ( const GeoTessInterpolatorType rInterpType,
int  attributeIndex,
double  radius,
bool  allowRadiusOutOfRange 
) const [inline, virtual]

Retrieve the value of the specified attribute interpolated at the specified radius.

Parameters:
rInterpTypeeither Int
attributeIndex
radiusradius in km
allowRadiusOutOfRange
Returns:
interpolated attribute value

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileConstant::getValueTop ( int  attributeIndex) const [inline, virtual]

Retrieve the value of the specified attribute at the top of the layer.

Parameters:
attributeIndex
Returns:
double

Reimplemented from geotess::GeoTessProfile.

virtual bool geotess::GeoTessProfileConstant::isNaN ( int  nodeIndex,
int  attributeIndex 
) [inline, virtual]

Return true if the specified Data value is NaN. For doubles and floats, this means not NaN. For bytes, shorts, ints and longs, always returns false since there is no value that is NaN.

Parameters:
nodeIndex
attributeIndex
Returns:
true if the specified Data value is NaN.

Reimplemented from geotess::GeoTessProfile.

virtual bool geotess::GeoTessProfileConstant::operator== ( const GeoTessProfile p) const [inline, virtual]

Return true if the input Profile object (p) equals this Profile object.

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileConstant::setData ( const vector< GeoTessData * > &  inData) [inline, virtual]

Resets the data object to the new input data

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileConstant::setData ( int  index,
GeoTessData inData 
) [inline, virtual]

Resets the data object at index to the new input data.

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileConstant::setRadii ( const vector< float > &  newRadii) [inline, virtual]

Replace the radii currently associated with this Profile with new values.

Reimplemented from geotess::GeoTessProfile.


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