Regina Calculation Engine
|
A packet representing a Python script that can be run. More...
#include <packet/nscript.h>
Public Types | |
typedef ChangeEventSpan | ChangeEventBlock |
A deprecated typedef for ChangeEventSpan. More... | |
Public Member Functions | |
NScript () | |
Initialises to a script with no text and no variables. More... | |
const std::string & | getText () const |
Returns the complete text of this script. More... | |
void | setText (const std::string &newText) |
Replaces the complete text of this script with the given string. More... | |
void | append (const std::string &extraText) |
Adds the given text to the end of this script. More... | |
unsigned long | getNumberOfVariables () const |
Returns the number of variables associated with this script. More... | |
const std::string & | getVariableName (unsigned long index) const |
Returns the name of the requested variable associated with this script. More... | |
long | getVariableIndex (const std::string &name) const |
Returns the index of the variable stored with the given name. More... | |
NPacket * | getVariableValue (unsigned long index) const |
Returns the value of the requested variable associated with this script. More... | |
NPacket * | getVariableValue (const std::string &name) const |
Returns the value of the variable stored with the given name. More... | |
void | setVariableName (unsigned long index, const std::string &name) |
Changes the name of an existing variable associated with this script. More... | |
void | setVariableValue (unsigned long index, NPacket *value) |
Changes the value of an existing variable associated with this script. More... | |
bool | addVariable (const std::string &name, NPacket *value) |
Adds a new variable to be associated with this script. More... | |
void | removeVariable (const std::string &name) |
Removes the variable stored with the given name. More... | |
void | removeVariable (unsigned long index) |
Removes the variable stored at the given index. More... | |
void | removeAllVariables () |
Removes all variables associated with this script. More... | |
virtual void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. More... | |
virtual void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. More... | |
virtual bool | dependsOnParent () const |
Determines if this packet depends upon its parent. More... | |
virtual void | packetWasRenamed (NPacket *packet) |
Called after the packet label or tags have been changed. More... | |
virtual void | packetToBeDestroyed (NPacket *packet) |
Called before the packet is about to be destroyed. More... | |
Packet Identification | |
virtual PacketType | getPacketType () const =0 |
Returns the unique integer ID representing this type of packet. More... | |
virtual std::string | getPacketTypeName () const =0 |
Returns an English name for this type of packet. More... | |
const std::string & | getPacketLabel () const |
Returns the label associated with this individual packet. More... | |
std::string | getHumanLabel () const |
Returns the label associated with this individual packet, adjusted if necessary for human-readable output. More... | |
void | setPacketLabel (const std::string &newLabel) |
Sets the label associated with this individual packet. More... | |
std::string | getFullName () const |
Returns a descriptive text string for the packet. More... | |
std::string | makeUniqueLabel (const std::string &base) const |
Returns a new label that cannot be found anywhere in the entire tree structure. More... | |
bool | makeUniqueLabels (NPacket *reference) |
Ensures that all packet labels in both this and the given packet tree combined are distinct. More... | |
Tags | |
bool | hasTag (const std::string &tag) const |
Determines whether this packet has the given associated tag. More... | |
bool | hasTags () const |
Determines whether this packet has any associated tags at all. More... | |
bool | addTag (const std::string &tag) |
Associates the given tag with this packet. More... | |
bool | removeTag (const std::string &tag) |
Removes the association of the given tag with this packet. More... | |
void | removeAllTags () |
Removes all associated tags from this packet. More... | |
const std::set< std::string > & | getTags () const |
Returns the set of all tags associated with this packet. More... | |
Event Handling | |
bool | listen (NPacketListener *listener) |
Registers the given packet listener to listen for events on this packet. More... | |
bool | isListening (NPacketListener *listener) |
Determines whether the given packet listener is currently listening for events on this packet. More... | |
bool | unlisten (NPacketListener *listener) |
Unregisters the given packet listener so that it no longer listens for events on this packet. More... | |
Tree Queries | |
NPacket * | getTreeParent () const |
Determines the parent packet in the tree structure. More... | |
NPacket * | getFirstTreeChild () const |
Determines the first child of this packet in the tree structure. More... | |
NPacket * | getLastTreeChild () const |
Determines the last child of this packet in the tree structure. More... | |
NPacket * | getNextTreeSibling () const |
Determines the next sibling of this packet in the tree structure. More... | |
NPacket * | getPrevTreeSibling () const |
Determines the previous sibling of this packet in the tree structure. More... | |
NPacket * | getTreeMatriarch () const |
Determines the matriarch (the root) of the tree to which this packet belongs. More... | |
unsigned | levelsDownTo (const NPacket *descendant) const |
Counts the number of levels between this packet and its given descendant in the tree structure. More... | |
unsigned | levelsUpTo (const NPacket *ancestor) const |
Counts the number of levels between this packet and its given ancestor in the tree structure. More... | |
bool | isGrandparentOf (const NPacket *descendant) const |
Determines if this packet is equal to or an ancestor of the given packet in the tree structure. More... | |
unsigned long | getNumberOfChildren () const |
Returns the number of immediate children of this packet. More... | |
unsigned long | getNumberOfDescendants () const |
Returns the total number of descendants of this packet. More... | |
unsigned long | getTotalTreeSize () const |
Determines the total number of packets in the tree or subtree for which this packet is matriarch. More... | |
Tree Manipulation | |
void | insertChildFirst (NPacket *child) |
Inserts the given packet as the first child of this packet. More... | |
void | insertChildLast (NPacket *child) |
Inserts the given packet as the last child of this packet. More... | |
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. More... | |
void | makeOrphan () |
Cuts this packet away from its parent in the tree structure and instead makes it matriarch of its own tree. More... | |
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. More... | |
void | swapWithNextSibling () |
Swaps this packet with its next sibling in the sequence of children beneath their common parent packet. More... | |
void | moveUp (unsigned steps=1) |
Moves this packet the given number of steps towards the beginning of its sibling list. More... | |
void | moveDown (unsigned steps=1) |
Moves this packet the given number of steps towards the end of its sibling list. More... | |
void | moveToFirst () |
Moves this packet to be the first in its sibling list. More... | |
void | moveToLast () |
Moves this packet to be the last in its sibling list. More... | |
void | sortChildren () |
Sorts the immediate children of this packet according to their packet labels. More... | |
Searching and Iterating | |
NPacket * | nextTreePacket () |
Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs. More... | |
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. More... | |
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. More... | |
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. More... | |
NPacket * | firstTreePacket (const std::string &type) |
Finds the first packet of the requested type in a complete depth-first iteration of the tree structure. More... | |
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. More... | |
NPacket * | findPacketLabel (const std::string &label) |
Finds the packet with the requested label in the tree or subtree for which this packet is matriarch. More... | |
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. More... | |
Packet Dependencies | |
bool | isPacketEditable () const |
Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children. More... | |
Cloning | |
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. More... | |
File I/O | |
bool | save (const char *filename, bool compressed=true) const |
Saves the subtree rooted at this packet to the given Regina data file, using Regina's native XML file format. More... | |
void | writeXMLFile (std::ostream &out) const |
Writes the subtree rooted at this packet to the given output stream in Regina's native XML file format. More... | |
std::string | internalID () const |
Returns a unique string ID that identifies this packet. More... | |
Input and Output | |
std::string | str () const |
Returns the output from writeTextShort() as a string. More... | |
std::string | toString () const |
A deprecated alias for str(), which returns the output from writeTextShort() as a string. More... | |
std::string | detail () const |
Returns the output from writeTextLong() as a string. More... | |
std::string | toStringLong () const |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string. More... | |
Packet Listener Interface | |
void | unregisterFromAllPackets () |
Unregisters this listener from any packets to which it is currently listening. More... | |
virtual void | packetToBeChanged (NPacket *packet) |
Called before the contents of the packet are to be changed. More... | |
virtual void | packetWasChanged (NPacket *packet) |
Called after the contents of the packet have been changed. More... | |
virtual void | packetToBeRenamed (NPacket *packet) |
Called before the packet label or tags are to be changed. More... | |
virtual void | childToBeAdded (NPacket *packet, NPacket *child) |
Called before a child packet is to be inserted directly beneath the packet. More... | |
virtual void | childWasAdded (NPacket *packet, NPacket *child) |
Called after a child packet has been inserted directly beneath the packet. More... | |
virtual void | childToBeRemoved (NPacket *packet, NPacket *child, bool inParentDestructor) |
Called before a child packet is to be removed from directly beneath the packet. More... | |
virtual void | childWasRemoved (NPacket *packet, NPacket *child, bool inParentDestructor) |
Called after a child packet has been removed from directly beneath the packet. More... | |
virtual void | childrenToBeReordered (NPacket *packet) |
Called before the child packets directly beneath the packet are to be reordered. More... | |
virtual void | childrenWereReordered (NPacket *packet) |
Called after the child packets directly beneath the packet have been reordered. More... | |
Static Public Member Functions | |
static NXMLPacketReader * | getXMLReader (NPacket *parent, NXMLTreeResolver &resolver) |
Protected Member Functions | |
virtual NPacket * | internalClonePacket (NPacket *parent) const |
Makes a newly allocated copy of this packet. More... | |
virtual void | writeXMLPacketData (std::ostream &out) const |
Writes a chunk of XML containing the data for this packet only. More... | |
void | writeXMLPacketTree (std::ostream &out) const |
Writes a chunk of XML containing the subtree with this packet as matriarch. More... | |
A packet representing a Python script that can be run.
A script consists of two parts: (i) the text, which contains the Python code; and (ii) a set of variables, which refer to packets in your packet tree. When running a script, the variables should be instantiated in the default namespace before the script is run.
The values of variables are given by pointers to packets (not packet labels, as in some old versions of Regina). This affects how variables react to changes in the packets that they point to. In particular, if a variable V points to some packet P, then:
None
, and the script will likewise notify listeners of the change.
|
inherited |
A deprecated typedef for ChangeEventSpan.
|
inline |
Initialises to a script with no text and no variables.
|
inherited |
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.
|
inline |
Adds a new variable to be associated with this script.
If a variable with the given name is already stored, this routine will do nothing.
name | the name of the new variable. |
value | the value of the new variable; this is allowed to be null . |
true
if the variable was successfully added, or false
if a variable with the given name was already stored.
|
inline |
Adds the given text to the end of this script.
extraText | the text to add. |
|
inlinevirtualinherited |
Called before the child packets directly beneath the packet are to be reordered.
Once the reordering is done, childrenWereReordered() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
|
inlinevirtualinherited |
Called after the child packets directly beneath the packet have been reordered.
Before this reordering is done, childrenToBeReordered() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
|
inlinevirtualinherited |
Called before a child packet is to be inserted directly beneath the packet.
Once the child is removed, childWasAdded() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
child | the child packet to be added. |
|
inlinevirtualinherited |
Called before a child packet is to be removed from directly beneath the packet.
Note that the child packet may be about to be destroyed (although this destruction will not have happened yet). Once the child is removed, childWasRemoved() will be called also.
Note also that this packet (the parent) may have already entered its destructor (which removes and destroys all child packets as a matter of course). In this situation it may be unsafe to query or update this packet, and so the third argument inParentDestructor is provided to indicate such a situation.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
child | the child packet to be removed. |
inParentDestructor | set to true if the parent packet is in fact being destroyed, and the child was simply removed as part of the standard subtree destruction. |
|
inlinevirtualinherited |
Called after a child packet has been inserted directly beneath the packet.
Before this child is added, childToBeAdded() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
child | the child packet that was added. |
|
inlinevirtualinherited |
Called after a child packet has been removed from directly beneath the packet.
Note that the child packet may be about to be destroyed (although this destruction will not have happened yet). Before this child is removed, childToBeRemoved() will be called also.
Note also that this packet (the parent) may have already entered its destructor (which removes and destroys all child packets as a matter of course). In this situation it may be unsafe to query or update this packet, and so the third argument inParentDestructor is provided to indicate such a situation.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
child | the child packet that was removed. |
inParentDestructor | set to true if the parent packet is in fact being destroyed, and the child was simply removed as part of the standard subtree destruction. |
|
inherited |
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. |
|
inlinevirtual |
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. Implements regina::NPacket.
|
inherited |
Returns the output from writeTextLong() as a string.
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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. |
|
inlineinherited |
Determines the first child of this packet in the tree structure.
This routine takes small constant time.
|
inherited |
Returns a descriptive text string for the packet.
The string is of the form label (packet-type).
The packet label will be adjusted for human-readable output according to the behaviour of getHumanLabel().
|
inlineinherited |
Returns the label associated with this individual packet, adjusted if necessary for human-readable output.
In particular, if the packet has no label assigned then this routine will return "(no label)", not the empty string.
|
inlineinherited |
Determines the last child of this packet in the tree structure.
This routine takes small constant time.
|
inlineinherited |
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.
|
inherited |
Returns the number of immediate children of this packet.
Grandchildren and so on are not counted.
|
inlineinherited |
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 number of variables associated with this script.
|
inlineinherited |
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 virtualinherited |
Returns the unique integer ID representing this type of packet.
This is the same for all packets of this class.
|
pure virtualinherited |
Returns an English name for this type of packet.
An example is NTriangulation
. This is the same for all packets of this class.
|
inlineinherited |
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.
|
inlineinherited |
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.
|
inline |
Returns the complete text of this script.
Variables are not considered part of the text; you can get and set them through other member functions (see below).
|
inherited |
Determines the total number of packets in the tree or subtree for which this packet is matriarch.
This packet is included in the count.
|
inherited |
Determines the matriarch (the root) of the tree to which this packet belongs.
|
inlineinherited |
Determines the parent packet in the tree structure.
This routine takes small constant time.
long regina::NScript::getVariableIndex | ( | const std::string & | name | ) | const |
Returns the index of the variable stored with the given name.
name | the name of the requested variable; note that names are case sensitive. |
const std::string& regina::NScript::getVariableName | ( | unsigned long | index | ) | const |
Returns the name of the requested variable associated with this script.
index | the index of the requested variable; this must be between 0 and getNumberOfVariables()-1 inclusive. |
NPacket* regina::NScript::getVariableValue | ( | unsigned long | index | ) | const |
Returns the value of the requested variable associated with this script.
Variables may take the value null
.
index | the index of the requested variable; this must be between 0 and getNumberOfVariables()-1 inclusive. |
NPacket* regina::NScript::getVariableValue | ( | const std::string & | name | ) | const |
Returns the value of the variable stored with the given name.
Variables may take the value null
.
If no variable is stored with the given name, then null
will likewise be returned.
name | the name of the requested variable; note that names are case sensitive. |
|
inlineinherited |
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.
|
inlineinherited |
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. |
|
inherited |
Inserts the given packet as the first child of this packet.
This routine takes small constant time.
child | the child to insert. |
|
inherited |
Inserts the given packet as the last child of this packet.
This routine takes small constant time.
child | the child to insert. |
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. |
Implements regina::NPacket.
|
inherited |
Returns a unique string ID that identifies this packet.
The user has no control over this ID, and it is not human readable. It is guaranteed to remain fixed throughout the lifetime of the program for a given packet, and it is guaranteed not to clash with the ID of any other packet.
If you change the contents of a packet, its ID will not change.
If you clone a packet, the new clone will receive a different ID. If you save and then load a packet to/from file, the ID will change. These behaviours are necessary to ensure that IDs remain unique (since, for instance, you could load several copies of the same data file into memory simultaneously).
The ID is implemented as an encoding of the underlying C++ pointer. This encoding is subject to change in later versions of Regina.
|
inherited |
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
.
|
inlineinherited |
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.
|
inherited |
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.
|
inherited |
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. |
|
inlineinherited |
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. |
|
inherited |
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.
|
inherited |
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.
|
inherited |
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. |
|
inherited |
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.
|
inherited |
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.
|
inherited |
Moves this packet to be the first in its sibling list.
This routine takes small constant time.
|
inherited |
Moves this packet to be the last in its sibling list.
This routine takes small constant time.
|
inherited |
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.
|
inherited |
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.
|
inherited |
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.
|
inherited |
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. |
|
inherited |
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. |
|
inlinevirtualinherited |
Called before the contents of the packet are to be changed.
Once the contents are changed, packetWasChanged() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
|
virtual |
Called before the packet is about to be destroyed.
Note that there is no matching function called after the packet is destroyed, since the set of listeners will no longer be available at that stage.
When an entire packet subtree is to be destroyed, child packets will notify their listeners of the impending destruction before parent packets will.
Note that the packet will forcibly unregister this listener immediately before packetToBeDestroyed() is called, to avoid any unpleasant consequences if this listener should also try to unregister itself. This means that, by the time this routine is called, this listener will no longer be registered with the packet in question (and any attempt to unregister it again will be harmless).
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
Reimplemented from regina::NPacketListener.
|
inlinevirtualinherited |
Called before the packet label or tags are to be changed.
Once the label or tags are changed, packetWasRenamed() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
|
inlinevirtualinherited |
Called after the contents of the packet have been changed.
Before the contents are changed, packetToBeChanged() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
Reimplemented in regina::NSnapPeaTriangulation.
|
virtual |
Called after the packet label or tags have been changed.
Before the label or tags are changed, packetToBeRenamed() will be called also.
The default implementation of this routine is to do nothing.
packet | the packet being listened to. |
Reimplemented from regina::NPacketListener.
|
inherited |
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.
|
inline |
Removes all variables associated with this script.
|
inherited |
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::NScript::removeVariable | ( | const std::string & | name | ) |
Removes the variable stored with the given name.
If no variable is stored with the given name, this routine will do nothing.
name | the name of the variable to remove; note that names are case sensitive. |
void regina::NScript::removeVariable | ( | unsigned long | index | ) |
Removes the variable stored at the given index.
index | the index of the variable to remove; this must be between 0 and getNumberOfVariables()-1 inclusive. |
|
inherited |
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. |
|
inherited |
Saves the subtree rooted at this packet to the given Regina data file, using Regina's native XML file format.
The XML file may be optionally compressed (Regina can happily read both compressed and uncompressed XML).
This is the preferred way of saving a Regina data file. Typically this will be called from the root of the packet tree, which will save the entire packet tree to file.
filename | the pathname of the file to write to. |
compressed | true if the XML data should be compressed, or false if it should be written as plain text. |
true
if and only if the file was successfully written.
|
inherited |
Sets the label associated with this individual packet.
newLabel | the new label to give this packet. |
|
inline |
Replaces the complete text of this script with the given string.
Variables are not considered part of the text; you can get and set them through other member functions (see below).
newText | the new text for this script. |
void regina::NScript::setVariableName | ( | unsigned long | index, |
const std::string & | name | ||
) |
Changes the name of an existing variable associated with this script.
index | the index of the variable whose name should change; this must be between 0 and getNumberOfVariables()-1 inclusive. |
name | the new name to assign to the variable. |
void regina::NScript::setVariableValue | ( | unsigned long | index, |
NPacket * | value | ||
) |
Changes the value of an existing variable associated with this script.
index | the index of the variable whose value should change; this must be between 0 and getNumberOfVariables()-1 inclusive. |
value | the new value to assign to the variable. |
|
inherited |
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).
|
inherited |
Returns the output from writeTextShort() as a string.
__str__()
function.
|
inherited |
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.
|
inlineinherited |
A deprecated alias for str(), which returns the output from writeTextShort() as a string.
|
inlineinherited |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string.
|
inherited |
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.
|
inherited |
Unregisters this listener from any packets to which it is currently listening.
|
virtual |
Writes this object in long text format to the given output stream.
The output should provide the user with all the information they could want. The output should be human-readable, should not contain extremely long lines (so users can read the output in a terminal), and should end with a final newline.
The default implementation of this routine merely calls writeTextShort() and adds a newline.
out | the output stream to which to write. |
Reimplemented from regina::ShareableObject.
|
inlinevirtual |
Writes this object in short text format to the given output stream.
The output should be human-readable, should fit on a single line, and should not end with a newline.
out | the output stream to which to write. |
Implements regina::ShareableObject.
|
inherited |
Writes the subtree rooted at this packet to the given output stream in Regina's native XML file format.
Ths is similar to calling save(), except that (i) the user has a more flexible choice of output stream, and (ii) the XML will always be written in plain text (i.e., it will not be compressed).
If you simply wish to save your data to a file on the filesystem, you should call save() instead.
Typically this will be called from the root of the packet tree, which will write the entire packet tree to the output stream.
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.
out | the output stream to which the XML data file should be written. |
|
protectedvirtual |
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. |
Implements regina::NPacket.
|
protectedinherited |
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. |