regina::NXMLContainerReader Class Reference
[Basic Packet Types]

An XML packet reader that reads a single container. More...

#include <nxmlpacketreaders.h>

Inheritance diagram for regina::NXMLContainerReader:

regina::NXMLPacketReader regina::NXMLElementReader List of all members.

Public Member Functions

 NXMLContainerReader ()
 Creates a new container reader.
virtual NPacketgetPacket ()
 Returns the newly allocated packet that has been read by this element reader.

Detailed Description

An XML packet reader that reads a single container.

Python:
Not present.


Constructor & Destructor Documentation

regina::NXMLContainerReader::NXMLContainerReader (  )  [inline]

Creates a new container reader.


Member Function Documentation

NPacket * regina::NXMLContainerReader::getPacket (  )  [inline, virtual]

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

Deallocation of this new packet 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.

If this routine is ever to give a non-zero return value, it must be giving that non-zero return value by the time the first child packet or packet tag is encountered; otherwise child packets will not be inserted into the packet tree and/or packet tags will not be added.

The newly allocated packet should not be given a packet label. This will be done by NXMLPacketReader::endSubElement().

The newly allocated packet may or may not be inserted in the packet tree structure; this does not matter (although if it is inserted it must be inserted in the correct place).

The newly allocated packet should not be given any associated packet tags. This will be done by NXMLPacketReader::startSubElement().

The default implementation returns 0.

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

Reimplemented from regina::NXMLPacketReader.


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