Abstract class that manages the radii and data values that span a single layer associated with a single vertex in the model. More...

#include <GeoTessProfile.h>

Inheritance diagram for geotess::GeoTessProfile:

Public Member Functions
virtual int	class_size () const
	Returns the class size. More...

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 GeoTessData **	getData ()
	Retrieve a shallow copy of the array of Data objects associated with this Profile. More...

virtual GeoTessData *	getData (int i)
	Retrieve a reference the i'th Data object. More...

virtual const GeoTessData &	getData (int i) const
	Retrieve a reference the i'th Data object. More...

virtual const GeoTessData &	getDataBottom () const
	Get the Data object at the bottom of the profile. More...

virtual GeoTessData *	getDataBottom ()
	Get the Data object at the bottom of the profile. More...

virtual const GeoTessData &	getDataTop () const
	Get the Data object at the top of the profile. More...

virtual GeoTessData *	getDataTop ()
	Get the Data object at the top of the profile. More...

virtual double	getInterpolationCoefficient (int i, double radius, bool allowOutOfRange) const
	find interpolation coefficient. 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 copy of the array of 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...

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

virtual float	getRadiusTop () const
	Get the radius at the top of the profile, in km. More...

double	getThickness ()
	Return the thickness of the layer in km. More...

virtual const GeoTessProfileType &	getType () const
	One of EMPTY, THIN, CONSTANT, NPOINT, SURFACE. 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...

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	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 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) profile type is the same as this Profile object. More...

virtual void	setData (int index, GeoTessData *data)
	Replace the Data currently associated with this Profile with new Data. More...

virtual void	setData (const vector< GeoTessData * > &inData)
	Replace the Data currently associated with this Profile with new 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 radius)
	Replace the radius at the specified nodeIndex. More...

Static Public Member Functions
static int	class_count ()
	Returns the class instance count. More...

static string	class_name ()
	Returns the class name. More...

static GeoTessProfile *	newProfile (const vector< float > &radii, vector< GeoTessData * > &data)
	Static factory method that instantiates a new Profile object of the appropriate type. More...

static GeoTessProfile *	newProfile (const vector< float > &radii, vector< vector< double > > &data)

static GeoTessProfile *	newProfile (const vector< float > &radii, vector< vector< float > > &data)

static GeoTessProfile *	newProfile (const vector< float > &radii, vector< vector< LONG_INT > > &data)

static GeoTessProfile *	newProfile (const vector< float > &radii, vector< vector< int > > &data)

static GeoTessProfile *	newProfile (const vector< float > &radii, vector< vector< short > > &data)

static GeoTessProfile *	newProfile (const vector< float > &radii, vector< vector< byte > > &data)

static GeoTessProfile *	newProfile (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 GeoTessProfile *	newProfile (float radii, const int &nRadii, double *values, const int &nNodes, const int &nAttributes)

static GeoTessProfile *	newProfile (float radii, const int &nRadii, float *values, const int &nNodes, const int &nAttributes)

static GeoTessProfile *	newProfile (float radii, const int &nRadii, LONG_INT *values, const int &nNodes, const int &nAttributes)

static GeoTessProfile *	newProfile (float radii, const int &nRadii, int *values, const int &nNodes, const int &nAttributes)

static GeoTessProfile *	newProfile (float radii, const int &nRadii, short *values, const int &nNodes, const int &nAttributes)

static GeoTessProfile *	newProfile (float radii, const int &nRadii, byte *values, const int &nNodes, const int &nAttributes)

Detailed Description

Abstract class that manages the radii and data values that span a single layer associated with a single vertex in the model.

An abstract class that manages the radii and data values that span a single layer associated with a single vertex in the model. The following Profile types are supported:

ProfileNPoint is comprised on 2 or more monotonically increasing radius values and an equal number of Data objects which define the distribution of model values in the profile.
ProfileConstant is comprised of two radius values, one defining the bottom of the layer and the other the top of the layer. There is a single Data object which defines the model values for the entire profile.
ProfileThin represents a profile with zero thickness. It is comprised of a single radius value and a single Data object.
ProfileEmpty defines a profile with no Data. It is comprised of two radius values, one for the bottom of the layer and the other for the top of the layer. Any request for model values will return NaN_DOUBLE.
ProfileSurface profiles are comprised of only a single Data object and no radius values. They are used to support 2D models where the radius of the Data values is not used. ProfileSurface objects and all the other Profile types are incompatible in the sense that they may not coexist in the same model (a model is either 2D or 3D, but never both).

Member Function Documentation

static int geotess::GeoTessProfile::class_count ( )

inlinestatic

Returns the class instance count.

static string geotess::GeoTessProfile::class_name ( )

inlinestatic

Returns the class name.

virtual int geotess::GeoTessProfile::class_size ( ) const

inlinevirtual

Returns the class size.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

virtual int geotess::GeoTessProfile::findClosestRadiusIndex ( double radius ) const

virtual

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

Reimplemented in geotess::GeoTessProfileEmpty.

virtual GeoTessData** geotess::GeoTessProfile::getData ( )

virtual

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

Caller assumes ownership of the array, but not the contents, and must delete the array when done with it.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, geotess::GeoTessProfileConstant, and geotess::GeoTessProfileSurfaceEmpty.

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

virtual

Retrieve a reference the i'th Data object.

This Profile retains ownership of the returned Data object; caller should not delete it.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, geotess::GeoTessProfileConstant, and geotess::GeoTessProfileSurfaceEmpty.

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

virtual

Retrieve a reference the i'th Data object.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, geotess::GeoTessProfileConstant, and geotess::GeoTessProfileSurfaceEmpty.

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

virtual

Get the Data object at the bottom of the profile.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

virtual GeoTessData* geotess::GeoTessProfile::getDataBottom ( )

virtual

Get the Data object at the bottom of the profile.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

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

virtual

Get the Data object at the top of the profile.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

virtual GeoTessData* geotess::GeoTessProfile::getDataTop ( )

virtual

Get the Data object at the top of the profile.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

virtual double geotess::GeoTessProfile::getInterpolationCoefficient	(	int	i,
		double	radius,
		bool	allowOutOfRange
	)		const

inlinevirtual

find interpolation coefficient.

Parameters

i	the index in radii such that radius is between radii[index] and radii[index+1].
radius	the radius whose interpolation coefficient is desired.
allowOutOfRange	if false and the supplied radius is out of range then this method returns NaN_DOUBLE.

Returns: c[index], the interpolation coefficient to be applied at radii[index]. The interpolation coefficient for radii[index+1] is 1-c[index].

Reimplemented in geotess::GeoTessProfileNPoint.

virtual LONG_INT geotess::GeoTessProfile::getMemory ( )

virtual

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

virtual int geotess::GeoTessProfile::getNData ( ) const

virtual

Get the number of Data objects that comprise this profile.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileSurfaceEmpty, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileConstant.

virtual int geotess::GeoTessProfile::getNRadii ( ) const

virtual

Get the number of radii that comprise this profile.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileSurfaceEmpty, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileConstant.

virtual int geotess::GeoTessProfile::getPointIndex ( int nodeIndex ) const

virtual

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 in geotess::GeoTessProfileEmpty.

virtual float* geotess::GeoTessProfile::getRadii ( )

virtual

Retrieve a copy of the array of radii values in km.

Caller assumes ownership of the array and must delete it when done with it.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileSurfaceEmpty, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileConstant.

virtual float geotess::GeoTessProfile::getRadius ( int i ) const

virtual

Get the i'th radius value in this profile in km.

Radii are in order of increasing radius.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileSurfaceEmpty, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileConstant.

virtual float geotess::GeoTessProfile::getRadiusBottom ( ) const

virtual

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

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

int geotess::GeoTessProfile::getRadiusIndex ( double radius ) const

inline

Find index i such that radius is >= radii[i] and < radii[i+1].

If radius < radii[1] returns 0. If radius >= radii[xx.length-2] return radii.length-2.

virtual int geotess::GeoTessProfile::getRadiusIndex	(	double	radius,
		int	jlo
	)		const

inlinevirtual

Find index i such that radius is >= radii[i] and < radii[i+1].

If radius < radii[1] returns 0. If radius >= radii[xx.length-2] return radii.length-2.

Parameters

radius
jlo	index found by a previous search. Used as an initial guess to improve performance of the search. Specify -1 if none available.

Reimplemented in geotess::GeoTessProfileNPoint.

virtual float geotess::GeoTessProfile::getRadiusTop ( ) const

virtual

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

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileSurfaceEmpty, geotess::GeoTessProfileThin, and geotess::GeoTessProfileSurface.

double geotess::GeoTessProfile::getThickness ( )

inline

Return the thickness of the layer in km.

virtual const GeoTessProfileType& geotess::GeoTessProfile::getType ( ) const

virtual

One of EMPTY, THIN, CONSTANT, NPOINT, SURFACE.

Returns: ProfileType

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

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

virtual

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

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileConstant, geotess::GeoTessProfileSurface, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, and geotess::GeoTessProfileSurfaceEmpty.

double geotess::GeoTessProfile::getValue	(	const vector< int > &	nodeIds,
		const vector< double > &	coefficients,
		int	attributeIndex
	)		const

inline

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

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

virtual

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

Parameters

attributeIndex
nodeIndex

Returns: double

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileConstant, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileSurface, geotess::GeoTessProfileThin, and geotess::GeoTessProfileSurfaceEmpty.

virtual double geotess::GeoTessProfile::getValueBottom ( int attributeIndex ) const

inlinevirtual

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

Parameters

attributeIndex

Returns: double

Reimplemented in geotess::GeoTessProfileEmpty.

virtual double geotess::GeoTessProfile::getValueTop ( int attributeIndex ) const

virtual

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

Parameters

attributeIndex

Returns: double

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileConstant, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

virtual bool geotess::GeoTessProfile::isNaN	(	int	nodeIndex,
		int	attributeIndex
	)

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 in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileConstant, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	const vector< float > &	radii,
		vector< GeoTessData * > &	data
	)

static

Static factory method that instantiates a new Profile object of the appropriate type.

If radii.size() == 2 and data.size() == 0, creates a ProfileEmpty object.
If radii.size() == 1 and data.size() == 1, creates a ProfileThin object.
If radii.size() == 2 and data.size() == 1, creates a ProfileConstant object.
If radii.size() >= 2 and data.size() == nRadii, creates a ProfileNPoint object.
If radii.size() == 0 and data.size() == 1, creates a ProfileSurface object.

This method copies the radius values and Data* pointers out of the provided vectors into its owne structures. Profile assumes ownership of the Data* pointers and will delete them when no longer needed.

Parameters

radii	an array of zero or more radius values, in km. Values must be monotonically increasing.
data	an array of pointers to Data objects.

Returns: a new Profile object

Exceptions

GeoTessException

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	const vector< float > &	radii,
		vector< vector< double > > &	data
	)

static

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	const vector< float > &	radii,
		vector< vector< float > > &	data
	)

static

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	const vector< float > &	radii,
		vector< vector< LONG_INT > > &	data
	)

static

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	const vector< float > &	radii,
		vector< vector< int > > &	data
	)

static

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	const vector< float > &	radii,
		vector< vector< short > > &	data
	)

static

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	const vector< float > &	radii,
		vector< vector< byte > > &	data
	)

static

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	float *	radii,
		const int &	nRadii,
		GeoTessData **	data,
		const int &	nData
	)

static

Static factory method that instantiates a new Profile object of the appropriate type.

If nRadii == 2 and nData == 0, creates a ProfileEmpty object.
If nRadii == 1 and nData == 1, creates a ProfileThin object.
If nRadii == 2 and nData == 1, creates a ProfileConstant object.
If nRadii >= 2 and nData == nRadii, creates a ProfileNPoint object.
If nRadii == 0 and nData == 1, creates a ProfileSurface object.

This method copies the radius values and Data* pointers out of the provided arrays into its own structures. Profile assumes ownership of the Data* pointers and will delete them when no longer needed. The callers retains ownership of the containing arrays however and should delete them when no longer needed.

Parameters

radii	an array of zero or more radius values, in km. Values must be monotonically increasing.
nRadii	the length of the radii array.
data	an array of pointers to Data objects.
nData	the length of the data array

Returns: a new Profile object

Exceptions

GeoTessException

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	float *	radii,
		const int &	nRadii,
		double **	values,
		const int &	nNodes,
		const int &	nAttributes
	)

inlinestatic

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	float *	radii,
		const int &	nRadii,
		float **	values,
		const int &	nNodes,
		const int &	nAttributes
	)

inlinestatic

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	float *	radii,
		const int &	nRadii,
		LONG_INT **	values,
		const int &	nNodes,
		const int &	nAttributes
	)

inlinestatic

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	float *	radii,
		const int &	nRadii,
		int **	values,
		const int &	nNodes,
		const int &	nAttributes
	)

inlinestatic

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	float *	radii,
		const int &	nRadii,
		short **	values,
		const int &	nNodes,
		const int &	nAttributes
	)

inlinestatic

static GeoTessProfile* geotess::GeoTessProfile::newProfile	(	float *	radii,
		const int &	nRadii,
		byte **	values,
		const int &	nNodes,
		const int &	nAttributes
	)

inlinestatic

virtual bool geotess::GeoTessProfile::operator== ( const GeoTessProfile & p ) const

inlinevirtual

Return true if the input Profile object (p) profile type is the same as this Profile object.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, and geotess::GeoTessProfileSurfaceEmpty.

virtual void geotess::GeoTessProfile::setData	(	int	index,
		GeoTessData *	data
	)

virtual

Replace the Data currently associated with this Profile with new Data.

The current Data objects are deleted.

This Profile assumes ownership of the input Data objects and will delete them when appropriate.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, geotess::GeoTessProfileConstant, and geotess::GeoTessProfileSurfaceEmpty.

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

virtual

Replace the Data currently associated with this Profile with new Data.

The current Data objects are deleted.

This Profile assumes ownership of the input Data objects and will delete them when appropriate.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileThin, geotess::GeoTessProfileSurface, geotess::GeoTessProfileConstant, and geotess::GeoTessProfileSurfaceEmpty.

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

virtual

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

Radius values are copied from the supplied vector. This Profile does NOT keep a reference to the input vector.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileSurfaceEmpty, geotess::GeoTessProfileThin, and geotess::GeoTessProfileSurface.

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

virtual

Replace the radius at the specified nodeIndex.

Reimplemented in geotess::GeoTessProfileNPoint, geotess::GeoTessProfileEmpty, geotess::GeoTessProfileConstant, geotess::GeoTessProfileSurfaceEmpty, geotess::GeoTessProfileThin, and geotess::GeoTessProfileSurface.

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

include/GeoTessProfile.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation