Regina Calculation Engine
Public Member Functions | Public Attributes
regina::NAngleStructureList::StructureInserter Struct Reference

An output iterator used to insert angle structures into an NAngleStructureList. More...

#include <angle/nanglestructurelist.h>

List of all members.

Public Member Functions

 StructureInserter ()
 Creates a new uninitialised output iterator.
 StructureInserter (NAngleStructureList &newList, NTriangulation *newOwner)
 Creates a new output iterator.
 StructureInserter (const StructureInserter &cloneMe)
 Creates a new output iterator that is a clone of the given iterator.
StructureInserteroperator= (const StructureInserter &cloneMe)
 Sets this iterator to be a clone of the given output iterator.
StructureInserteroperator= (NAngleStructure *structure)
 Appends an angle structure to the end of the appropriate structure list.
StructureInserteroperator= (NAngleStructureVector *vector)
 Appends the angle structure corresponding to the given vector to the end of the appropriate structure list.
StructureInserteroperator* ()
 Returns a reference to this output iterator.
StructureInserteroperator++ ()
 Returns a reference to this output iterator.
StructureInserteroperator++ (int)
 Returns a reference to this output iterator.

Public Attributes

NAngleStructureListlist
 The list into which angle structures will be inserted.
NTriangulationowner
 The triangulation on which the angle structures to be inserted lie.

Detailed Description

An output iterator used to insert angle structures into an NAngleStructureList.

Objects of type NAngleStructure* and NAngleStructureVector* can be assigned to this iterator. In the latter case, a surrounding NAngleStructure will be automatically created.


Constructor & Destructor Documentation

Creates a new uninitialised output iterator.

Warning:
This iterator must not be used until its structure list and triangulation have been initialised.

Creates a new output iterator.

The member variables of this iterator will be initialised according to the parameters passed to this constructor.

Parameters:
newListthe list into which angle structures will be inserted.
newOwnerthe triangulation on which the structures to be inserted lie.

Creates a new output iterator that is a clone of the given iterator.

Parameters:
cloneMethe output iterator to clone.

Member Function Documentation

NAngleStructureList::StructureInserter & regina::NAngleStructureList::StructureInserter::operator* ( ) [inline]

Returns a reference to this output iterator.

Returns:
this output iterator.
NAngleStructureList::StructureInserter & regina::NAngleStructureList::StructureInserter::operator++ ( ) [inline]

Returns a reference to this output iterator.

Returns:
this output iterator.
NAngleStructureList::StructureInserter & regina::NAngleStructureList::StructureInserter::operator++ ( int  ) [inline]

Returns a reference to this output iterator.

Returns:
this output iterator.
NAngleStructureList::StructureInserter & regina::NAngleStructureList::StructureInserter::operator= ( const StructureInserter cloneMe) [inline]

Sets this iterator to be a clone of the given output iterator.

Parameters:
cloneMethe output iterator to clone.
Returns:
this output iterator.
NAngleStructureList::StructureInserter & regina::NAngleStructureList::StructureInserter::operator= ( NAngleStructure structure) [inline]

Appends an angle structure to the end of the appropriate structure list.

The given angle structure will be deallocated with the other angle structures in this list when the list is eventually destroyed.

Parameters:
structurethe angle structure to insert.
Returns:
this output iterator.
NAngleStructureList::StructureInserter & regina::NAngleStructureList::StructureInserter::operator= ( NAngleStructureVector vector) [inline]

Appends the angle structure corresponding to the given vector to the end of the appropriate structure list.

The given vector will be owned by the newly created angle structure and will be deallocated with the other angle structures in this list when the list is eventually destroyed.

Parameters:
vectorthe vector of the angle structure to insert.
Returns:
this output iterator.

Member Data Documentation

The list into which angle structures will be inserted.

The triangulation on which the angle structures to be inserted lie.


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

Copyright © 1999-2011, 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).