Regina Calculation Engine
|
Represents a packet of information that may be individually edited or operated upon. More...
#include <packet/npacket.h>
Classes | |
class | ChangeEventSpan |
An object that facilitates firing packetToBeChanged() and packetWasChanged() events. More... |
Public Types | |
typedef ChangeEventSpan | ChangeEventBlock |
A deprecated typedef for ChangeEventSpan. |
Public Member Functions | |
Constructors and Destructors | |
NPacket (NPacket *parent=0) | |
Constructor that inserts the new packet into the overall tree structure. | |
virtual | ~NPacket () |
Destructor that also orphans this packet and destroys all of its descendants. | |
Packet Identification | |
(end: Constructors and Destructors) | |
virtual int | getPacketType () const =0 |
Returns the integer ID representing this type of packet. | |
virtual std::string | getPacketTypeName () const =0 |
Returns an English name for this type of packet. | |
const std::string & | getPacketLabel () const |
Returns the label associated with this individual packet. | |
void | setPacketLabel (const std::string &newLabel) |
Sets the label associated with this individual packet. | |
std::string | getFullName () const |
Returns a descriptive text string for the packet. | |
std::string | makeUniqueLabel (const std::string &base) const |
Returns a new label that cannot be found anywhere in the entire tree structure. | |
bool | makeUniqueLabels (NPacket *reference) |
Ensures that all packet labels in both this and the given packet tree combined are distinct. | |
Tags | |
(end: Packet Identification) | |
bool | hasTag (const std::string &tag) const |
Determines whether this packet has the given associated tag. | |
bool | hasTags () const |
Determines whether this packet has any associated tags at all. | |
bool | addTag (const std::string &tag) |
Associates the given tag with this packet. | |
bool | removeTag (const std::string &tag) |
Removes the association of the given tag with this packet. | |
void | removeAllTags () |
Removes all associated tags from this packet. | |
const std::set< std::string > & | getTags () const |
Returns the set of all tags associated with this packet. | |
Event Handling | |
(end: Tags) | |
bool | listen (NPacketListener *listener) |
Registers the given packet listener to listen for events on this packet. | |
bool | isListening (NPacketListener *listener) |
Determines whether the given packet listener is currently listening for events on this packet. | |
bool | unlisten (NPacketListener *listener) |
Unregisters the given packet listener so that it no longer listens for events on this packet. | |
Tree Queries | |
(end: Event Handling) | |
NPacket * | getTreeParent () const |
Determines the parent packet in the tree structure. | |
NPacket * | getFirstTreeChild () const |
Determines the first child of this packet in the tree structure. | |
NPacket * | getLastTreeChild () const |
Determines the last child of this packet in the tree structure. | |
NPacket * | getNextTreeSibling () const |
Determines the next sibling of this packet in the tree structure. | |
NPacket * | getPrevTreeSibling () const |
Determines the previous sibling of this packet in the tree structure. | |
NPacket * | getTreeMatriarch () const |
Determines the matriarch (the root) of the tree to which this packet belongs. | |
unsigned | levelsDownTo (const NPacket *descendant) const |
Counts the number of levels between this packet and its given descendant in the tree structure. | |
unsigned | levelsUpTo (const NPacket *ancestor) const |
Counts the number of levels between this packet and its given ancestor in the tree structure. | |
bool | isGrandparentOf (const NPacket *descendant) const |
Determines if this packet is equal to or an ancestor of the given packet in the tree structure. | |
unsigned long | getNumberOfChildren () const |
Returns the number of immediate children of this packet. | |
unsigned long | getNumberOfDescendants () const |
Returns the total number of descendants of this packet. | |
unsigned long | getTotalTreeSize () const |
Determines the total number of packets in the tree or subtree for which this packet is matriarch. | |
Tree Manipulation | |
(end: Tree Queries) | |
void | insertChildFirst (NPacket *child) |
Inserts the given packet as the first child of this packet. | |
void | insertChildLast (NPacket *child) |
Inserts the given packet as the last child of this packet. | |
void | insertChildAfter (NPacket *newChild, NPacket *prevChild) |
Inserts the given packet as a child of this packet at the given location in this packet's child list. | |
void | makeOrphan () |
Cuts this packet away from its parent in the tree structure and instead makes it matriarch of its own tree. | |
void | reparent (NPacket *newParent, bool first=false) |
Cuts this packet away from its parent in the tree structure, and inserts it as a child of the given packet instead. | |
void | swapWithNextSibling () |
Swaps this packet with its next sibling in the sequence of children beneath their common parent packet. | |
void | moveUp (unsigned steps=1) |
Moves this packet the given number of steps towards the beginning of its sibling list. | |
void | moveDown (unsigned steps=1) |
Moves this packet the given number of steps towards the end of its sibling list. | |
void | moveToFirst () |
Moves this packet to be the first in its sibling list. | |
void | moveToLast () |
Moves this packet to be the last in its sibling list. | |
void | sortChildren () |
Sorts the immediate children of this packet according to their packet labels. | |
Searching and Iterating | |
(end: Tree Manipulation) | |
NPacket * | nextTreePacket () |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. | |
const NPacket * | nextTreePacket () const |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. | |
NPacket * | firstTreePacket (const std::string &type) |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. | |
const NPacket * | firstTreePacket (const std::string &type) const |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. | |
NPacket * | nextTreePacket (const std::string &type) |
Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure. | |
const NPacket * | nextTreePacket (const std::string &type) const |
Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure. | |
NPacket * | findPacketLabel (const std::string &label) |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. | |
const NPacket * | findPacketLabel (const std::string &label) const |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. | |
Packet Dependencies | |
(end: Searching and Iterating) | |
virtual bool | dependsOnParent () const =0 |
Determines if this packet depends upon its parent. | |
bool | isPacketEditable () const |
Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children. | |
Cloning | |
(end: Packet Dependencies) | |
NPacket * | clone (bool cloneDescendants=false, bool end=true) const |
Clones this packet (and possibly its descendants), assigns to it a suitable unused label and inserts the clone into the tree as a sibling of this packet. | |
File I/O | |
(end: Cloning) | |
void | writeXMLFile (std::ostream &out) const |
Writes a complete XML file containing the subtree with this packet as matriarch. | |
virtual void | writePacket (NFile &out) const |
Writes the packet details to the given old-style binary file. | |
![]() | |
ShareableObject () | |
Default constructor that does nothing. | |
virtual | ~ShareableObject () |
Default destructor that does nothing. | |
virtual void | writeTextShort (std::ostream &out) const =0 |
Writes this object in short text format to the given output stream. | |
virtual void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. | |
std::string | toString () const |
Returns the output from writeTextShort() as a string. | |
std::string | toStringLong () const |
Returns the output from writeTextLong() as a string. |
Static Public Member Functions | |
static NXMLPacketReader * | getXMLReader (NPacket *parent) |
(end: File I/O) | |
static NPacket * | readPacket (NFile &in, NPacket *parent) |
Reads a single packet from the specified file and returns a newly created object containing that information. |
Static Public Attributes | |
static const int | packetType |
Contains the integer ID for this packet. |
Protected Member Functions | |
virtual NPacket * | internalClonePacket (NPacket *parent) const =0 |
Makes a newly allocated copy of this packet. | |
void | writeXMLPacketTree (std::ostream &out) const |
Writes a chunk of XML containing the subtree with this packet as matriarch. | |
virtual void | writeXMLPacketData (std::ostream &out) const =0 |
Writes a chunk of XML containing the data for this packet only. |
Represents a packet of information that may be individually edited or operated upon.
Packets are stored in a dependency tree, where child packets fit within the context of (or otherwise cannot live without) parent packets.
When deriving classes from NPacket:
public static const int packetType
must be declared. The registry utilities will take care of assigning it a value. static NXMLPacketReader* getXMLReader(NPacket* parent)
must be declared and implemented. See the notes for getXMLReader() for further details. Note that external objects can listen for events on packets, such as when packets are changed or about to be destroyed. See the NPacketListener class notes for details.
A deprecated typedef for ChangeEventSpan.
|
inline |
Constructor that inserts the new packet into the overall tree structure.
The new packet will be inserted as the last child of the given parent, and will be initialised with no children of its own.
Note that NPacket is an abstract class and cannot be instantiated directly.
parent | the parent beneath which to insert this packet, or 0 if this packet is to be the matriarch of a new tree. |
|
virtual |
Destructor that also orphans this packet and destroys all of its descendants.
bool regina::NPacket::addTag | ( | const std::string & | tag | ) |
Associates the given tag with this packet.
Each packet can have an arbitrary set of string tags associated with it. The tags are not used by this calculation engine; the feature is provided for whatever use a developer or user chooses to make of it.
Tags are case-sensitive. Tags associated with a single packet must be distinct, i.e., a particular tag cannot be associated more than once with the same packet.
tag | the tag to add. |
true
if the given tag was successfully added, or false
if the given tag was already present beforehand. NPacket* regina::NPacket::clone | ( | bool | cloneDescendants = false , |
bool | end = true |
||
) | const |
Clones this packet (and possibly its descendants), assigns to it a suitable unused label and inserts the clone into the tree as a sibling of this packet.
Note that any string tags associated with this packet will not be cloned.
If this packet has no parent in the tree structure, no clone will be created and 0 will be returned.
cloneDescendants | true if the descendants of this packet should also be cloned and inserted as descendants of the new packet. If this is passed as false (the default), only this packet will be cloned. |
end | true if the new packet should be inserted at the end of the parent's list of children (the default), or false if the new packet should be inserted as the sibling immediately after this packet. |
|
pure virtual |
Determines if this packet depends upon its parent.
This is true if the parent cannot be altered without invalidating or otherwise upsetting this packet.
true
if and only if this packet depends on its parent. Implemented in regina::NNormalSurfaceList, regina::NTriangulation, regina::NAngleStructureList, regina::NSurfaceFilter, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
NPacket* regina::NPacket::findPacketLabel | ( | const std::string & | label | ) |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch.
Note that label comparisons are case sensitive.
label | the label to search for. |
const NPacket* regina::NPacket::findPacketLabel | ( | const std::string & | label | ) | const |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch.
Note that label comparisons are case sensitive.
label | the label to search for. |
NPacket* regina::NPacket::firstTreePacket | ( | const std::string & | type | ) |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure.
Note that this packet must be the matriarch of the entire tree.
A parent packet is always reached before its children. The tree matriarch will be the first packet visited in a complete depth-first iteration.
type | the type of packet to search for, as returned by getPacketTypeName(). Note that string comparisons are case sensitive. |
const NPacket* regina::NPacket::firstTreePacket | ( | const std::string & | type | ) | const |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure.
Note that this packet must be the matriarch of the entire tree.
A parent packet is always reached before its children. The tree matriarch will be the first packet visited in a complete depth-first iteration.
type | the type of packet to search for, as returned by getPacketTypeName(). Note that string comparisons are case sensitive. |
|
inline |
Determines the first child of this packet in the tree structure.
This routine takes small constant time.
|
inline |
Returns a descriptive text string for the packet.
The string is of the form label (packet-type).
|
inline |
Determines the last child of this packet in the tree structure.
This routine takes small constant time.
|
inline |
Determines the next sibling of this packet in the tree structure.
This is the child of the parent that follows this packet.
This routine takes small constant time.
unsigned long regina::NPacket::getNumberOfChildren | ( | ) | const |
Returns the number of immediate children of this packet.
Grandchildren and so on are not counted.
|
inline |
Returns the total number of descendants of this packet.
This includes children, grandchildren and so on. This packet is not included in the count.
|
inline |
Returns the label associated with this individual packet.
An example is MyTriangulation
. Each individual packet in the overall tree structure must have a unique label.
|
pure virtual |
Returns the integer ID representing this type of packet.
This is the same for all packets of this class.
Implemented in regina::NNormalSurfaceList, regina::NTriangulation, regina::NAngleStructureList, regina::NSurfaceFilter, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
|
pure virtual |
Returns an English name for this type of packet.
An example is NTriangulation
. This is the same for all packets of this class.
Implemented in regina::NNormalSurfaceList, regina::NTriangulation, regina::NAngleStructureList, regina::NSurfaceFilter, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
|
inline |
Determines the previous sibling of this packet in the tree structure.
This is the child of the parent that precedes this packet.
This routine takes small constant time.
|
inline |
Returns the set of all tags associated with this packet.
Each packet can have an arbitrary set of string tags associated with it. The tags are not used by this calculation engine; the feature is provided for whatever use a developer or user chooses to make of it.
Tags are case-sensitive. Tags associated with a single packet must be distinct, i.e., a particular tag cannot be associated more than once with the same packet.
unsigned long regina::NPacket::getTotalTreeSize | ( | ) | const |
Determines the total number of packets in the tree or subtree for which this packet is matriarch.
This packet is included in the count.
NPacket* regina::NPacket::getTreeMatriarch | ( | ) | const |
Determines the matriarch (the root) of the tree to which this packet belongs.
|
inline |
Determines the parent packet in the tree structure.
This routine takes small constant time.
|
static |
(end: File I/O)
Returns a newly created XML element reader that will read the contents of a single XML packet element. You may assume that the packet to be read is of the same type as the class in which you are implementing this routine.
The XML element reader should read exactly what writeXMLPacketData() writes, and vice versa.
parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. The XML element reader can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.
This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated.
parent | the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch. |
Reimplemented in regina::NTriangulation, regina::NNormalSurfaceList, regina::NAngleStructureList, regina::NSurfaceFilter, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
|
inline |
Determines whether this packet has the given associated tag.
Each packet can have an arbitrary set of string tags associated with it. The tags are not used by this calculation engine; the feature is provided for whatever use a developer or user chooses to make of it.
Tags are case-sensitive. Tags associated with a single packet must be distinct, i.e., a particular tag cannot be associated more than once with the same packet.
tag | the tag to search for. |
true
if the given tag is found, false
otherwise.
|
inline |
Determines whether this packet has any associated tags at all.
Each packet can have an arbitrary set of string tags associated with it. The tags are not used by this calculation engine; the feature is provided for whatever use a developer or user chooses to make of it.
Tags are case-sensitive. Tags associated with a single packet must be distinct, i.e., a particular tag cannot be associated more than once with the same packet.
true
if this packet has any tags, false
otherwise. Inserts the given packet as a child of this packet at the given location in this packet's child list.
This routine takes small constant time.
newChild | the child to insert. |
prevChild | the preexisting child of this packet after which newChild will be inserted, or 0 if newChild is to be the first child of this packet. |
void regina::NPacket::insertChildFirst | ( | NPacket * | child | ) |
Inserts the given packet as the first child of this packet.
This routine takes small constant time.
child | the child to insert. |
void regina::NPacket::insertChildLast | ( | NPacket * | child | ) |
Inserts the given packet as the last child of this packet.
This routine takes small constant time.
child | the child to insert. |
|
protectedpure virtual |
Makes a newly allocated copy of this packet.
This routine should not insert the new packet into the tree structure, clone the packet's associated tags or give the packet a label. It should also not clone any descendants of this packet.
You may assume that the new packet will eventually be inserted into the tree beneath either the same parent as this packet or a clone of that parent.
parent | the parent beneath which the new packet will eventually be inserted. |
Implemented in regina::NTriangulation, regina::NNormalSurfaceList, regina::NSurfaceFilter, regina::NAngleStructureList, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
bool regina::NPacket::isGrandparentOf | ( | const NPacket * | descendant | ) | const |
Determines if this packet is equal to or an ancestor of the given packet in the tree structure.
descendant | the other packet whose relationships we are examining. |
true
if and only if this packet is equal to or an ancestor of descendant
.
|
inline |
Determines whether the given packet listener is currently listening for events on this packet.
See the NPacketListener class notes for details.
listener | the listener to search for. |
true
if the given listener is currently registered with this packet, or false
otherwise. bool regina::NPacket::isPacketEditable | ( | ) | const |
Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children.
Descendants further down the packet tree are not (and should not need to be) considered.
true
if and only if this packet may be edited. unsigned regina::NPacket::levelsDownTo | ( | const NPacket * | descendant | ) | const |
Counts the number of levels between this packet and its given descendant in the tree structure.
If descendant
is this packet, the number of levels is zero.
descendant
, or can be obtained from descendant
using only child-to-parent steps.descendant | the packet whose relationship with this packet we are examining. |
|
inline |
Counts the number of levels between this packet and its given ancestor in the tree structure.
If ancestor
is this packet, the number of levels is zero.
ancestor
, or can be obtained from ancestor
using only parent-to-child steps.ancestor | the packet whose relationship with this packet we are examining. |
bool regina::NPacket::listen | ( | NPacketListener * | listener | ) |
Registers the given packet listener to listen for events on this packet.
See the NPacketListener class notes for details.
listener | the listener to register. |
true
if the given listener was successfully registered, or false
if the given listener was already registered beforehand. void regina::NPacket::makeOrphan | ( | ) |
Cuts this packet away from its parent in the tree structure and instead makes it matriarch of its own tree.
The tree information for both this packet and its parent will be updated.
This routine takes small constant time.
std::string regina::NPacket::makeUniqueLabel | ( | const std::string & | base | ) | const |
Returns a new label that cannot be found anywhere in the entire tree structure.
This packet need not be the tree matriarch; this routine will search the entire tree to which this packet belongs.
The new label will consist of the given base, possibly followed by a space and a number.
base | a string upon which the new label will be based. |
bool regina::NPacket::makeUniqueLabels | ( | NPacket * | reference | ) |
Ensures that all packet labels in both this and the given packet tree combined are distinct.
If two packets have the same label, one will be renamed by adding a space and a number.
Packets in the given packet tree will be given priority over the labels; that is, if a packet in this tree has the same label as a packet in the given tree, it will be the packet in this tree that is renamed.
The given packet tree may be null
, in which case only this tree will be examined.
reference | the packet tree with which to compare this tree. |
true
if and only if any of the packets were relabelled. void regina::NPacket::moveDown | ( | unsigned | steps = 1 | ) |
Moves this packet the given number of steps towards the end of its sibling list.
If the number of steps is larger than the greatest possible movement, the packet will be moved to the very end of its sibling list.
This routine takes time proportional to the number of steps.
void regina::NPacket::moveToFirst | ( | ) |
Moves this packet to be the first in its sibling list.
This routine takes small constant time.
void regina::NPacket::moveToLast | ( | ) |
Moves this packet to be the last in its sibling list.
This routine takes small constant time.
void regina::NPacket::moveUp | ( | unsigned | steps = 1 | ) |
Moves this packet the given number of steps towards the beginning of its sibling list.
If the number of steps is larger than the greatest possible movement, the packet will be moved to the very beginning of its sibling list.
This routine takes time proportional to the number of steps.
NPacket* regina::NPacket::nextTreePacket | ( | ) |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs.
Note that this packet need not be the tree matriarch.
A parent packet is always reached before its children. The tree matriarch will be the first packet visited in a complete depth-first iteration.
const NPacket* regina::NPacket::nextTreePacket | ( | ) | const |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs.
Note that this packet need not be the tree matriarch.
A parent packet is always reached before its children. The tree matriarch will be the first packet visited in a complete depth-first iteration.
NPacket* regina::NPacket::nextTreePacket | ( | const std::string & | type | ) |
Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure.
Note that this packet need not be the tree matriarch. The order of tree searching is described in firstTreePacket().
type | the type of packet to search for, as returned by getPacketTypeName(). Note that string comparisons are case sensitive. |
const NPacket* regina::NPacket::nextTreePacket | ( | const std::string & | type | ) | const |
Finds the next packet after this of the requested type in a complete depth-first iteration of the entire tree structure.
Note that this packet need not be the tree matriarch. The order of tree searching is described in firstTreePacket().
type | the type of packet to search for, as returned by getPacketTypeName(). Note that string comparisons are case sensitive. |
Reads a single packet from the specified file and returns a newly created object containing that information.
You may assume that the packet to be read is of the same type as the class in which you are implementing this routine. The newly created object must also be of this type.
For instance, NTriangulation::readPacket() may assume that the packet is of type NTriangulation, and must return a pointer to a newly created NTriangulation. Deallocation of the newly created packet is the responsibility of whoever calls this routine.
The packet type and label may be assumed to have already been read from the file, and should not be reread. The readPacket() routine should read exactly what writePacket() writes, and vice versa.
parent represents the packet which will become the new packet's parent in the tree structure, and may be assumed to have already been read from the file. This information is for reference only, and does not need to be used. This routine can either insert or not insert the new packet beneath parent in the tree structure as it pleases. Note however that parent will be 0 if the new packet is to become a tree matriarch.
This routine is not actually provided for NPacket itself, but must be declared and implemented for every packet subclass that will be instantiated. Within each such subclass the function must be declared to return a pointer to an object of that subclass. For instance, NTriangulation::readPacket() must be declared to return an NTriangulation*, not simply an NPacket*.
New packet types should make this routine simply return 0 since this file format is now obsolete, and older calculation engines will not understand newer packet types anyway.
in | the file from which to read the packet. |
parent | the packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch. |
Reimplemented in regina::NTriangulation, regina::NNormalSurfaceList, regina::NAngleStructureList, regina::NSurfaceFilter, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
void regina::NPacket::removeAllTags | ( | ) |
Removes all associated tags from this packet.
Each packet can have an arbitrary set of string tags associated with it. The tags are not used by this calculation engine; the feature is provided for whatever use a developer or user chooses to make of it.
Tags are case-sensitive. Tags associated with a single packet must be distinct, i.e., a particular tag cannot be associated more than once with the same packet.
bool regina::NPacket::removeTag | ( | const std::string & | tag | ) |
Removes the association of the given tag with this packet.
Each packet can have an arbitrary set of string tags associated with it. The tags are not used by this calculation engine; the feature is provided for whatever use a developer or user chooses to make of it.
Tags are case-sensitive. Tags associated with a single packet must be distinct, i.e., a particular tag cannot be associated more than once with the same packet.
tag | the tag to remove. |
true
if the given tag was removed, or false
if the given tag was not actually associated with this packet. void regina::NPacket::reparent | ( | NPacket * | newParent, |
bool | first = false |
||
) |
Cuts this packet away from its parent in the tree structure, and inserts it as a child of the given packet instead.
This routine is essentially a combination of makeOrphan() followed by either insertChildFirst() or insertChildLast().
This routine takes small constant time. It is safe to use regardless of whether this packet has a parent or not.
newParent | the new parent of this packet, i.e., the packet beneath which this packet will be inserted. |
first | true if this packet should be inserted as the first child of the given parent, or false (the default) if it should be inserted as the last child. |
void regina::NPacket::setPacketLabel | ( | const std::string & | newLabel | ) |
Sets the label associated with this individual packet.
newLabel | the new label to give this packet. |
void regina::NPacket::sortChildren | ( | ) |
Sorts the immediate children of this packet according to their packet labels.
Note that this routine is not recursive (for instance, grandchildren will not be sorted within each child packet).
This routine takes quadratic time in the number of immediate children (and it's slow quadratic at that).
void regina::NPacket::swapWithNextSibling | ( | ) |
Swaps this packet with its next sibling in the sequence of children beneath their common parent packet.
Calling this routine is equivalent to calling moveDown().
This routine takes small constant time.
If this packet has no next sibling then this routine does nothing.
bool regina::NPacket::unlisten | ( | NPacketListener * | listener | ) |
Unregisters the given packet listener so that it no longer listens for events on this packet.
See the NPacketListener class notes for details.
listener | the listener to unregister. |
true
if the given listener was successfully unregistered, or false
if the given listener was not registered in the first place.
|
inlinevirtual |
Writes the packet details to the given old-style binary file.
You may assume that the packet type and label have already been written. Only the actual data stored in the packet need be written.
The default implementation for this routine does nothing; new packet types should not implement this routine since this file format is now obsolete, and older calculation engines will simply skip unknown packet types when reading from binary files.
out | the file to be written to. |
Reimplemented in regina::NNormalSurfaceList, regina::NTriangulation, regina::NAngleStructureList, regina::NSurfaceFilter, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
void regina::NPacket::writeXMLFile | ( | std::ostream & | out | ) | const |
Writes a complete XML file containing the subtree with this packet as matriarch.
This is the preferred way of writing a packet tree to file.
The output from this routine cannot be used as a piece of an XML file; it must be the entire XML file. For a piece of an XML file, see routine writeXMLPacketTree() instead.
For a handy wrapper to this routine that handles file I/O and compression, see regina::writeXMLFile().
out | the output stream to which the XML should be written. |
|
protectedpure virtual |
Writes a chunk of XML containing the data for this packet only.
You may assume that the packet opening tag (including the packet type and label) has already been written, and that all child packets followed by the corresponding packet closing tag will be written immediately after this routine is called. This routine need only write the internal data stored in this specific packet.
out | the output stream to which the XML should be written. |
Implemented in regina::NTriangulation, regina::NNormalSurfaceList, regina::NSurfaceFilter, regina::NAngleStructureList, regina::NScript, regina::NPDF, regina::NText, and regina::NContainer.
|
protected |
Writes a chunk of XML containing the subtree with this packet as matriarch.
This is the preferred way of writing a packet tree to file.
The output from this routine is only a piece of XML; it should not be used as a complete XML file. For a complete XML file, see routine writeXMLFile() instead.
out | the output stream to which the XML should be written. |
|
static |
Contains the integer ID for this packet.
Each distinct packet type must have a unique ID, and this should be a positive integer. See packetregistry.h for further requirements regarding ID selection.
This member is not actually provided for NPacket itself, but must be declared for every packet subclass that will be instantiated. A value need not be assigned; packetregistry.h will take care of this task when you register the packet.
Reimplemented in regina::NTriangulation, regina::NPDF, regina::NSurfaceFilter, regina::NNormalSurfaceList, regina::NAngleStructureList, regina::NScript, regina::NText, and regina::NContainer.