Process XML in a stack-oriented fashion. More...

Inheritance diagram for Isis::Image::XmlHandler:

Collaboration diagram for Isis::Image::XmlHandler:

Public Member Functions
	XmlHandler (Image *image, FileName imageFolder)
	Create an XML Handler (reader) that can populate the Image class data.

virtual bool	startElement (const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
	Read mage class attributes.

virtual bool	characters (const QString &ch)
	This implementation of a virtual function calls QXmlDefaultHandler::characters(QString &ch) which in turn calls QXmlContentHandler::characters(QString &ch) which is called when the XML processor has parsed a chunk of character data.

virtual bool	endElement (const QString &namespaceURI, const QString &localName, const QString &qName)
	The XML reader invokes this method at the end of every element in the XML document.

virtual void	setReader (XmlStackedHandlerReader *)

void	switchToNewHandler (XmlStackedHandler *nextHandler)
	Switch to a new content handler and continue processing using the new handler.

Protected Member Functions
XmlStackedHandlerReader *	reader ()

const XmlStackedHandlerReader *	reader () const

bool	fatalError (const QXmlParseException &exception)

Private Member Functions
	Q_DISABLE_COPY (XmlHandler)

Private Attributes
Image *	m_image
	Pointer to the Image.

FileName	m_imageFolder
	The Name/path of the image.

QString	m_characters
	Character data storage found in the content of XML elements.

XmlStackedHandlerReader *	m_reader

int	m_depth

QString	m_lastStartNamespaceURI

QString	m_lastStartLocalName

QString	m_lastStartQName

QXmlAttributes	m_lastStartAtts

Detailed Description

Process XML in a stack-oriented fashion.

Child class for XmlStackedHandler which is used to process XML in a stack-oriented way. It's been modified to process an Image object object.

Author: 2012-??-?? Steven Lambright

History: 2016-06-23 Tyler Wilson - Added documention to the member functions. Fixes #3950.

Definition at line 172 of file Image.h.

Constructor & Destructor Documentation

◆ XmlHandler()

Isis::Image::XmlHandler::XmlHandler	(	Image *	image,
		FileName	imageFolder )

Create an XML Handler (reader) that can populate the Image class data.

See also: Image::save() for the expected format.

Parameters

image	The image we're going to be initializing
imageFolder	The folder that contains the Cube

Definition at line 829 of file Image.cpp.

References m_image, and m_imageFolder.

Member Function Documentation

◆ characters()

bool Isis::Image::XmlHandler::characters ( const QString & ch )

virtual

This implementation of a virtual function calls QXmlDefaultHandler::characters(QString &ch) which in turn calls QXmlContentHandler::characters(QString &ch) which is called when the XML processor has parsed a chunk of character data.

See also: XmlStackedHandler, QXmlDefaultHandler,QXmlContentHandler

Parameters

ch	The character data.

Returns: bool Returns True if there were no problems with the character processing. It returns False if there was a problem, and the XML reader stops.

Definition at line 945 of file Image.cpp.

◆ endElement()

bool Isis::Image::XmlHandler::endElement	(	const QString &	namespaceURI,
		const QString &	localName,
		const QString &	qName )

virtual

The XML reader invokes this method at the end of every element in the XML document.

This expects <image> and <footprint> elements.

Parameters

namespaceURI	The Uniform Resource Identifier of the namespace (eg. "xmlns")
localName	The local name string (eg. "xhtml")
qName	The XML qualified string (eg. "xmlns:xhtml"). This can be empty if QNames are not available.

Returns: bool If this function returns True, then a signal is sent to the reader indicating the end of the element. If this function returns False, something bad happened and processing stops.

Reimplemented from Isis::XmlStackedHandler.

Definition at line 963 of file Image.cpp.

References Isis::PolygonTools::MakeMultiPolygon().

◆ fatalError()

bool Isis::XmlStackedHandler::fatalError ( const QXmlParseException & exception )

protectedinherited

Definition at line 78 of file XmlStackedHandler.cpp.

◆ reader() [1/2]

XmlStackedHandlerReader * Isis::XmlStackedHandler::reader ( )

protectedinherited

Definition at line 68 of file XmlStackedHandler.cpp.

◆ reader() [2/2]

const XmlStackedHandlerReader * Isis::XmlStackedHandler::reader ( ) const

protectedinherited

Definition at line 73 of file XmlStackedHandler.cpp.

◆ setReader()

void Isis::XmlStackedHandler::setReader ( XmlStackedHandlerReader * reader )

virtualinherited

Definition at line 28 of file XmlStackedHandler.cpp.

◆ startElement()

bool Isis::Image::XmlHandler::startElement	(	const QString &	namespaceURI,
		const QString &	localName,
		const QString &	qName,
		const QXmlAttributes &	atts )

virtual

Read mage class attributes.

The XML reader invokes this method at the start of every element in the XML document. This expects <image> and <displayProperties> elements. A quick example using this function: startElement("xsl","stylesheet","xsl:stylesheet",attributes)

Parameters

namespaceURI	The Uniform Resource Identifier of the element's namespace
localName	The local name string
qName	The XML qualified string (or empty, if QNames are not available).
atts	The XML attributes attached to each element

Returns: bool Returns True signalling to the reader the start of a valid XML element. If False is returned, something bad happened.

Reimplemented from Isis::XmlStackedHandler.

Definition at line 851 of file Image.cpp.

References Isis::Image::fileName(), Isis::Distance::Meters, and Isis::Angle::Radians.

◆ switchToNewHandler()

void Isis::XmlStackedHandler::switchToNewHandler ( XmlStackedHandler * nextHandler )

inherited

Switch to a new content handler and continue processing using the new handler.

Definition at line 37 of file XmlStackedHandler.cpp.

Member Data Documentation

◆ m_characters

QString Isis::Image::XmlHandler::m_characters

private

Character data storage found in the content of XML elements.

Definition at line 187 of file Image.h.

◆ m_depth

int Isis::XmlStackedHandler::m_depth

privateinherited

Definition at line 141 of file XmlStackedHandler.h.

◆ m_image

Image* Isis::Image::XmlHandler::m_image

private

Pointer to the Image.

Definition at line 185 of file Image.h.

Referenced by XmlHandler().

◆ m_imageFolder

FileName Isis::Image::XmlHandler::m_imageFolder

private

The Name/path of the image.

Definition at line 186 of file Image.h.

Referenced by XmlHandler().

◆ m_lastStartAtts

QXmlAttributes Isis::XmlStackedHandler::m_lastStartAtts

privateinherited

Definition at line 146 of file XmlStackedHandler.h.

◆ m_lastStartLocalName

QString Isis::XmlStackedHandler::m_lastStartLocalName

privateinherited

Definition at line 144 of file XmlStackedHandler.h.

◆ m_lastStartNamespaceURI

QString Isis::XmlStackedHandler::m_lastStartNamespaceURI

privateinherited

Definition at line 143 of file XmlStackedHandler.h.

◆ m_lastStartQName

QString Isis::XmlStackedHandler::m_lastStartQName

privateinherited

Definition at line 145 of file XmlStackedHandler.h.

◆ m_reader

XmlStackedHandlerReader* Isis::XmlStackedHandler::m_reader

privateinherited

Definition at line 140 of file XmlStackedHandler.h.

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

src/qisis/objs/Image/Image.h
src/qisis/objs/Image/Image.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XmlHandler()

Member Function Documentation

◆ characters()

◆ endElement()

◆ fatalError()

◆ reader() [1/2]

◆ reader() [2/2]

◆ setReader()

◆ startElement()

◆ switchToNewHandler()

Member Data Documentation

◆ m_characters

◆ m_depth

◆ m_image

◆ m_imageFolder

◆ m_lastStartAtts

◆ m_lastStartLocalName

◆ m_lastStartNamespaceURI

◆ m_lastStartQName

◆ m_reader