GeoTessCPP  2.2
Software to facilitate storage and retrieval of 3D information about the Earth.
Public Member Functions | Static Public Member Functions | List of all members
geotess::GeoTessProfileThin Class Reference

A Profile object consiting of a single radius value and a single Data object. More...

#include <GeoTessProfileThin.h>

Inheritance diagram for geotess::GeoTessProfileThin:
geotess::GeoTessProfile

Public Member Functions

 GeoTessProfileThin (float rad, GeoTessData *dat)
 Default constructor. More...
 
virtual int class_size () const
 Returns the class size. More...
 
virtual GeoTessData ** getData ()
 Retrieve a shallow copy of all of the Data objects associated with thisProfile. More...
 
virtual GeoTessDatagetData (int i)
 Retrieve a reference the i'th Data object. More...
 
virtual const GeoTessDatagetData (int i) const
 Retrieve a reference the i'th Data object. More...
 
virtual const GeoTessDatagetDataBottom () const
 Get the Data object at the bottom of the profile. More...
 
virtual GeoTessDatagetDataBottom ()
 Get the Data object at the bottom of the profile. More...
 
virtual const GeoTessDatagetDataTop () const
 Get the Data object at the top of the profile. More...
 
virtual GeoTessDatagetDataTop ()
 Get the Data object at the top of the profile. More...
 
virtual LONG_INT getMemory ()
 
virtual int getNData () const
 Get the number of Data objects that comprise this profile. More...
 
virtual int getNRadii () const
 Get the number of radii that comprise this profile. More...
 
virtual float * getRadii ()
 Retrieve a deeep copy of the radii values in km. More...
 
virtual float getRadius (int i) const
 Get the i'th radius value in this profile in km. More...
 
virtual float getRadiusBottom () const
 Get the radius at the bottom of the profile, in km. More...
 
virtual float getRadiusTop () const
 Get the radius at the top of the profile, in km. More...
 
virtual const GeoTessProfileTypegetType () const
 Returns ProfileType (THIN). More...
 
virtual double getValue (int attributeIndex, int nodeIndex) const
 Retrieve the value of the specified attribute from this profile at the specified node index. More...
 
virtual double getValue (const GeoTessInterpolatorType &rInterpType, int attributeIndex, double r, bool allowRadiusOutOfRange) const
 Retrieve the value of the specified attribute interpolated at the specified radius. More...
 
virtual double getValueTop (int attributeIndex) const
 Retrieve the value of the specified attribute at the top of the layer. More...
 
virtual bool isNaN (int nodeIndex, int attributeIndex)
 Return true if the specified Data value is NaN. More...
 
virtual bool operator== (const GeoTessProfile &p) const
 Return true if the input Profile object (p) equals this Profile object. More...
 
virtual void setData (const vector< GeoTessData * > &inData)
 Resets the data object to the new input data. More...
 
virtual void setData (int index, GeoTessData *inData)
 Resets the data object at index to the new input data. More...
 
virtual void setRadii (const vector< float > &newRadii)
 Replace the radii currently associated with this Profile with new values. More...
 
virtual void setRadius (int index, float newRadius)
 Replace the radius at the specified nodeIndex. More...
 
- Public Member Functions inherited from geotess::GeoTessProfile
virtual int findClosestRadiusIndex (double radius) const
 Find the node index of the radius in this Profile that has radius closest to the supplied radius. More...
 
virtual double getInterpolationCoefficient (int i, double radius, bool allowOutOfRange) const
 find interpolation coefficient. More...
 
virtual int getPointIndex (int nodeIndex) const
 Get the pointIndex that corresponds to the supplied nodeIndex. More...
 
int getRadiusIndex (double radius) const
 Find index i such that radius is >= radii[i] and < radii[i+1]. More...
 
virtual int getRadiusIndex (double radius, int jlo) const
 Find index i such that radius is >= radii[i] and < radii[i+1]. More...
 
double getThickness ()
 Return the thickness of the layer in km. More...
 
double getValue (const vector< int > &nodeIds, const vector< double > &coefficients, int attributeIndex) const
 Retrieve the value of the specified attribute interpolated at the specified radius. More...
 
virtual double getValueBottom (int attributeIndex) const
 Retrieve the value of the specified attribute at the bottom of the layer. More...
 

Static Public Member Functions

static string class_name ()
 Returns the class name. More...
 
- Static Public Member Functions inherited from geotess::GeoTessProfile
static int class_count ()
 Returns the class instance count. More...
 
static string class_name ()
 Returns the class name. More...
 
static GeoTessProfilenewProfile (const vector< float > &radii, vector< GeoTessData * > &data)
 Static factory method that instantiates a new Profile object of the appropriate type. More...
 
static GeoTessProfilenewProfile (const vector< float > &radii, vector< vector< double > > &data)
 
static GeoTessProfilenewProfile (const vector< float > &radii, vector< vector< float > > &data)
 
static GeoTessProfilenewProfile (const vector< float > &radii, vector< vector< LONG_INT > > &data)
 
static GeoTessProfilenewProfile (const vector< float > &radii, vector< vector< int > > &data)
 
static GeoTessProfilenewProfile (const vector< float > &radii, vector< vector< short > > &data)
 
static GeoTessProfilenewProfile (const vector< float > &radii, vector< vector< byte > > &data)
 
static GeoTessProfilenewProfile (float *radii, const int &nRadii, GeoTessData **data, const int &nData)
 Static factory method that instantiates a new Profile object of the appropriate type. More...
 
static GeoTessProfilenewProfile (float *radii, const int &nRadii, double **values, const int &nNodes, const int &nAttributes)
 
static GeoTessProfilenewProfile (float *radii, const int &nRadii, float **values, const int &nNodes, const int &nAttributes)
 
static GeoTessProfilenewProfile (float *radii, const int &nRadii, LONG_INT **values, const int &nNodes, const int &nAttributes)
 
static GeoTessProfilenewProfile (float *radii, const int &nRadii, int **values, const int &nNodes, const int &nAttributes)
 
static GeoTessProfilenewProfile (float *radii, const int &nRadii, short **values, const int &nNodes, const int &nAttributes)
 
static GeoTessProfilenewProfile (float *radii, const int &nRadii, byte **values, const int &nNodes, const int &nAttributes)
 

Detailed Description

A Profile object consiting of a single radius value and a single Data object.

It represents a profile through a layer that has no thickness.

A Profile object that consists of a single radius value and a single Data object. It represents a profile through a layer that has zero thickness.

Constructor & Destructor Documentation

geotess::GeoTessProfileThin::GeoTessProfileThin ( float  rad,
GeoTessData dat 
)
inline

Default constructor.

Member Function Documentation

static string geotess::GeoTessProfileThin::class_name ( )
inlinestatic

Returns the class name.

virtual int geotess::GeoTessProfileThin::class_size ( ) const
inlinevirtual

Returns the class size.

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessData** geotess::GeoTessProfileThin::getData ( )
inlinevirtual

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

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessData* geotess::GeoTessProfileThin::getData ( int  i)
inlinevirtual

Retrieve a reference the i'th Data object.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileThin::getData ( int  i) const
inlinevirtual

Retrieve a reference the i'th Data object.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileThin::getDataBottom ( ) const
inlinevirtual

Get the Data object at the bottom of the profile.

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessData* geotess::GeoTessProfileThin::getDataBottom ( )
inlinevirtual

Get the Data object at the bottom of the profile.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileThin::getDataTop ( ) const
inlinevirtual

Get the Data object at the top of the profile.

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessData* geotess::GeoTessProfileThin::getDataTop ( )
inlinevirtual

Get the Data object at the top of the profile.

Reimplemented from geotess::GeoTessProfile.

virtual LONG_INT geotess::GeoTessProfileThin::getMemory ( )
inlinevirtual

Reimplemented from geotess::GeoTessProfile.

virtual int geotess::GeoTessProfileThin::getNData ( ) const
inlinevirtual

Get the number of Data objects that comprise this profile.

Reimplemented from geotess::GeoTessProfile.

virtual int geotess::GeoTessProfileThin::getNRadii ( ) const
inlinevirtual

Get the number of radii that comprise this profile.

Reimplemented from geotess::GeoTessProfile.

virtual float* geotess::GeoTessProfileThin::getRadii ( )
inlinevirtual

Retrieve a deeep copy of the radii values in km.

Reimplemented from geotess::GeoTessProfile.

virtual float geotess::GeoTessProfileThin::getRadius ( int  i) const
inlinevirtual

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::GeoTessProfileThin::getRadiusBottom ( ) const
inlinevirtual

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

Reimplemented from geotess::GeoTessProfile.

virtual float geotess::GeoTessProfileThin::getRadiusTop ( ) const
inlinevirtual

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

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessProfileType& geotess::GeoTessProfileThin::getType ( ) const
inlinevirtual

Returns ProfileType (THIN).

Returns
ProfileType (THIN).

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileThin::getValue ( int  attributeIndex,
int  nodeIndex 
) const
inlinevirtual

Retrieve the value of the specified attribute from this profile at the specified node index.

Parameters
attributeIndex
nodeIndex
Returns
double

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileThin::getValue ( const GeoTessInterpolatorType rInterpType,
int  attributeIndex,
double  r,
bool  allowRadiusOutOfRange 
) const
inlinevirtual

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

Parameters
rInterpTypeeither Int
attributeIndex
rradius in km
allowRadiusOutOfRange
Returns
interpolated attribute value

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileThin::getValueTop ( int  attributeIndex) const
inlinevirtual

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

Parameters
attributeIndex
Returns
double

Reimplemented from geotess::GeoTessProfile.

virtual bool geotess::GeoTessProfileThin::isNaN ( int  nodeIndex,
int  attributeIndex 
)
inlinevirtual

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::GeoTessProfileThin::operator== ( const GeoTessProfile p) const
inlinevirtual

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

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileThin::setData ( const vector< GeoTessData * > &  inData)
inlinevirtual

Resets the data object to the new input data.

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileThin::setData ( int  index,
GeoTessData inData 
)
inlinevirtual

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

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileThin::setRadii ( const vector< float > &  newRadii)
inlinevirtual

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

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileThin::setRadius ( int  index,
float  radius 
)
inlinevirtual

Replace the radius at the specified nodeIndex.

Reimplemented from geotess::GeoTessProfile.


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