Regina Calculation Engine
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
regina::NText Class Reference

A packet representing a text string. More...

#include <packet/ntext.h>

Inheritance diagram for regina::NText:
regina::NPacket regina::ShareableObject regina::boost::noncopyable

List of all members.

Public Member Functions

 NText ()
 Initialises the packet to the empty string.
 NText (const std::string &newText)
 Initialises the packet to the given string.
 NText (const char *newText)
 Initialises the packet to the given string.
const std::string & getText () const
 Returns the string stored in the packet.
void setText (const std::string &newText)
 Sets the packet data to the given string.
void setText (const char *newText)
 Sets the packet data to the given string.
virtual int getPacketType () const
 Returns the integer ID representing this type of packet.
virtual std::string getPacketTypeName () const
 Returns an English name for this type of packet.
virtual void writeTextShort (std::ostream &out) const
 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.
virtual void writePacket (NFile &out) const
 Writes the packet details to the given old-style binary file.
virtual bool dependsOnParent () const
 Determines if this packet depends upon its parent.
- Public Member Functions inherited from regina::NPacket
 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.
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.
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.
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.
NPacketgetTreeParent () const
 Determines the parent packet in the tree structure.
NPacketgetFirstTreeChild () const
 Determines the first child of this packet in the tree structure.
NPacketgetLastTreeChild () const
 Determines the last child of this packet in the tree structure.
NPacketgetNextTreeSibling () const
 Determines the next sibling of this packet in the tree structure.
NPacketgetPrevTreeSibling () const
 Determines the previous sibling of this packet in the tree structure.
NPacketgetTreeMatriarch () 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.
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.
NPacketnextTreePacket ()
 Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs.
const NPacketnextTreePacket () const
 Finds the next packet after this in a complete depth-first iteration of the entire tree structure to which this packet belongs.
NPacketfirstTreePacket (const std::string &type)
 Finds the first packet of the requested type in a complete depth-first iteration of the tree structure.
const NPacketfirstTreePacket (const std::string &type) const
 Finds the first packet of the requested type in a complete depth-first iteration of the tree structure.
NPacketnextTreePacket (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 NPacketnextTreePacket (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.
NPacketfindPacketLabel (const std::string &label)
 Finds the packet with the requested label in the tree or subtree for which this packet is matriarch.
const NPacketfindPacketLabel (const std::string &label) const
 Finds the packet with the requested label in the tree or subtree for which this packet is matriarch.
bool isPacketEditable () const
 Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children.
NPacketclone (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.
void writeXMLFile (std::ostream &out) const
 Writes a complete XML file containing the subtree with this packet as matriarch.
- Public Member Functions inherited from regina::ShareableObject
 ShareableObject ()
 Default constructor that does nothing.
virtual ~ShareableObject ()
 Default destructor that does nothing.
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 NXMLPacketReadergetXMLReader (NPacket *parent)
 (end: File I/O)
static NTextreadPacket (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.
- Static Public Attributes inherited from regina::NPacket

Protected Member Functions

virtual NPacketinternalClonePacket (NPacket *parent) const
 Makes a newly allocated copy of this packet.
virtual void writeXMLPacketData (std::ostream &out) const
 Writes a chunk of XML containing the data for this packet only.
- Protected Member Functions inherited from regina::NPacket
void writeXMLPacketTree (std::ostream &out) const
 Writes a chunk of XML containing the subtree with this packet as matriarch.

Additional Inherited Members

- Public Types inherited from regina::NPacket
typedef ChangeEventSpan ChangeEventBlock
 A deprecated typedef for ChangeEventSpan.

Detailed Description

A packet representing a text string.


Constructor & Destructor Documentation

regina::NText::NText ( )
inline

Initialises the packet to the empty string.

regina::NText::NText ( const std::string &  newText)
inline

Initialises the packet to the given string.

Parameters:
newTextthe new value for the packet.
regina::NText::NText ( const char *  newText)
inline

Initialises the packet to the given string.

Parameters:
newTextthe new value for the packet.

Member Function Documentation

bool regina::NText::dependsOnParent ( ) const
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.

Returns:
true if and only if this packet depends on its parent.

Implements regina::NPacket.

virtual int regina::NText::getPacketType ( ) const
virtual

Returns the integer ID representing this type of packet.

This is the same for all packets of this class.

Returns:
the packet type ID.

Implements regina::NPacket.

virtual std::string regina::NText::getPacketTypeName ( ) const
virtual

Returns an English name for this type of packet.

An example is NTriangulation. This is the same for all packets of this class.

Returns:
the packet type name.

Implements regina::NPacket.

const std::string & regina::NText::getText ( ) const
inline

Returns the string stored in the packet.

Returns:
the stored string.
static NXMLPacketReader* regina::NText::getXMLReader ( NPacket parent)
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.

Python:
Not present.
Parameters:
parentthe packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the newly created XML element reader.

Reimplemented from regina::NPacket.

NPacket * regina::NText::internalClonePacket ( NPacket parent) const
inlineprotectedvirtual

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.

Parameters:
parentthe parent beneath which the new packet will eventually be inserted.
Returns:
the newly allocated packet.

Implements regina::NPacket.

static NText* regina::NText::readPacket ( NFile in,
NPacket parent 
)
static

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.

Deprecated:
For the preferred way to read packets from file, see getXMLReader() and class NXMLPacketReader instead.
Precondition:
The given file is open for reading and all above conditions have been satisfied.
Python:
Not present.
Parameters:
inthe file from which to read the packet.
parentthe packet which will become the new packet's parent in the tree structure, or 0 if the new packet is to be tree matriarch.
Returns:
the packet read from file, or 0 if an error occurred.

Reimplemented from regina::NPacket.

void regina::NText::setText ( const std::string &  newText)
inline

Sets the packet data to the given string.

Parameters:
newTextthe new value for the packet.
void regina::NText::setText ( const char *  newText)
inline

Sets the packet data to the given string.

Parameters:
newTextthe new value for the packet.
virtual void regina::NText::writePacket ( NFile out) const
virtual

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.

Deprecated:
For the preferred way to write packets to file, see writeXMLFile() and writeXMLPacketData() instead.
Precondition:
The given file is open for writing and satisfies the assumptions listed above.
Python:
Not present.
Parameters:
outthe file to be written to.

Reimplemented from regina::NPacket.

void regina::NText::writeTextLong ( std::ostream &  out) const
inlinevirtual

Writes this object in long text format to the given output stream.

The output should provided the user with all the information they could want. The output should end with a newline.

The default implementation of this routine merely calls writeTextShort() and adds a newline.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
outthe output stream to which to write.

Reimplemented from regina::ShareableObject.

void regina::NText::writeTextShort ( std::ostream &  out) const
inlinevirtual

Writes this object in short text format to the given output stream.

The output should fit on a single line and no newline should be written.

Python:
The parameter out does not exist; standard output will be used.
Parameters:
outthe output stream to which to write.

Implements regina::ShareableObject.

virtual void regina::NText::writeXMLPacketData ( std::ostream &  out) const
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.

Parameters:
outthe output stream to which the XML should be written.

Implements regina::NPacket.


Member Data Documentation

const int regina::NText::packetType
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 from regina::NPacket.


The documentation for this class was generated from the following file:

Copyright © 1999-2012, The Regina development team
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).