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

#include <ProfileConstant.h>

Inheritance diagram for geotess::ProfileConstant:
geotess::Profile

List of all members.

Public Member Functions

 ProfileConstant (float radBot, float radTop, Data *dat)
virtual int class_size () const
virtual Data ** getData ()
virtual DatagetData (int i)
virtual const DatagetData (int i) const
virtual const DatagetDataBottom () const
virtual DatagetDataBottom ()
virtual const DatagetDataTop () const
virtual DatagetDataTop ()
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 ProfileTypegetType () const
virtual double getValue (int attributeIndex, int nodeIndex) const
virtual double getValue (const InterpolatorType &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 Profile &p) const
virtual void setData (const vector< Data * > &inData)
virtual void setData (int index, Data *inData)
virtual void setRadii (const vector< float > &newRadii)
- Public Member Functions inherited from geotess::Profile
virtual int findClosestRadiusIndex (double radius) const
virtual double getInterpolationCoefficient (int i, double radius, bool allowOutOfRange) const
virtual int getPointIndex (int nodeIndex) const
int getRadiusIndex (double radius) const
virtual int getRadiusIndex (double radius, int jlo) const
double getThickness ()
double getValue (const vector< int > &nodeIds, const vector< double > &coefficients, int attributeIndex) const
virtual double getValueBottom (int attributeIndex) const

Static Public Member Functions

static string class_name ()
- Static Public Member Functions inherited from geotess::Profile
static int class_count ()
static ProfilenewProfile (const vector< float > &radii, vector< Data * > &data)
static ProfilenewProfile (const vector< float > &radii, vector< vector< double > > &data)
static ProfilenewProfile (const vector< float > &radii, vector< vector< float > > &data)
static ProfilenewProfile (const vector< float > &radii, vector< vector< LONG_INT > > &data)
static ProfilenewProfile (const vector< float > &radii, vector< vector< int > > &data)
static ProfilenewProfile (const vector< float > &radii, vector< vector< short > > &data)
static ProfilenewProfile (const vector< float > &radii, vector< vector< byte > > &data)
static ProfilenewProfile (float *radii, const int &nRadii, Data **data, const int &nData)
static ProfilenewProfile (float *radii, const int &nRadii, double **values, const int &nNodes, const int &nAttributes)
static ProfilenewProfile (float *radii, const int &nRadii, float **values, const int &nNodes, const int &nAttributes)
static ProfilenewProfile (float *radii, const int &nRadii, LONG_INT **values, const int &nNodes, const int &nAttributes)
static ProfilenewProfile (float *radii, const int &nRadii, int **values, const int &nNodes, const int &nAttributes)
static ProfilenewProfile (float *radii, const int &nRadii, short **values, const int &nNodes, const int &nAttributes)
static ProfilenewProfile (float *radii, const int &nRadii, byte **values, const int &nNodes, const int &nAttributes)

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::ProfileConstant::ProfileConstant ( float  radBot,
float  radTop,
Data dat 
)
inline

Default constructor.


Member Function Documentation

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

Returns the class name.

Reimplemented from geotess::Profile.

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

Returns the class size.

Reimplemented from geotess::Profile.

virtual Data** geotess::ProfileConstant::getData ( )
inlinevirtual

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

Reimplemented from geotess::Profile.

virtual Data* geotess::ProfileConstant::getData ( int  i)
inlinevirtual

Retrieve a reference the i'th Data object

Reimplemented from geotess::Profile.

virtual const Data& geotess::ProfileConstant::getData ( int  i) const
inlinevirtual

Retrieve a reference the i'th Data object

Reimplemented from geotess::Profile.

virtual const Data& geotess::ProfileConstant::getDataBottom ( ) const
inlinevirtual

Get the Data object at the bottom of the profile.

Reimplemented from geotess::Profile.

virtual Data* geotess::ProfileConstant::getDataBottom ( )
inlinevirtual

Get the Data object at the bottom of the profile.

Reimplemented from geotess::Profile.

virtual const Data& geotess::ProfileConstant::getDataTop ( ) const
inlinevirtual

Get the Data object at the top of the profile.

Reimplemented from geotess::Profile.

virtual Data* geotess::ProfileConstant::getDataTop ( )
inlinevirtual

Get the Data object at the top of the profile.

Reimplemented from geotess::Profile.

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

Get the number of Data objects that comprise this profile.

Reimplemented from geotess::Profile.

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

Get the number of radii that comprise this profile.

Reimplemented from geotess::Profile.

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

Retrieve a deep copy of the radii values in km.

Reimplemented from geotess::Profile.

virtual float geotess::ProfileConstant::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::Profile.

virtual float geotess::ProfileConstant::getRadiusBottom ( ) const
inlinevirtual

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

Reimplemented from geotess::Profile.

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

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

Reimplemented from geotess::Profile.

virtual const ProfileType& geotess::ProfileConstant::getType ( ) const
inlinevirtual

Returns ProfileType (CONSTANT).

Returns:
ProfileType (CONSTANT).

Reimplemented from geotess::Profile.

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

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

Parameters:
attributeIndex
nodeIndex
Returns:
double

Reimplemented from geotess::Profile.

virtual double geotess::ProfileConstant::getValue ( const InterpolatorType rInterpType,
int  attributeIndex,
double  radius,
bool  allowRadiusOutOfRange 
) const
inlinevirtual

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::Profile.

virtual double geotess::ProfileConstant::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::Profile.

virtual bool geotess::ProfileConstant::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::Profile.

virtual bool geotess::ProfileConstant::operator== ( const Profile p) const
inlinevirtual

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

Reimplemented from geotess::Profile.

virtual void geotess::ProfileConstant::setData ( const vector< Data * > &  inData)
inlinevirtual

Resets the data object to the new input data

Reimplemented from geotess::Profile.

virtual void geotess::ProfileConstant::setData ( int  index,
Data inData 
)
inlinevirtual

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

Reimplemented from geotess::Profile.

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

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

Reimplemented from geotess::Profile.


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