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::GeoTessProfileEmpty Class Reference

A Profile object that defines two radii at the bottom and top of the associated layer, and no Data. More...

#include <GeoTessProfileEmpty.h>

Inheritance diagram for geotess::GeoTessProfileEmpty:
geotess::GeoTessProfile

Public Member Functions

 GeoTessProfileEmpty (float radBot, float radTop)
 Default constructor. More...
 
 GeoTessProfileEmpty (IFStreamBinary &ifs)
 Standard constructor. More...
 
 GeoTessProfileEmpty (IFStreamAscii &ifs)
 Standard constructor. More...
 
 GeoTessProfileEmpty (float radii[], int &rIndex)
 Standard constructor creates references into the supplied array of radii. More...
 
virtual ~GeoTessProfileEmpty ()
 Default destructor. More...
 
virtual int class_size () const
 Returns the class size. More...
 
virtual GeoTessProfilecopy ()
 Returns a deep copy of this profile. More...
 
virtual int findClosestRadiusIndex (double radius) const
 Find the index of the node in this Profile that has radius closest to the supplied radius. More...
 
virtual void getCoefficients (map< int, double > &coefficients, double radius, double horizontalCoefficient) const
 
virtual GeoTessData ** getData ()
 Retrieve a reference to all of the Data obects associated with this Profile. 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 int getPointIndex (int nodeIndex) const
 Get the pointIndex that corresponds to the supplied nodeIndex. 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 (EMPTY). More...
 
virtual double getValue (const GeoTessInterpolatorType &rInterpType, int attributeIndex, double radius, bool allowRadiusOutOfRange) const
 Retrieve the value of the specified attribute interpolated at the specified radius. More...
 
virtual double getValue (int attributeIndex, int nodeIndex) const
 Retrieve the value of the specified attribute interpolated from this profile at the specified radius index. More...
 
virtual double getValueBottom (int attributeIndex) const
 Retrieve the value of the specified attribute at the bottom of the layer. More...
 
virtual double getValueTop (int attributeIndex) const
 Retrieve the value of the specified attribute at the top of the layer. More...
 
virtual void getWeights (map< int, double > &weights, double dkm, double radius, double hcoefficient) const
 Add dkm * hcoefficient to the weight of this point index into the input map. 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 resetPointIndices ()
 Reset all the pointIndex values to -1. 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 setInterpolationCoefficients (const GeoTessInterpolatorType &interpType, vector< int > &nodeIndexes, vector< double > &coefficients, double &radius, bool &allowOutOfRange)
 
virtual void setPointIndex (int nodeIndex, int pointIndex)
 Set the pointIndex that corresponds to the supplied nodeIndex. 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 radius)
 Replace the radius at the specified nodeIndex. More...
 
virtual void write (IFStreamBinary &ofs)
 Write the radii and data values to binary file. More...
 
virtual void write (IFStreamAscii &ofs)
 Write the radii and data values to binary file. More...
 
- Public Member Functions inherited from geotess::GeoTessProfile
virtual double getInterpolationCoefficient (int i, double radius, bool allowOutOfRange) const
 find interpolation coefficient. 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...
 

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 that defines two radii at the bottom and top of the associated layer, and no Data.

A Profile object that defines two radii, one at the bottom and other at the top of the associated layer, and no Data. Profiles of this type should never be connected together by the connectivity of a tessellation.

Constructor & Destructor Documentation

geotess::GeoTessProfileEmpty::GeoTessProfileEmpty ( float  radBot,
float  radTop 
)
inline

Default constructor.

geotess::GeoTessProfileEmpty::GeoTessProfileEmpty ( IFStreamBinary ifs)
inline

Standard constructor.

Reads radii from the provided input file stream.

geotess::GeoTessProfileEmpty::GeoTessProfileEmpty ( IFStreamAscii ifs)
inline

Standard constructor.

Reads radii from the provided input file stream.

geotess::GeoTessProfileEmpty::GeoTessProfileEmpty ( float  radii[],
int &  rIndex 
)
inline

Standard constructor creates references into the supplied array of radii.

virtual geotess::GeoTessProfileEmpty::~GeoTessProfileEmpty ( )
inlinevirtual

Default destructor.

Member Function Documentation

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

Returns the class name.

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

Returns the class size.

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessProfile* geotess::GeoTessProfileEmpty::copy ( )
inlinevirtual

Returns a deep copy of this profile.

virtual int geotess::GeoTessProfileEmpty::findClosestRadiusIndex ( double  radius) const
inlinevirtual

Find the index of the node in this Profile that has radius closest to the supplied radius.

Parameters
radiusin km
Returns
The index of the node in this Profile that has radius closest to the supplied radius.

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileEmpty::getCoefficients ( map< int, double > &  coefficients,
double  radius,
double  horizontalCoefficient 
) const
inlinevirtual
virtual GeoTessData** geotess::GeoTessProfileEmpty::getData ( )
virtual

Retrieve a reference to all of the Data obects associated with this Profile.

Reimplemented from geotess::GeoTessProfile.

virtual GeoTessData* geotess::GeoTessProfileEmpty::getData ( int  i)
virtual

Retrieve a reference the i'th Data object.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileEmpty::getData ( int  i) const
virtual

Retrieve a reference the i'th Data object.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileEmpty::getDataBottom ( ) const
virtual

Get the Data object at the bottom of the profile.

Reimplemented from geotess::GeoTessProfile.

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

Get the Data object at the bottom of the profile.

Reimplemented from geotess::GeoTessProfile.

virtual const GeoTessData& geotess::GeoTessProfileEmpty::getDataTop ( ) const
virtual

Get the Data object at the top of the profile.

Reimplemented from geotess::GeoTessProfile.

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

Get the Data object at the top of the profile.

Reimplemented from geotess::GeoTessProfile.

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

Reimplemented from geotess::GeoTessProfile.

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

Get the number of Data objects that comprise this profile.

Reimplemented from geotess::GeoTessProfile.

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

Get the number of radii that comprise this profile.

Reimplemented from geotess::GeoTessProfile.

virtual int geotess::GeoTessProfileEmpty::getPointIndex ( int  nodeIndex) const
inlinevirtual

Get the pointIndex that corresponds to the supplied nodeIndex.

There is a node index for each Data object in a profile and they are indexed from 0 to the number of Data objects managed by a Profile. There is a pointIndex for every Data object in the entire model, indexed from 0 to the number of Data objects in the model.

Reimplemented from geotess::GeoTessProfile.

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

Retrieve a deeep copy of the radii values in km.

Reimplemented from geotess::GeoTessProfile.

virtual float geotess::GeoTessProfileEmpty::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::GeoTessProfileEmpty::getRadiusBottom ( ) const
inlinevirtual

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

Reimplemented from geotess::GeoTessProfile.

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

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

Reimplemented from geotess::GeoTessProfile.

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

Returns ProfileType (EMPTY).

Returns
ProfileType (EMPTY).

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileEmpty::getValue ( const GeoTessInterpolatorType rInterpType,
int  attributeIndex,
double  radius,
bool  allowRadiusOutOfRange 
) const
virtual

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

Unsuppported for ProfileEmpty.

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileEmpty::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::GeoTessProfile.

virtual double geotess::GeoTessProfileEmpty::getValueBottom ( int  attributeIndex) const
inlinevirtual

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

Parameters
attributeIndex
Returns
double

Reimplemented from geotess::GeoTessProfile.

virtual double geotess::GeoTessProfileEmpty::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 void geotess::GeoTessProfileEmpty::getWeights ( map< int, double > &  weights,
double  dkm,
double  radius,
double  hcoefficient 
) const
inlinevirtual

Add dkm * hcoefficient to the weight of this point index into the input map.

This works for Profile types Constant, Thin and Surface since they only have a single node in the profile. It does not work for ProfileNPoint and ProfileEmpty so they override this method.

virtual bool geotess::GeoTessProfileEmpty::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::GeoTessProfileEmpty::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::GeoTessProfileEmpty::resetPointIndices ( )
inlinevirtual

Reset all the pointIndex values to -1.

There is a node index for each Data object in a profile and they are indexed from 0 to the number of Data objects managed by a Profile. There is a pointIndex for every Data object in the entire model, indexed from 0 to the number of Data objects in the model.

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

Resets the data object to the new input data.

Reimplemented from geotess::GeoTessProfile.

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

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

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileEmpty::setInterpolationCoefficients ( const GeoTessInterpolatorType interpType,
vector< int > &  nodeIndexes,
vector< double > &  coefficients,
double &  radius,
bool &  allowOutOfRange 
)
inlinevirtual
virtual void geotess::GeoTessProfileEmpty::setPointIndex ( int  nodeIndex,
int  pointIndex 
)
inlinevirtual

Set the pointIndex that corresponds to the supplied nodeIndex.

There is a node index for each Data object in a profile and they are indexed from 0 to the number of Data objects managed by a Profile. There is a pointIndex for every Data object in the entire model, indexed from 0 to the number of Data objects in the model.

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

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

Reimplemented from geotess::GeoTessProfile.

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

Replace the radius at the specified nodeIndex.

Reimplemented from geotess::GeoTessProfile.

virtual void geotess::GeoTessProfileEmpty::write ( IFStreamBinary ofs)
inlinevirtual

Write the radii and data values to binary file.

virtual void geotess::GeoTessProfileEmpty::write ( IFStreamAscii ofs)
inlinevirtual

Write the radii and data values to binary file.


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