Regina Calculation Engine
|
An XML packet reader that reads a single container. More...
#include <packet/nxmlpacketreaders.h>
Public Member Functions | |
NXMLContainerReader () | |
Creates a new container reader. | |
virtual NPacket * | getPacket () |
Returns the newly allocated packet that has been read by this element reader. | |
![]() | |
NXMLPacketReader () | |
Creates a new packet element reader. | |
virtual NXMLElementReader * | startContentSubElement (const std::string &subTagName, const regina::xml::XMLPropertyDict &subTagProps) |
Used instead of startSubElement() for XML subelements that are not child packets or packet tags. | |
virtual void | endContentSubElement (const std::string &subTagName, NXMLElementReader *subReader) |
Used instead of endSubElement() for XML subelements that are not child packets or packet tags. | |
virtual NXMLElementReader * | startSubElement (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 | abort (NXMLElementReader *subReader) |
Signifies that XML parsing has been aborted. | |
![]() | |
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 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. |
An XML packet reader that reads a single container.
|
inline |
Creates a new container reader.
|
inlinevirtual |
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.
Reimplemented from regina::NXMLPacketReader.