Regina Calculation Engine
Public Member Functions
regina::NXMLFilterReader Class Reference

An XML element reader that reads the specific details of a normal surface filter. More...

#include <surfaces/nxmlfilterreader.h>

Inheritance diagram for regina::NXMLFilterReader:
regina::NXMLElementReader

List of all members.

Public Member Functions

 NXMLFilterReader ()
 Creates a new filter element reader.
virtual NSurfaceFiltergetFilter ()
 Returns the newly allocated filter that has been read by this element reader.
- Public Member Functions inherited from regina::NXMLElementReader
 NXMLElementReader ()
 Creates a new element reader.
virtual ~NXMLElementReader ()
 Destroys this element reader.
virtual void startElement (const std::string &tagName, const regina::xml::XMLPropertyDict &tagProps, NXMLElementReader *parentReader)
 Signifies that parsing of this XML element is beginning.
virtual void initialChars (const std::string &chars)
 Signifies that the initial text belonging to this XML element has been read.
virtual NXMLElementReaderstartSubElement (const std::string &subTagName, const regina::xml::XMLPropertyDict &subTagProps)
 Signifies that a subelement of this XML element is about to be parsed.
virtual void endSubElement (const std::string &subTagName, NXMLElementReader *subReader)
 Signifies that parsing has finished for a subelement of this XML element.
virtual void endElement ()
 Signifies that parsing of this XML element is finished.
virtual void usingParser (regina::xml::XMLParser *parser)
 Called for the top-level element in an XML file when parsing begins.
virtual void abort (NXMLElementReader *subReader)
 Signifies that XML parsing has been aborted.

Detailed Description

An XML element reader that reads the specific details of a normal surface filter.

These details are generally contained within a <filter> ... </filter> pair.

Generally a subclass of NXMLFilterReader will be used to receive and store filters that you care about. However, if you simply wish to ignore a particular filter (and all of its descendants), you can use class NXMLFilterReader itself for the filter(s) you wish to ignore.

Routine getFilter() is used to return the filter that was read; see its documentation for further notes on how the filter should be constructed.

Python:
Not present.

Constructor & Destructor Documentation

regina::NXMLFilterReader::NXMLFilterReader ( )
inline

Creates a new filter element reader.


Member Function Documentation

NSurfaceFilter * regina::NXMLFilterReader::getFilter ( )
inlinevirtual

Returns the newly allocated filter that has been read by this element reader.

Deallocation of this new filter is not the responsibility of this class. Once this routine gives a non-zero return value, it should continue to give the same non-zero return value from this point onwards.

The default implementation returns 0.

Returns:
the filter that has been read, or 0 if filter reading is incomplete, the filter should be ignored or an error occurred.

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

Copyright © 1999-2012, The Regina development team
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).