ImageInf Class Reference

#include <imageinf.h>

Inheritance diagram for ImageInf:

[legend]

List of all members.

Detailed Description

A dataset that hold all image information that is containable within the GLIMS database.

This is a class representation of the images shapefile described in the GLIMS data transfer specifications.

History:: 2006-01-09 Deborah Lee Soltesz - Tweaked as necessary to make sure the image metadata were being captured and stored

History:: 2007-06-14 Deborah Lee Soltesz - Confirmed all the information required by the GLIMS database is being captured and stored. Wrote validation function to confirm metadata is provided by user.

History:: 2007-06-14 deborah lee soltesz - removed image ID references as per e-mail from Bruce Raup same day: Image ID refers to an ID assigned by the GLIMS database ingestion process.

What's New:: 2007-06-14 Deborah Lee Soltesz Validation function checks for required metadata, and reports to ValidationReport. Provides warning for non-required invalid/missing items, and errors for required items.

Definition at line 41 of file imageinf.h.


Public Member Functions
	ImageInf ()
	Constructor sets all float values to -999.0.
virtual	~ImageInf ()
virtual bool	toXML (QDomDocument &doc, QDomElement &elem, std::string id="")
virtual bool	fromXML (QDomElement &elem)
bool	validate (ValidationReport *valRep)
	Check that required session information is present.
bool	validIso8601DateTime (std::string str)
	Do the characters in the input string represent a complete and valid date/time string?
bool	validIso8601DateTime (QString &str)
	Do the characters in the input string represent a complete and valid date/time string?
virtual bool	toXMLFile (std::string fname, std::string docname)
virtual bool	fromXMLFile (std::string fname, std::string docname)
virtual void	setCurrentVersion (std::string versionString)
virtual void	setCurrentVersion (QDate versionQDate)
virtual QDate	getCurrentVersion ()
virtual std::string	getCurrentVersionStr ()
Public Attributes
std::string	mInstID
	Instrument ID.
std::string	mOrigID
	Origin ID.
std::string	mLocURL
	Location URL.
std::string	mAquiDateTime
	Image Acquisition Date/Time.
double	mCenterLat
	Center Latitude of Image.
double	mCenterLon
	Center Longitude of Image.
double	mCenterLatUnc
	Uncertainty of Center Latitude of Image.
double	mCenterLonUnc
	Uncertainty of Center Longitude of Image.
double	mImageAzim
	Image Azimuth.
double	mCloudPct
	Percentage of Cloud Cover in the Image.
double	mSunAzim
	Sun Azimuth.
double	mSunElev
	Sun Elevation.
double	mInstrument_azimuth
	Instrument Azimuth.
double	mInstrument_zenith
	Instrument Zenith.
std::string	mProjection
	Projection.
Node	mP1
	Corner point.
Node	mP2
	Corner point.
Node	mP3
	Corner point.
Node	mP4
	Corner point.
Protected Member Functions
virtual bool	writeTextTag (QDomDocument &doc, QDomElement &elem, std::string tagName, std::string text, std::string id="")
virtual bool	writeIntTag (QDomDocument &doc, QDomElement &elem, std::string tagName, int val, std::string id="")
virtual bool	writeDoubleTag (QDomDocument &doc, QDomElement &elem, std::string tagName, double val, std::string id="")
virtual std::string	readTextTag (QDomElement elem, std::string tagName="", std::string id="")
virtual int	readIntTag (QDomElement elem, std::string tagName="", std::string id="")
virtual double	readDoubleTag (QDomElement elem, std::string tagName="", std::string id="")
virtual QDomElement	createBaseTag (QDomDocument &doc, QDomElement &elem, std::string id, std::string tagName)
virtual QDomElement	getElemByTagName (QDomElement &elem, std::string name)
virtual std::string	qDateToString (const QDate *aQDate)
virtual bool	stringToQDate (const std::string aStrDate, QDate *aQDate)
virtual std::string	qDateTimeToString (const QDateTime *aQDateTime)
virtual bool	stringToQDateTime (const std::string aStrDateTime, QDateTime *aQDateTime)
Protected Attributes
QDate	mCurrentVersion

Constructor & Destructor Documentation

ImageInf::ImageInf ( ) [inline]

Constructor sets all float values to -999.0.

History:: 2007-06-14 dls - modified to set floats to -999.0 as recommended by Bruce Raup to make validation by GLIMSView and the ingestion procedure easier.

Definition at line 73 of file imageinf.h.

virtual ImageInf::~ImageInf ( ) [inline, virtual]

Definition at line 86 of file imageinf.h.

Member Function Documentation

bool ImageInf::toXML	(	QDomDocument &	doc,
		QDomElement &	elem,
		std::string	id = `""`
	)			`[virtual]`

Implements XMLSerializeable.

Definition at line 8 of file imageinf.cpp.

References mAquiDateTime, mCenterLat, mCenterLatUnc, mCenterLon, mCenterLonUnc, mCloudPct, mImageAzim, mInstID, mInstrument_azimuth, mInstrument_zenith, mLocURL, mOrigID, mP1, mP2, mP3, mP4, mProjection, mSunAzim, mSunElev, Node::toXML(), XMLSerializeable::writeDoubleTag(), and XMLSerializeable::writeTextTag().

Referenced by GLIMSDataset::toXML().

Here is the call graph for this function:

bool ImageInf::fromXML ( QDomElement & elem ) [virtual]

Implements XMLSerializeable.

Definition at line 45 of file imageinf.cpp.

References Node::fromXML(), mAquiDateTime, mCenterLat, mCenterLatUnc, mCenterLon, mCenterLonUnc, mCloudPct, mImageAzim, mInstID, mInstrument_azimuth, mInstrument_zenith, mLocURL, mOrigID, mP1, mP2, mP3, mP4, mProjection, mSunAzim, mSunElev, XMLSerializeable::readDoubleTag(), and XMLSerializeable::readTextTag().

Referenced by GLIMSDataset::fromXML().

Here is the call graph for this function:

bool ImageInf::validate ( ValidationReport * valRep )

Check that required session information is present.

Definition at line 102 of file imageinf.cpp.

References ValidationReport::breakBegin(), ValidationReport::breakEnd(), mAquiDateTime, mCenterLat, mCenterLatUnc, mCenterLon, mCenterLonUnc, mCloudPct, mImageAzim, mInstID, mInstrument_azimuth, mInstrument_zenith, mLocURL, mOrigID, mProjection, mSunAzim, mSunElev, ValidationReport::reportError(), ValidationReport::reportWarning(), and validIso8601DateTime().

Referenced by GLIMSProject::validate().

Here is the call graph for this function:

bool ImageInf::validIso8601DateTime ( std::string str )

Do the characters in the input string represent a complete and valid date/time string?

Definition at line 225 of file imageinf.cpp.

Referenced by validate(), and ImageInfDlg::validIso8601DateTime().

bool ImageInf::validIso8601DateTime ( QString & str )

Do the characters in the input string represent a complete and valid date/time string?

Definition at line 234 of file imageinf.cpp.

bool XMLSerializeable::writeTextTag	(	QDomDocument &	doc,
		QDomElement &	elem,
		std::string	tagName,
		std::string	text,
		std::string	id = `""`
	)			`[protected, virtual, inherited]`

Definition at line 7 of file xmlserializeable.cpp.

Referenced by ViewState::toXML(), Session::toXML(), Plugin::toXML(), LineDef::toXML(), ImageState::toXML(), toXML(), GlacierIDDef::toXML(), and Attr::toXML().

virtual bool XMLSerializeable::writeIntTag	(	QDomDocument &	doc,
		QDomElement &	elem,
		std::string	tagName,
		int	val,
		std::string	id = `""`
	)			`[inline, protected, virtual, inherited]`

Definition at line 38 of file xmlserializeable.h.

Referenced by ZoomAttr::toXML(), ViewState::toXML(), Session::toXML(), LineDef::toXML(), ImageState::toXML(), GlacierLine::toXML(), and GlacierIDDef::toXML().

virtual bool XMLSerializeable::writeDoubleTag	(	QDomDocument &	doc,
		QDomElement &	elem,
		std::string	tagName,
		double	val,
		std::string	id = `""`
	)			`[inline, protected, virtual, inherited]`

Definition at line 49 of file xmlserializeable.h.

Referenced by ZoomAttr::toXML(), Rect::toXML(), Node::toXML(), LineDef::toXML(), toXML(), and GlacierIDDef::toXML().

std::string XMLSerializeable::readTextTag	(	QDomElement	elem,
		std::string	tagName = `""`,
		std::string	id = `""`
	)			`[protected, virtual, inherited]`

Definition at line 21 of file xmlserializeable.cpp.

Referenced by ViewState::fromXML(), Session::fromXML(), Plugin::fromXML(), LineDef::fromXML(), ImageState::fromXML(), fromXML(), GlacierIDDef::fromXML(), and Attr::fromXML().

virtual int XMLSerializeable::readIntTag	(	QDomElement	elem,
		std::string	tagName = `""`,
		std::string	id = `""`
	)			`[inline, protected, virtual, inherited]`

Definition at line 65 of file xmlserializeable.h.

Referenced by ZoomAttr::fromXML(), ViewState::fromXML(), Session::fromXML(), LineDef::fromXML(), ImageState::fromXML(), GlacierLine::fromXML(), and GlacierIDDef::fromXML().

virtual double XMLSerializeable::readDoubleTag	(	QDomElement	elem,
		std::string	tagName = `""`,
		std::string	id = `""`
	)			`[inline, protected, virtual, inherited]`

Definition at line 72 of file xmlserializeable.h.

Referenced by ZoomAttr::fromXML(), Rect::fromXML(), Node::fromXML(), LineDef::fromXML(), fromXML(), and GlacierIDDef::fromXML().

virtual QDomElement XMLSerializeable::createBaseTag	(	QDomDocument &	doc,
		QDomElement &	elem,
		std::string	id,
		std::string	tagName
	)			`[inline, protected, virtual, inherited]`