Isis 3 Programmer Reference
Isis::BundleSolutionInfo::XmlHandler Class Reference

This class is used to read an images.xml file into an image list. More...

Inheritance diagram for Isis::BundleSolutionInfo::XmlHandler:
Inheritance graph
Collaboration diagram for Isis::BundleSolutionInfo::XmlHandler:
Collaboration graph

Public Member Functions

 XmlHandler (BundleSolutionInfo *bundleSolutionInfo, Project *project)
 Create an XML Handler (reader) that can populate the BundleSolutionInfo class data.
 
 ~XmlHandler ()
 Destructor.
 
virtual bool startElement (const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
 Handle an XML start element.
 
virtual bool characters (const QString &ch)
 Adds characters to m_xmlHandlerCharacters.
 
virtual bool endElement (const QString &namespaceURI, const QString &localName, const QString &qName)
 Handle an XML end element.
 
QString surfacePointCoordName (SurfacePoint::CoordinateType type, SurfacePoint::CoordIndex coordIdx) const
 
virtual void setReader (XmlStackedHandlerReader *)
 
void switchToNewHandler (XmlStackedHandler *nextHandler)
 Switch to a new content handler and continue processing using the new handler.
 

Protected Member Functions

XmlStackedHandlerReaderreader ()
 
const XmlStackedHandlerReaderreader () const
 
bool fatalError (const QXmlParseException &exception)
 

Private Member Functions

 Q_DISABLE_COPY (XmlHandler)
 

Private Attributes

BundleSolutionInfom_xmlHandlerBundleSolutionInfo
 The bundleSolutionInfo object.
 
Projectm_xmlHandlerProject
 
QString m_xmlHandlerCharacters
 List of characters that have been handled.
 
XmlStackedHandlerReaderm_reader
 
int m_depth
 
QString m_lastStartNamespaceURI
 
QString m_lastStartLocalName
 
QString m_lastStartQName
 
QXmlAttributes m_lastStartAtts
 

Detailed Description

This class is used to read an images.xml file into an image list.

See also
QXmlDefaultHandler documentation
Author
2014-07-21 Ken Edmundson
History
2016-06-13 Makayla Shepherd - Added updateFileName() and updated documentation. Fixes #2298.

Definition at line 236 of file BundleSolutionInfo.h.

Constructor & Destructor Documentation

◆ XmlHandler()

Isis::BundleSolutionInfo::XmlHandler::XmlHandler ( BundleSolutionInfo * bundleSolutionInfo,
Project * project )

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

See BundleSolutionInfo::save() for the expected format.

Parameters
bundleSolutionInfoThe bundle solution we're going to be initializing
projectThe project we are working in

Definition at line 1979 of file BundleSolutionInfo.cpp.

References m_xmlHandlerBundleSolutionInfo, and m_xmlHandlerCharacters.

◆ ~XmlHandler()

Isis::BundleSolutionInfo::XmlHandler::~XmlHandler ( )

Destructor.

Definition at line 1990 of file BundleSolutionInfo.cpp.

Member Function Documentation

◆ characters()

bool Isis::BundleSolutionInfo::XmlHandler::characters ( const QString & ch)
virtual

Adds characters to m_xmlHandlerCharacters.

Parameters
chQString of characters to add
Returns
bool Almost always true. Only false if the characters cannot be read

Definition at line 2001 of file BundleSolutionInfo.cpp.

◆ endElement()

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

Handle an XML end element.

Parameters
namespaceURI???
localNameThe keyword name given to the member variable in the XML.
qName???
Returns
bool Returns XmlStackedHandler's endElement()

Reimplemented from Isis::XmlStackedHandler.

Definition at line 2057 of file BundleSolutionInfo.cpp.

◆ 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::BundleSolutionInfo::XmlHandler::startElement ( const QString & namespaceURI,
const QString & localName,
const QString & qName,
const QXmlAttributes & atts )
virtual

Handle an XML start element.

This expects <image> and <displayProperties> elements.

Parameters
namespaceURI???
localNameThe keyword name given to the member variable in the XML.
qName???
attsThe attribute containing the keyword value for the given local name.
Returns
bool True if we should continue reading the XML.

Reimplemented from Isis::XmlStackedHandler.

Definition at line 2017 of file BundleSolutionInfo.cpp.

◆ 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_depth

int Isis::XmlStackedHandler::m_depth
privateinherited

Definition at line 141 of file XmlStackedHandler.h.

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

◆ m_xmlHandlerBundleSolutionInfo

BundleSolutionInfo* Isis::BundleSolutionInfo::XmlHandler::m_xmlHandlerBundleSolutionInfo
private

The bundleSolutionInfo object.

Definition at line 253 of file BundleSolutionInfo.h.

Referenced by XmlHandler().

◆ m_xmlHandlerCharacters

QString Isis::BundleSolutionInfo::XmlHandler::m_xmlHandlerCharacters
private

List of characters that have been handled.

Definition at line 255 of file BundleSolutionInfo.h.

Referenced by XmlHandler().

◆ m_xmlHandlerProject

Project* Isis::BundleSolutionInfo::XmlHandler::m_xmlHandlerProject
private

Definition at line 254 of file BundleSolutionInfo.h.


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