Regina Calculation Engine
|
A normal surface filter that filters by basic properties of the normal surface. More...
#include <surfaces/sfproperties.h>
Public Member Functions | |
NSurfaceFilterProperties () | |
Creates a new surface filter that accepts all normal surfaces. More... | |
NSurfaceFilterProperties (const NSurfaceFilterProperties &cloneMe) | |
Creates a new surface filter that is a clone of the given surface filter. More... | |
const std::set< NLargeInteger > & | getECs () const |
Returns the set of allowable Euler characteristics. More... | |
unsigned long | getNumberOfECs () const |
Returns the number of allowable Euler characteristics. More... | |
NLargeInteger | getEC (unsigned long index) const |
Returns the allowable Euler characteristic at the given index in the set. More... | |
NBoolSet | getOrientability () const |
Returns the set of allowable orientabilities. More... | |
NBoolSet | getCompactness () const |
Returns the set of allowable compactness properties. More... | |
NBoolSet | getRealBoundary () const |
Returns the set of allowable has-real-boundary properties. More... | |
void | addEC (const NLargeInteger &ec) |
Adds the given Euler characteristic to the set of allowable Euler characteristics. More... | |
void | removeEC (const NLargeInteger &ec) |
Removes the given Euler characteristic from the set of allowable Euler characteristics. More... | |
void | removeAllECs () |
Empties the set of allowable Euler characteristics. More... | |
void | setOrientability (const NBoolSet &value) |
Sets the set of allowable orientabilities. More... | |
void | setCompactness (const NBoolSet &value) |
Sets the set of allowable compactness properties. More... | |
void | setRealBoundary (const NBoolSet &value) |
Sets the set of allowable has-real-boundary properties. More... | |
virtual bool | accept (const NNormalSurface &surface) const |
Decides whether or not the given normal surface is accepted by this filter. More... | |
virtual void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. More... | |
virtual int | getFilterID () const |
Returns the unique integer ID corresponding to the filtering method that is this particular subclass of NSurfaceFilter. More... | |
virtual std::string | getFilterName () const |
Returns a string description of the filtering method that is this particular subclass of NSurfaceFilter. More... | |
![]() | |
NSurfaceFilter () | |
Creates a new default surface filter. More... | |
NSurfaceFilter (const NSurfaceFilter &cloneMe) | |
Creates a new default surface filter. More... | |
virtual | ~NSurfaceFilter () |
Destroys this surface filter. More... | |
virtual int | getPacketType () const |
Returns the integer ID representing this type of packet. More... | |
virtual std::string | getPacketTypeName () const |
Returns an English name for this type of packet. More... | |
virtual void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. More... | |
virtual void | writePacket (NFile &out) const |
Writes the packet details to the given old-style binary file. More... | |
virtual bool | dependsOnParent () const |
Determines if this packet depends upon its parent. More... | |
![]() | |
NPacket (NPacket *parent=0) | |
Constructor that inserts the new packet into the overall tree structure. More... | |
virtual | ~NPacket () |
Destructor that also orphans this packet and destroys all of its descendants. More... | |
const std::string & | getPacketLabel () const |
Returns the label associated with this individual packet. 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... | |
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... | |
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... | |
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... | |
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... | |
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 * | 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 * | 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 * | 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... | |
bool | isPacketEditable () const |
Determines whether this packet can be altered without invalidating or otherwise upsetting any of its immediate children. More... | |
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... | |
void | writeXMLFile (std::ostream &out) const |
Writes a complete XML file containing the subtree with this packet as matriarch. More... | |
![]() | |
ShareableObject () | |
Default constructor that does nothing. More... | |
virtual | ~ShareableObject () |
Default destructor that does nothing. More... | |
std::string | toString () const |
Returns the output from writeTextShort() as a string. More... | |
std::string | toStringLong () const |
Returns the output from writeTextLong() as a string. More... | |
![]() | |
virtual | ~NFilePropertyReader () |
Default destructor that does nothing. More... | |
Static Public Member Functions | |
static NXMLFilterReader * | getXMLFilterReader (NPacket *parent) |
static NSurfaceFilter * | readFilter (NFile &in, NPacket *parent) |
![]() | |
static NXMLFilterReader * | getXMLFilterReader (NPacket *parent) |
Returns a newly created XML filter reader that will read the details of a particular type of surface filter. More... | |
static NSurfaceFilter * | readFilter (NFile &in, NPacket *parent) |
Reads the details of a normal surface filter from the specified old-style binary file and returns a newly created filter containing that information. More... | |
static NXMLPacketReader * | getXMLReader (NPacket *parent) |
static NSurfaceFilter * | readPacket (NFile &in, NPacket *parent) |
![]() | |
static NXMLPacketReader * | getXMLReader (NPacket *parent) |
(end: File I/O) More... | |
static NPacket * | readPacket (NFile &in, NPacket *parent) |
Reads a single packet from the specified file and returns a newly created object containing that information. More... | |
Static Public Attributes | |
static const int | filterID |
![]() | |
static const int | filterID |
Contains the integer ID for this type of surface filter. More... | |
static const int | packetType |
![]() | |
static const int | packetType |
Contains the integer ID for this packet. More... | |
Protected Member Functions | |
virtual void | writeXMLFilterData (std::ostream &out) const |
Writes a chunk of XML containing the details of this filter. More... | |
virtual void | writeFilter (NFile &out) const |
Writes the details of this filter to the given old-style binary file. More... | |
virtual void | writeProperties (NFile &out) const |
Writes to the given old-style binary file any properties associated specifically with this particular subclass of NSurfaceFilter. More... | |
virtual void | readIndividualProperty (NFile &infile, unsigned propType) |
Reads an individual property from an old-style binary file. More... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
typedef ChangeEventSpan | ChangeEventBlock |
A deprecated typedef for ChangeEventSpan. 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.
|
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. |
|
virtual |
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::NSurfaceFilter.
|
inline |
Adds the given Euler characteristic to the set of allowable Euler characteristics.
See getECs() 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.
NLargeInteger regina::NSurfaceFilterProperties::getEC | ( | unsigned long | index | ) | const |
Returns the allowable Euler characteristic at the given index in the set.
See getECs() for further details.
index | the index in the set of allowable Euler characteristics; this must be between 0 and getNumberOfECs()-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.
|
virtual |
Returns the unique integer ID corresponding to the filtering method that is this particular subclass of NSurfaceFilter.
Reimplemented from regina::NSurfaceFilter.
|
virtual |
Returns a string description of the filtering method that is this particular subclass of NSurfaceFilter.
Reimplemented from regina::NSurfaceFilter.
|
inline |
Returns the number of allowable Euler characteristics.
See getECs() for further details.
|
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.
|
protectedvirtual |
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. |
Reimplemented from regina::NSurfaceFilter.
|
inline |
Empties the set of allowable Euler characteristics.
See getECs() 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 getECs() 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 getCompactness() for further details.
value | the new set of allowable compactness properties. |
|
inline |
Sets the set of allowable orientabilities.
See getOrientability() for further details.
value | the new set of allowable orientabilities. |
|
inline |
Sets the set of allowable has-real-boundary properties.
See getRealBoundary() for further details.
value | the new set of allowable has-real-boundary properties. |
|
inlineprotectedvirtual |
Writes the details of this filter to the given old-style binary file.
You may assume that general packet information and the filter ID have already been written. Only the actual data stored for this particular subclass of NSurfaceFilter need be written.
Properties should not be written from here; this will be done later by another routine.
The default implementation for this routine does nothing; new filter types should not implement this routine since this file format is now obsolete, and older calculation engines will simply skip unknown filter types when reading from binary files.
out | the file to be written to. |
Reimplemented from regina::NSurfaceFilter.
|
protectedvirtual |
Writes to the given old-style binary file any properties associated specifically with this particular subclass of NSurfaceFilter.
This routine should consist of a call to the superclass implementation followed by a series of writePropertyHeader() and writePropertyFooter() calls with property information being written inside these pairs.
This routine should not call writeAllPropertiesFooter().
The default implementation for this routine does nothing; new filter types should not implement this routine since this file format is now obsolete, and older calculation engines will simply skip unknown filter types when reading from binary files.
out | the file to be written to. |
Reimplemented from regina::NSurfaceFilter.
|
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.
|
protectedvirtual |
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 NSurfaceFilter.
out | the output stream to which the XML should be written. |
Reimplemented from regina::NSurfaceFilter.