DNCUtil::QueryResults::FeatureDescription Class Reference

#include <dnc_util.h>

Classes
class	AttributePair

Public Member Functions
	FeatureDescription (const char *const covName, const char *const featClassName, const char *const faccCode, const unsigned int featIndex, const char *const featureName, const VPFUtil::FeatureType featureType, const VPFUtil::Coord2DShort &location)
	~FeatureDescription ()
bool	IsValid (void) const
const char *	GetCoverageName (void) const
const char *	GetFeatureClassName (void) const
const char *	GetFACCCode (void) const
unsigned int	GetFeatureIndex (void) const
const char *	GetFeatureName (void) const
VPFUtil::FeatureType	GetFeatureType (void) const
VPFUtil::Coord2DShort	GetLocation (void) const
unsigned int	GetAttributePairCount (void) const
const AttributePair *	GetAttributePair (const unsigned int attribPairNum) const
bool	AddAttributePair (AttributePair *const attributePair)

Protected Types
typedef VPFUtil::PointerArray< AttributePair >	AttributePairArray

Protected Attributes
VPFUtil::WarningBool	_isValid
const DNCString	_covName
const DNCString	_featClassName
const DNCString	_faccCode
const unsigned int	_featIndex
const DNCString	_featureName
const VPFUtil::FeatureType	_featureType
const VPFUtil::Coord2DShort	_location
AttributePairArray	_attributePairs

Detailed Description

description of a feature in the query results

Member Typedef Documentation

typedef VPFUtil::PointerArray<AttributePair> AttributePairArray

protected

array of attribute pairs

Constructor & Destructor Documentation

FeatureDescription	(	const char *const	covName,
		const char *const	featClassName,
		const char *const	faccCode,
		const unsigned int	featIndex,
		const char *const	featureName,
		const VPFUtil::FeatureType	featureType,
		const VPFUtil::Coord2DShort &	location
	)

Ctor

Parameters

covName	name of coverage that contains this feature
featClassName	name of feature class that contains this feature
faccCode	FACC code for feature else NULL if feature does not use FACC codes
featIndex	zero based index into feature class for this feature
featureName	name of feature
featureType	type of feature
location	location of feature

~FeatureDescription

(

)

Dtor

Member Function Documentation

bool AddAttributePair

(

AttributePair *const

attributePair

)

add an attribute pair to this description. NOTE: FeatureDescription does not deep copy the attribute pair and owns the attribute pair if this method returns success

Parameters

attributePair

attribute description

Returns

true if success else false

const AttributePair* GetAttributePair

(

const unsigned int

attribPairNum

)

const

Get an attribute pair from this description

Parameters

attribPairNum

zero based index to desired attribute pair ( < GetAttributePairCount() )

Returns

desired attribute pair else NULL

unsigned int GetAttributePairCount

(

void

)

const

Get the number of attribute pairs in this feature description

Returns

number of attribute pairs in this feature description

const char* GetCoverageName ( void  ) const

inline

Get the name of the coverage that contains this feature

Returns

name of the coverage that contains this feature

const char* GetFACCCode ( void  ) const

inline

Get the FACC code for feature else "" if feature does not use FACC codes

Returns

FACC code for feature else "" if feature does not use FACC codes

const char* GetFeatureClassName ( void  ) const

inline

Get the name of the feature class that contains this feature

Returns

name of the feature class that contains this feature

unsigned int GetFeatureIndex ( void  ) const

inline

Get the zero based index into feature class for this feature

Returns

zero based index into feature class for this feature

const char* GetFeatureName ( void  ) const

inline

Get the name of the feature

Returns

name of the feature

VPFUtil::FeatureType GetFeatureType ( void  ) const

inline

Get the type of the feature

Returns

type of the feature

VPFUtil::Coord2DShort GetLocation ( void  ) const

inline

Get the location of the feature (lon/lat)

Returns

location of the feature (lon/lat)

bool IsValid ( void  ) const

inline

Determine if the feature description is valid

Returns

true if valid else false

Member Data Documentation

AttributePairArray _attributePairs

protected

array of attribute pairs

const DNCString _covName

protected

name of coverage that contains this feature

const DNCString _faccCode

protected

FACC code for feature else "" if feature does not use FACC codes

const DNCString _featClassName

protected

name of feature class that contains this feature

const unsigned int _featIndex

protected

zero based index into feature class for this feature

const DNCString _featureName

protected

name of feature

const VPFUtil::FeatureType _featureType

protected

feature type

VPFUtil::WarningBool _isValid

protected

true if feature description is valid else false

const VPFUtil::Coord2DShort _location

protected

location of feature (lon/lat)

---

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

• dnc_util.h