Regina Calculation Engine
|
A normal surface filter that filters by basic properties of the normal surface. More...
#include <surfaces/surfacefilter.h>
Public Types | |
typedef Packet | SafePointeeType |
The type of object being pointed to. More... | |
Public Member Functions | |
SurfaceFilterProperties () | |
Creates a new surface filter that accepts all normal surfaces. More... | |
SurfaceFilterProperties (const SurfaceFilterProperties &cloneMe) | |
Creates a new surface filter that is a clone of the given surface filter. More... | |
const std::set< LargeInteger > & | eulerChars () const |
Returns the set of allowable Euler characteristics. More... | |
size_t | countEulerChars () const |
Returns the number of allowable Euler characteristics. More... | |
LargeInteger | eulerChar (size_t index) const |
Returns the allowable Euler characteristic at the given index in the set. More... | |
BoolSet | orientability () const |
Returns the set of allowable orientabilities. More... | |
BoolSet | compactness () const |
Returns the set of allowable compactness properties. More... | |
BoolSet | realBoundary () const |
Returns the set of allowable has-real-boundary properties. More... | |
void | setEulerChars (const std::set< LargeInteger > &s) |
Sets the allowable Euler characteristics to the given set. More... | |
void | addEulerChar (const LargeInteger &ec) |
Adds the given Euler characteristic to the set of allowable Euler characteristics. More... | |
void | removeEulerChar (const LargeInteger &ec) |
Removes the given Euler characteristic from the set of allowable Euler characteristics. More... | |
void | removeAllEulerChars () |
Empties the set of allowable Euler characteristics. More... | |
void | setOrientability (const BoolSet &value) |
Sets the set of allowable orientabilities. More... | |
void | setCompactness (const BoolSet &value) |
Sets the set of allowable compactness properties. More... | |
void | setRealBoundary (const BoolSet &value) |
Sets the set of allowable has-real-boundary properties. More... | |
virtual bool | accept (const NormalSurface &surface) const override |
Decides whether or not the given normal surface is accepted by this filter. More... | |
virtual void | writeTextLong (std::ostream &out) const override |
Writes a detailed text representation of this object to the given output stream. More... | |
virtual SurfaceFilterType | filterType () const |
Returns the unique integer ID corresponding to the filtering method that is this particular subclass of SurfaceFilter. More... | |
virtual std::string | filterTypeName () const |
Returns a string description of the filtering method that is this particular subclass of SurfaceFilter. More... | |
virtual void | writeTextShort (std::ostream &out) const override |
Writes a short text representation of this object to the given output stream. More... | |
virtual bool | dependsOnParent () const override |
Determines if this packet depends upon its parent. More... | |
bool | hasOwner () const |
Indicates whether some other object in the calculation engine is responsible for ultimately destroying this object. More... | |
std::string | str () const |
Returns a short text representation of this object. More... | |
std::string | utf8 () const |
Returns a short text representation of this object using unicode characters. More... | |
std::string | detail () const |
Returns a detailed text representation of this object. More... | |
bool | hasSafePtr () const |
Is there one or more SafePtr currently pointing to this object? More... | |
Packet Identification | |
virtual PacketType | type () const =0 |
Returns the unique integer ID representing this type of packet. More... | |
virtual std::string | typeName () const =0 |
Returns an English name for this type of packet. More... | |
const std::string & | label () const |
Returns the label associated with this individual packet. More... | |
std::string | humanLabel () const |
Returns the label associated with this individual packet, adjusted if necessary for human-readable output. More... | |
std::string | adornedLabel (const std::string &adornment) const |
Returns the label of this packet adorned with the given string. More... | |
void | setLabel (const std::string &label) |
Sets the label associated with this individual packet. More... | |
std::string | fullName () const |
Returns a descriptive text string for the packet. 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 > & | tags () const |
Returns the set of all tags associated with this packet. More... | |
Event Handling | |
bool | listen (PacketListener *listener) |
Registers the given packet listener to listen for events on this packet. More... | |
bool | isListening (PacketListener *listener) |
Determines whether the given packet listener is currently listening for events on this packet. More... | |
bool | unlisten (PacketListener *listener) |
Unregisters the given packet listener so that it no longer listens for events on this packet. More... | |
Tree Queries | |
Packet * | parent () const |
Determines the parent packet in the tree structure. More... | |
Packet * | firstChild () const |
Determines the first child of this packet in the tree structure. More... | |
Packet * | lastChild () const |
Determines the last child of this packet in the tree structure. More... | |
Packet * | nextSibling () const |
Determines the next sibling of this packet in the tree structure. More... | |
Packet * | prevSibling () const |
Determines the previous sibling of this packet in the tree structure. More... | |
Packet * | root () const |
Determines the root of the tree to which this packet belongs. More... | |
unsigned | levelsDownTo (const Packet *descendant) const |
Counts the number of levels between this packet and its given descendant in the tree structure. More... | |
unsigned | levelsUpTo (const Packet *ancestor) const |
Counts the number of levels between this packet and its given ancestor in the tree structure. More... | |
bool | isGrandparentOf (const Packet *descendant) const |
Determines if this packet is equal to or an ancestor of the given packet in the tree structure. More... | |
size_t | countChildren () const |
Returns the number of immediate children of this packet. More... | |
size_t | countDescendants () const |
Returns the total number of strict descendants of this packet. More... | |
size_t | totalTreeSize () const |
Determines the total number of packets in the tree or subtree for which this packet is matriarch. More... | |
Tree Manipulation | |
void | insertChildFirst (Packet *child) |
Inserts the given packet as the first child of this packet. More... | |
void | insertChildLast (Packet *child) |
Inserts the given packet as the last child of this packet. More... | |
void | insertChildAfter (Packet *newChild, Packet *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 (Packet *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 | transferChildren (Packet *newParent) |
Cuts all of this packet's children out of the packet tree, and reinserts them as children 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 | |
SubtreeIterator | begin () |
Returns an iterator at the beginning of the range of packets in the subtree rooted at this packet. More... | |
SubtreeIterator | end () |
Returns an iterator beyond the end of the range of packets in the subtree rooted at this packet. More... | |
PacketDescendants | descendants () const |
Returns a lightweight object for iterating through all strict descendants of this packet in the packet tree. More... | |
PacketChildren | children () const |
Returns a lightweight object for iterating through the immediate children of this packet. More... | |
Packet * | 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 Packet * | 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... | |
Packet * | 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 Packet * | 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... | |
Packet * | 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 Packet * | 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... | |
Packet * | 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 Packet * | 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 | |
Packet * | 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... | |
bool | save (std::ostream &s, bool compressed=true) const |
Writes the subtree rooted at this packet to the given output stream, in the format of a Regina XML data file. 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... | |
Static Public Member Functions | |
static XMLFilterReader * | xmlFilterReader (Packet *parent) |
static XMLPacketReader * | xmlReader (Packet *parent, XMLTreeResolver &resolver) |
Constructors and Destructors | |
static void | safeDelete (Packet *p) |
Either destroys or orphans the given packet, according to whether it has safe pointers that currently reference it. More... | |
Static Public Attributes | |
static constexpr const SurfaceFilterType | filterTypeID |
A compile-time constant that identifies this type of surface filter. More... | |
Protected Member Functions | |
virtual Packet * | internalClonePacket (Packet *parent) const override |
Makes a newly allocated copy of this packet. More... | |
virtual void | writeXMLFilterData (std::ostream &out) const override |
Writes a chunk of XML containing the details of this filter. More... | |
virtual void | writeXMLPacketData (std::ostream &out) const override |
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 normal surface filter that filters by basic properties of the normal surface.
If a property of the surface (such as Euler characteristic or orientability) cannot be determined, the surface will pass any test based on that particular property. For instance, say a surface is required to be both orientable and compact, and say that orientability cannot be determined. Then the surface will be accepted solely on the basis of whether or not it is compact.
|
inherited |
The type of object being pointed to.
|
inline |
Creates a new surface filter that accepts all normal surfaces.
|
inline |
Creates a new surface filter that is a clone of the given surface filter.
cloneMe | the surface filter to clone. |
|
overridevirtual |
Decides whether or not the given normal surface is accepted by this filter.
The default implementation simply returns true
.
surface | the normal surface under investigation. |
true
if and only if the given surface is accepted by this filter. Reimplemented from regina::SurfaceFilter.
|
inline |
Adds the given Euler characteristic to the set of allowable Euler characteristics.
See eulerChars() for further details.
ec | the new allowable Euler characteristic. |
|
inline |
Returns the set of allowable compactness properties.
Note that this is a subset of { true, false }
. Any surface whose compactness property is not in this set will not be accepted by this filter.
|
inline |
Returns the number of allowable Euler characteristics.
See eulerChars() for further details.
|
inlineoverridevirtualinherited |
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::Packet.
|
inherited |
Returns a detailed text representation of this object.
This text may span many lines, and should provide the user with all the information they could want. It should be human-readable, should not contain extremely long lines (which cause problems for users reading the output in a terminal), and should end with a final newline. There are no restrictions on the underlying character set.
LargeInteger regina::SurfaceFilterProperties::eulerChar | ( | size_t | index | ) | const |
Returns the allowable Euler characteristic at the given index in the set.
See eulerChars() for further details.
index | the index in the set of allowable Euler characteristics; this must be between 0 and countEulerChars()-1 inclusive. |
|
inline |
Returns the set of allowable Euler characteristics.
Any surface whose Euler characteristic is not in this set will not be accepted by this filter. The set will be given in ascending order with no element repeated.
If this set is empty, all Euler characteristics will be accepted.
|
inlinevirtualinherited |
Returns the unique integer ID corresponding to the filtering method that is this particular subclass of SurfaceFilter.
|
inlinevirtualinherited |
Returns a string description of the filtering method that is this particular subclass of SurfaceFilter.
|
inlineinherited |
Is there one or more SafePtr currently pointing to this object?
|
inlineoverrideprotectedvirtual |
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. |
Reimplemented from regina::SurfaceFilter.
|
inline |
Returns the set of allowable orientabilities.
Note that this is a subset of { true, false }
. Any surface whose orientability is not in this set will not be accepted by this filter.
|
inline |
Returns the set of allowable has-real-boundary properties.
Note that this is a subset of { true, false }
. Any surface whose has-real-boundary property is not in this set will not be accepted by this filter.
|
inline |
Empties the set of allowable Euler characteristics.
See eulerChars() for further details.
Note that this will mean that this filter will allow any Euler characteristic to pass.
|
inline |
Removes the given Euler characteristic from the set of allowable Euler characteristics.
See eulerChars() for further details.
Note that if the allowable set is completely emptied, this filter will allow any Euler characteristic to pass.
ec | the allowable Euler characteristic to remove. |
|
inline |
Sets the set of allowable compactness properties.
See compactness() for further details.
value | the new set of allowable compactness properties. |
|
inline |
Sets the allowable Euler characteristics to the given set.
See eulerChars() for further details.
s | the new set of allowable Euler characteristics. |
|
inline |
Sets the set of allowable orientabilities.
See orientability() for further details.
value | the new set of allowable orientabilities. |
|
inline |
Sets the set of allowable has-real-boundary properties.
See realBoundary() for further details.
value | the new set of allowable has-real-boundary properties. |
|
inherited |
Returns a short text representation of this object.
This text should be human-readable, should fit on a single line, and should not end with a newline. Where possible, it should use plain ASCII characters.
__str__()
.
|
inherited |
Returns a short text representation of this object using unicode characters.
Like str(), this text should be human-readable, should fit on a single line, and should not end with a newline. In addition, it may use unicode characters to make the output more pleasant to read. This string will be encoded in UTF-8.
|
overridevirtual |
Writes a detailed text representation of this object to the given output stream.
This may be reimplemented by subclasses, but the parent Packet class offers a reasonable default implementation.
out | the output stream to which to write. |
Reimplemented from regina::Packet.
|
inlineoverridevirtualinherited |
Writes a short text representation of this object to the given output stream.
This must be reimplemented by subclasses.
out | the output stream to which to write. |
Implements regina::Packet.
|
overrideprotectedvirtual |
Writes a chunk of XML containing the details of this filter.
You may assume that the filter opening tag (including the filter type) has already been written, and that the filter closing tag will be written immediately after this routine is called. This routine need only write the additional details corresponding to this particular subclass of SurfaceFilter.
out | the output stream to which the XML should be written. |
Reimplemented from regina::SurfaceFilter.
|
overrideprotectedvirtualinherited |
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::Packet.
|
staticinherited |
A compile-time constant that identifies this type of surface filter.