Feature nomenclature database querier. More...

#include <FeatureNomenclature.h>

Inheritance diagram for Isis::FeatureNomenclature:

Collaboration diagram for Isis::FeatureNomenclature:

Classes
class	Feature
	A named feature on a target. More...

Public Types
enum	IAUStatus { NoStatus, Approved, Dropped, Unapproved }
	Enumeration of approval statuses. More...

Signals
void	featuresIdentified (FeatureNomenclature *)
	This is emitted when a query is completed.

Public Member Functions
	FeatureNomenclature ()
	Instantiate a feature nomenclature.

	FeatureNomenclature (const FeatureNomenclature &other)
	Copy a feature nomenclature.

	~FeatureNomenclature ()
	Frees allocated memory.

void	queryFeatures (QString target, Latitude startLat, Longitude startLon, Latitude endLat, Longitude endLon)
	Makes sure the longitudinal ranges are correct.

QList< Feature >	features () const
	This gives you the features found in all of the queries so far.

bool	hasResult () const
	Test if any understandable results have been received from the nomenclature database.

void	swap (FeatureNomenclature &other)
	Swap the instances *this and other.

FeatureNomenclature &	operator= (const FeatureNomenclature &other)
	This takes on the data from rhs.

Static Public Member Functions
static bool	featureDiameterGreaterThan (const FeatureNomenclature::Feature &lhs, const FeatureNomenclature::Feature &rhs)
	Compare the diameter of two features.

Private Slots
void	requestFinished (QNetworkReply *)
	This is called when a query is done.

Private Member Functions
void	readSearchResults (QDomElement)
	This is a helper method for requestFinished.

void	runQuery (QString target, Latitude startLat, Longitude startLon, Latitude endLat, Longitude endLon)
	Query the nomenclature database for features inside the given range on the target.

Private Attributes
QNetworkAccessManager *	m_networkMgr
	Network manager does request.

QNetworkRequest *	m_request
	Network request sent.

QList< Feature > *	m_features
	These are the features identified by the nomenclature database.

IAUStatus	m_statusApproval
	The approval status of the feature from the database.

bool	m_lastQuery
	True if all queries have finished.

Detailed Description

Feature nomenclature database querier.

This class queries the nomenclature database for features. To use this class, you create a blank instance. Then you connect to the featuresIdentified() signal. Finally, you call query with the appropriate input data. You can call query as many times as you want; featuresIdentified() will be emitted the same number of times. Finally, you can access the features with features().

Author: 2012-03-14 Steven Lambright

History:

2012-06-06 Steven Lambright and Kimbelry Oyama - Added an enumerator for the approval status of each feature. Modified queryFeatures() to ensure the correct longitude domain is used. References #852. Fixes #892. Fixes #855.

2012-06-29 Steven Lambright and Kimberly Oyama - Separated queryFeatures() into: 1) queryFeatures(), which makes sure the longitude range is between 0 and 360 and that it is in the 360 domain, and calls the request method, and 2) runQuery(), which makes the request. Fixes #958.

Definition at line 48 of file FeatureNomenclature.h.

Member Enumeration Documentation

enum Isis::FeatureNomenclature::IAUStatus

Enumeration of approval statuses.

Enumerator
NoStatus	When this status is assigned to a feature, there will be no status displayed and the feature will not be shown if the IAU approved only checkbox is checked.
Approved	When this status is assigned to a feature, the displayed status will be "Adopted by the IAU" and the feature will always be shown.
Dropped	When this status is assigned to a feature, the displayed status will be "Dropped, disallowed" and the feature will not be shown if the IAU approved only checkbox is checked.
Unapproved	When this status is assigned to a feature, the displayed status will be "Never approved by the IAU" and the feature will not be shown if the IAU approved only checkbox checked.

Definition at line 54 of file FeatureNomenclature.h.

Constructor & Destructor Documentation

Isis::FeatureNomenclature::FeatureNomenclature ( )

Instantiate a feature nomenclature.

This prepares to make network requests.

Definition at line 28 of file FeatureNomenclature.cpp.

References m_features, m_lastQuery, m_networkMgr, m_request, and requestFinished().

Isis::FeatureNomenclature::FeatureNomenclature ( const FeatureNomenclature & other )

Copy a feature nomenclature.

Data being queried currently will not be available in the copy, but ready results will be available.

Parameters

other The feature nomenclature to copy

Definition at line 55 of file FeatureNomenclature.cpp.

References m_features, m_lastQuery, m_networkMgr, m_request, and requestFinished().

Isis::FeatureNomenclature::~FeatureNomenclature ( )

Frees allocated memory.

Definition at line 76 of file FeatureNomenclature.cpp.

References m_features, m_networkMgr, and m_request.

Member Function Documentation

bool Isis::FeatureNomenclature::featureDiameterGreaterThan	(	const FeatureNomenclature::Feature &	lhs,
		const FeatureNomenclature::Feature &	rhs
	)

static

Compare the diameter of two features.

This is very useful for sorting with qSort(). If lhs > rhs, then this returns true. This considers valid data

invalid data.

Parameters

lhs	The left hand side of the '>' operator
rhs	The right hand side of the '>' operator

Returns: lhs > rhs

Definition at line 192 of file FeatureNomenclature.cpp.

References Isis::FeatureNomenclature::Feature::diameter(), and Isis::Distance::isValid().

Referenced by Isis::FeatureNomenclatureTool::ViewportFeatureDisplay::ViewportFeatureDisplay().

QList< FeatureNomenclature::Feature > Isis::FeatureNomenclature::features ( ) const

This gives you the features found in all of the queries so far.

If all of the queries are finished, then this list will contain all of the results. The list will be empty if no queries have succeeded so far.

Returns: a cumulative list of all of the features found so far.

Definition at line 135 of file FeatureNomenclature.cpp.

References m_features.

void Isis::FeatureNomenclature::featuresIdentified ( FeatureNomenclature * )

signal

This is emitted when a query is completed.

When emitted, the this pointer is provided.

Referenced by requestFinished().

bool Isis::FeatureNomenclature::hasResult ( ) const

Test if any understandable results have been received from the nomenclature database.

Returns: True if any queries have succeeded.

Definition at line 151 of file FeatureNomenclature.cpp.

References m_features.

FeatureNomenclature & Isis::FeatureNomenclature::operator= ( const FeatureNomenclature & rhs )

This takes on the data from rhs.

Active queries will not be copied. This is exception safe.

Parameters

rhs	The FeatureNomenclature on the right hand side of the '='

Returns: *this

Definition at line 175 of file FeatureNomenclature.cpp.

References swap().

void Isis::FeatureNomenclature::queryFeatures	(	QString	target,
		Latitude	startLat,
		Longitude	startLon,
		Latitude	endLat,
		Longitude	endLon
	)

Makes sure the longitudinal ranges are correct.

If the range intersects with the 0 line the range is split into two ranges, the minimum to 360 and 0 to the maximum. Then it runs a query on each range.

Parameters

target	The target for which features might be present
startLat	The minimum latitude of the ground range to search
startLon	The minimum longitude of the ground range to search
endLat	The maximum latitude of the ground range to search
endLon	The maximum longitude of the ground range to search

Definition at line 99 of file FeatureNomenclature.cpp.

References m_lastQuery, runQuery(), and Isis::Longitude::to360Range().

void Isis::FeatureNomenclature::readSearchResults ( QDomElement xmlSearchResults )

private

This is a helper method for requestFinished.

This takes the search results and creates a Feature for each equivalent XML feature element.

Parameters

xmlSearchResults The searchresults XML from the nomenclature server.

Definition at line 853 of file FeatureNomenclature.cpp.

References Approved, Dropped, m_features, m_statusApproval, NoStatus, and Unapproved.

Referenced by requestFinished().

void Isis::FeatureNomenclature::requestFinished ( QNetworkReply * reply )

privateslot

This is called when a query is done.

This adds the features to our feature list and emits featuresIdentified().

Parameters

reply The server's response to our request, containing features in XML form.

Definition at line 800 of file FeatureNomenclature.cpp.

References featuresIdentified(), m_lastQuery, and readSearchResults().

Referenced by FeatureNomenclature().

void Isis::FeatureNomenclature::runQuery	(	QString	target,
		Latitude	startLat,
		Longitude	startLon,
		Latitude	endLat,
		Longitude	endLon
	)

private

Query the nomenclature database for features inside the given range on the target.

When the last query for the cube is done, featuresIdentified() will be emitted.

You can call query as many times as you'd like, but the results will be cumulative. Errors are reported in the form of a message box.

Parameters

target	The target for which features might be present
startLat	The minimum latitude of the ground range to search
startLon	The minimum longitude of the ground range to search
endLat	The maximum latitude of the ground range to search
endLon	The maximum longitude of the ground range to search