A packet representing a collection of angle structures on a triangulation. More...
#include <nanglestructurelist.h>
Classes | |
class | Enumerator |
A thread class that actually performs the angle structure enumeration. | |
struct | StructureInserter |
An output iterator used to insert angle structures into an NAngleStructureList. More... | |
Public Member Functions | |
virtual | ~NAngleStructureList () |
Destroys this list and all the angle structures within. | |
NTriangulation * | getTriangulation () const |
Returns the triangulation on which these angle structures lie. | |
unsigned long | getNumberOfStructures () const |
Returns the number of angle structures stored in this list. | |
const NAngleStructure * | getStructure (unsigned long index) const |
Returns the angle structure at the requested index in this list. | |
bool | allowsStrict () const |
Determines whether any convex combination of the angle structures in this list is a strict angle structure. | |
bool | allowsTaut () const |
Determines whether any convex combination of the angle structures in this list is a taut structure. | |
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. | |
Static Public Member Functions | |
static NAngleStructureList * | enumerate (NTriangulation *owner, NProgressManager *manager=0) |
Enumerates all angle structures on the given triangulation. | |
static NXMLPacketReader * | getXMLReader (NPacket *parent) |
(end: File I/O) | |
static NAngleStructureList * | 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 | |
NAngleStructureList () | |
Creates a new angle structure list performing no initialisation whatsoever other than property initialisation. | |
virtual NPacket * | internalClonePacket (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. | |
virtual void | readIndividualProperty (NFile &infile, unsigned propType) |
Reads an individual property from an old-style binary file. | |
void | calculateAllowStrict () const |
Calculate whether the convex span of this list includes a strict angle structure. | |
void | calculateAllowTaut () const |
Calculate whether the convex span of this list includes a taut structure. | |
Friends | |
class | regina::NXMLAngleStructureListReader |
A packet representing a collection of angle structures on a triangulation.
Such a packet must always be a child packet of the triangulation on which the angle structures lie. If this triangulation changes, the information contained in this packet will become invalid.
Angle structure lists should be created using the routine enumerate(), which is new as of Regina 3.95.
regina::NAngleStructureList::~NAngleStructureList | ( | ) | [inline, virtual] |
Destroys this list and all the angle structures within.
regina::NAngleStructureList::NAngleStructureList | ( | ) | [inline, protected] |
Creates a new angle structure list performing no initialisation whatsoever other than property initialisation.
bool regina::NAngleStructureList::allowsStrict | ( | ) | const [inline] |
Determines whether any convex combination of the angle structures in this list is a strict angle structure.
See NAngleStructure::isStrict() for details on strict angle structures.
true
if and only if a strict angle structure can be produced. bool regina::NAngleStructureList::allowsTaut | ( | ) | const [inline] |
Determines whether any convex combination of the angle structures in this list is a taut structure.
See NAngleStructure::isTaut() for details on taut structures.
true
if and only if a taut structure can be produced. void regina::NAngleStructureList::calculateAllowStrict | ( | ) | const [protected] |
Calculate whether the convex span of this list includes a strict angle structure.
void regina::NAngleStructureList::calculateAllowTaut | ( | ) | const [protected] |
Calculate whether the convex span of this list includes a taut structure.
bool regina::NAngleStructureList::dependsOnParent | ( | ) | const [inline, 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. Implements regina::NPacket.
static NAngleStructureList* regina::NAngleStructureList::enumerate | ( | NTriangulation * | owner, |
NProgressManager * | manager = 0 |
||
) | [static] |
Enumerates all angle structures on the given triangulation.
A list containing all vertices of the angle structure solution space will be returned.
The angle structure list that is created will be inserted as the last child of the given triangulation. This triangulation must remain the parent of this angle structure list, and must not change while this angle structure list remains in existence.
If a progress manager is passed, the angle structure enumeration will take place in a new thread and this routine will return immediately. The NProgress object assigned to this progress manager is guaranteed to be of the class NProgressNumber.
If no progress manager is passed, the enumeration will run in the current thread and this routine will return only when the enumeration is complete. Note that this enumeration can be extremely slow for larger triangulations.
owner | the triangulation for which the vertex angle structures will be enumerated. |
manager | a progress manager through which progress will be reported, or 0 if no progress reporting is required. If non-zero, manager must point to a progress manager for which NProgressManager::isStarted() is still false . |
unsigned long regina::NAngleStructureList::getNumberOfStructures | ( | ) | const [inline] |
Returns the number of angle structures stored in this list.
virtual int regina::NAngleStructureList::getPacketType | ( | ) | const [virtual] |
Returns the integer ID representing this type of packet.
This is the same for all packets of this class.
Implements regina::NPacket.
virtual std::string regina::NAngleStructureList::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.
Implements regina::NPacket.
const NAngleStructure * regina::NAngleStructureList::getStructure | ( | unsigned long | index ) | const [inline] |
Returns the angle structure at the requested index in this list.
index | the index of the requested angle structure in this list; this must be between 0 and getNumberOfStructures()-1 inclusive. |
NTriangulation* regina::NAngleStructureList::getTriangulation | ( | ) | const |
Returns the triangulation on which these angle structures lie.
static NXMLPacketReader* regina::NAngleStructureList::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.
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 from regina::NPacket.
virtual NPacket* regina::NAngleStructureList::internalClonePacket | ( | NPacket * | parent ) | const [protected, 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. |
Implements regina::NPacket.
virtual void regina::NAngleStructureList::readIndividualProperty | ( | NFile & | infile, |
unsigned | propType | ||
) | [protected, virtual] |
Reads an individual property from an old-style binary file.
The property type and bookmarking details should not read; merely the contents of the property that are written to file between NFile::writePropertyHeader() and NFile::writePropertyFooter(). See the NFile::writePropertyHeader() notes for details.
The property type of the property to be read will be passed in propType. If the property type is unrecognised, this routine should simply do nothing and return. If the property type is recognised, this routine should read the property and process it accordingly (e.g., store it in whatever data object is currently being read).
infile | the file from which to read the property. This should be open for reading and at the position immediately after writePropertyHeader() would have been called during the corresponding write operation. |
propType | the property type of the property about to be read. |
Implements regina::NFilePropertyReader.
static NAngleStructureList* regina::NAngleStructureList::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.
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 from regina::NPacket.
virtual void regina::NAngleStructureList::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.
out | the file to be written to. |
Reimplemented from regina::NPacket.
virtual void regina::NAngleStructureList::writeTextLong | ( | std::ostream & | out ) | const [virtual] |
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.
out | the output stream to which to write. |
Reimplemented from regina::ShareableObject.
virtual void regina::NAngleStructureList::writeTextShort | ( | std::ostream & | out ) | const [virtual] |
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.
out | the output stream to which to write. |
Implements regina::ShareableObject.
virtual void regina::NAngleStructureList::writeXMLPacketData | ( | std::ostream & | out ) | const [protected, 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. |
Implements regina::NPacket.
const int regina::NAngleStructureList::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.