regina::NXMLNormalSurfaceReader Class Reference
[Normal Surfaces]

An XML element reader that reads a single normal surface. More...

#include <nxmlsurfacereader.h>

Inheritance diagram for regina::NXMLNormalSurfaceReader:

regina::NXMLElementReader

List of all members.

Public Member Functions

 NXMLNormalSurfaceReader (NTriangulation *newTri, int newFlavour)
 Creates a new normal surface reader.
NNormalSurfacegetSurface ()
 Returns the normal surface that has been read.
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.


Detailed Description

An XML element reader that reads a single normal surface.

Python:
Not present.

Constructor & Destructor Documentation

regina::NXMLNormalSurfaceReader::NXMLNormalSurfaceReader ( NTriangulation newTri,
int  newFlavour 
) [inline]

Creates a new normal surface reader.

Parameters:
newTri the triangulation in which this normal surface lives.
newFlavour the flavour of coordinate system used by this normal surface.


Member Function Documentation

NNormalSurface * regina::NXMLNormalSurfaceReader::getSurface (  )  [inline]

Returns the normal surface that has been read.

Returns:
the newly allocated normal surface, or 0 if an error occurred.

virtual void regina::NXMLNormalSurfaceReader::startElement ( const std::string &  tagName,
const regina::xml::XMLPropertyDict tagProps,
NXMLElementReader parentReader 
) [virtual]

Signifies that parsing of this XML element is beginning.

The default implementation does nothing.

Parameters:
tagName the name of the opening tag for this element.
tagProps the properties associated with the opening tag.
parentReader the reader currently parsing the parent XML element, or 0 if this is the top-level element. If this paraneter is non-zero, it is guaranteed that startSubElement() has already been called upon the parent reader.

Reimplemented from regina::NXMLElementReader.

virtual void regina::NXMLNormalSurfaceReader::initialChars ( const std::string &  chars  )  [virtual]

Signifies that the initial text belonging to this XML element has been read.

The initial text is everything between the opening tag and the first subelement or closing tag.

The default implementation does nothing.

Parameters:
chars the initial text for this element.

Reimplemented from regina::NXMLElementReader.

virtual NXMLElementReader* regina::NXMLNormalSurfaceReader::startSubElement ( const std::string &  subTagName,
const regina::xml::XMLPropertyDict subTagProps 
) [virtual]

Signifies that a subelement of this XML element is about to be parsed.

The default implementation returns a new NXMLElementReader which can be used to ignore the subelement completely.

Parameters:
subTagName the name of the subelement opening tag.
subTagProps the properties associated with the subelement opening tag.
Returns:
a newly created element reader that will be used to parse the subelement. This class should not take care of the new reader's destruction; that will be done by the parser.

Reimplemented from regina::NXMLElementReader.


The documentation for this class was generated from the following file:
Copyright © 1999-2007, Ben Burton
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).