Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

regina::NSurfaceFilter Class Reference
[Normal Surfaces]

A packet that accepts or rejects normal surfaces. More...

#include <nsurfacefilter.h>

Inheritance diagram for regina::NSurfaceFilter:

regina::NPacket regina::NFilePropertyReader regina::ShareableObject regina::boost::noncopyable regina::NSurfaceFilterCombination regina::NSurfaceFilterProperties List of all members.

Public Member Functions

 NSurfaceFilter ()
 Creates a new default surface filter.
 NSurfaceFilter (const NSurfaceFilter &cloneMe)
 Creates a new default surface filter.
virtual ~NSurfaceFilter ()
 Destroys this surface filter.
virtual bool accept (const NNormalSurface &surface) const
 Decides whether or not the given normal surface is accepted by this filter.
virtual int getFilterID () const
 Returns the unique integer ID corresponding to the filtering method that is this particular subclass of NSurfaceFilter.
virtual std::string getFilterName () const
 Returns a string description of the filtering method that is this particular subclass of NSurfaceFilter.
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 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 NXMLFilterReadergetXMLFilterReader (NPacket *parent)
 Returns a newly created XML filter reader that will read the details of a particular type of surface filter.
static NSurfaceFilterreadFilter (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.
static NXMLPacketReadergetXMLReader (NPacket *parent)
 Returns a newly created XML element reader that will read the contents of a single XML packet element.
static NSurfaceFilterreadPacket (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 filterID
 Contains the integer ID for this type of surface filter.
static const int packetType
 Contains the integer ID for this packet.

Protected Member Functions

virtual void writeXMLFilterData (std::ostream &out) const
 Writes a chunk of XML containing the details of this filter.
virtual void writeFilter (NFile &out) const
 Writes the details of this filter to the given old-style binary file.
virtual void writeProperties (NFile &out) const
 Writes to the given old-style binary file any properties associated specifically with this particular subclass of NSurfaceFilter.
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.
virtual void readIndividualProperty (NFile &infile, unsigned propType)
 Reads an individual property from an old-style binary file.

Detailed Description

A packet that accepts or rejects normal surfaces.

Different subclasses of NSurfaceFilter represent different filtering methods.

When deriving classes from NSurfaceFilter:

Todo:
Feature: Implement property lastAppliedTo.


Constructor & Destructor Documentation

regina::NSurfaceFilter::NSurfaceFilter  )  [inline]
 

Creates a new default surface filter.

This will simply accept all normal surfaces.

regina::NSurfaceFilter::NSurfaceFilter const NSurfaceFilter cloneMe  )  [inline]
 

Creates a new default surface filter.

This will simply accept all normal surfaces. Note that the given parameter is ignored.

Parameters:
cloneMe this parameter is ignored.

regina::NSurfaceFilter::~NSurfaceFilter  )  [inline, virtual]
 

Destroys this surface filter.


Member Function Documentation

bool regina::NSurfaceFilter::accept const NNormalSurface surface  )  const [inline, virtual]
 

Decides whether or not the given normal surface is accepted by this filter.

The default implementation simply returns true.

Parameters:
surface the normal surface under investigation.
Returns:
true if and only if the given surface is accepted by this filter.

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

bool regina::NSurfaceFilter::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.

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

Implements regina::NPacket.

virtual int regina::NSurfaceFilter::getFilterID  )  const [virtual]
 

Returns the unique integer ID corresponding to the filtering method that is this particular subclass of NSurfaceFilter.

Returns:
the unique integer filtering method ID.

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

virtual std::string regina::NSurfaceFilter::getFilterName  )  const [virtual]
 

Returns a string description of the filtering method that is this particular subclass of NSurfaceFilter.

Returns:
a string description of this filtering method.

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

virtual int regina::NSurfaceFilter::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::NSurfaceFilter::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.

static NXMLFilterReader* regina::NSurfaceFilter::getXMLFilterReader NPacket parent  )  [static]
 

Returns a newly created XML filter reader that will read the details of a particular type of surface filter.

You may assume that the filter to be read is of the same type as the class in which you are implementing this routine.

The XML filter reader should read exactly what writeXMLFilterData() writes, and vice versa.

parent represents the packet which will become the new filter's parent in the tree structure. This information is for reference only, and need not be used. See the description of parameter parent in NPacket::getXMLReader() for further details.

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

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

static NXMLPacketReader* regina::NSurfaceFilter::getXMLReader NPacket parent  )  [static]
 

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:
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.
Returns:
the newly created XML element reader.

Reimplemented from regina::NPacket.

virtual NPacket* regina::NSurfaceFilter::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.

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

Implements regina::NPacket.

static NSurfaceFilter* regina::NSurfaceFilter::readFilter NFile in,
NPacket parent
[static]
 

Reads the details of a normal surface filter from the specified old-style binary file and returns a newly created filter containing that information.

You may assume that the filter is of the same class as the class in which you are implementing this routine. The newly created filter must also be of this type.

The general packet information and the filter ID may be assumed to have already been read from the file, and should not be reread. The readFilter() routine should read exactly what writeFilter() writes, and vice versa.

Properties should not be read from here; this will be done later by another routine.

parent represents the packet which will become the new filter's parent in the tree structure. This information is for reference only, and need not be used. See the description of parameter parent in NPacket::readPacket() for further details.

New filter types should make this routine simply return 0 since this file format is now obsolete, and older calculation engines will not understand newer filter types anyway.

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

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

virtual void regina::NSurfaceFilter::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).

Parameters:
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.

Reimplemented in regina::NSurfaceFilterProperties.

static NSurfaceFilter* regina::NSurfaceFilter::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:
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.
Returns:
the packet read from file, or 0 if an error occurred.

Reimplemented from regina::NPacket.

void regina::NSurfaceFilter::writeFilter NFile out  )  const [inline, protected, virtual]
 

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.

Deprecated:
For the preferred way to write data to file, see writeXMLFilterData() instead.
Precondition:
The given file is open for writing and satisfies the assumptions listed above.
Parameters:
out the file to be written to.

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

virtual void regina::NSurfaceFilter::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:
out the file to be written to.

Reimplemented from regina::NPacket.

virtual void regina::NSurfaceFilter::writeProperties NFile out  )  const [protected, virtual]
 

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.

Deprecated:
For the preferred way to write data to file, see writeXMLFilterData() instead.
Parameters:
out the file to be written to.

Reimplemented in regina::NSurfaceFilterProperties.

void regina::NSurfaceFilter::writeTextShort std::ostream &  out  )  const [inline, 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.

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

Implements regina::ShareableObject.

void regina::NSurfaceFilter::writeXMLFilterData std::ostream &  out  )  const [inline, protected, virtual]
 

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.

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

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

virtual void regina::NSurfaceFilter::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.

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

Implements regina::NPacket.


Member Data Documentation

const int regina::NSurfaceFilter::filterID [static]
 

Contains the integer ID for this type of surface filter.

Each distinct filtering class must have a unique ID, and this should be a non-negative integer. See filterregistry.h for further details.

This member must be declared for every filtering class that will be instantiated. A value need not be assigned; filterregistry.h will take care of this task when you register the filtering class.

Reimplemented in regina::NSurfaceFilterCombination, and regina::NSurfaceFilterProperties.

const int regina::NSurfaceFilter::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-2004, Ben Burton
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).