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

regina::NVertexEmbedding Class Reference
[Triangulations]

Details how a vertex in the skeleton forms part of an individual tetrahedron. More...

#include <nvertex.h>

List of all members.

Public Member Functions

 NVertexEmbedding ()
 Default constructor.
 NVertexEmbedding (NTetrahedron *newTet, int newVertex)
 Creates an embedding descriptor containing the given data.
 NVertexEmbedding (const NVertexEmbedding &cloneMe)
 Creates an embedding descriptor containing the same data as the given embedding descriptor.
NVertexEmbedding & operator= (const NVertexEmbedding &cloneMe)
 Assigns to this embedding descriptor the same data as is contained in the given embedding descriptor.
NTetrahedron * getTetrahedron () const
 Returns the tetrahedron in which this vertex is contained.
int getVertex () const
 Returns the vertex number within getTetrahedron() that is this vertex.

Detailed Description

Details how a vertex in the skeleton forms part of an individual tetrahedron.

Constructor & Destructor Documentation

regina::NVertexEmbedding::NVertexEmbedding (   )  [inline]
 

Default constructor.

The embedding descriptor created is unusable until it has some data assigned to it using operator =.

Python:
Not present.

regina::NVertexEmbedding::NVertexEmbedding (  NTetrahedron *  newTet,
int  newVertex
)  [inline]
 

Creates an embedding descriptor containing the given data.

Parameters:
newTet the tetrahedron in which this vertex is contained.
newVertex the vertex number of newTet that is this vertex.

regina::NVertexEmbedding::NVertexEmbedding (  const NVertexEmbedding &  cloneMe  )  [inline]
 

Creates an embedding descriptor containing the same data as the given embedding descriptor.

Parameters:
cloneMe the embedding descriptor to clone.

Member Function Documentation

NTetrahedron * regina::NVertexEmbedding::getTetrahedron (   )  const [inline]
 

Returns the tetrahedron in which this vertex is contained.

Returns:
the tetrahedron.

int regina::NVertexEmbedding::getVertex (   )  const [inline]
 

Returns the vertex number within getTetrahedron() that is this vertex.

Returns:
the vertex number that is this vertex.

NVertexEmbedding & regina::NVertexEmbedding::operator= (  const NVertexEmbedding &  cloneMe  )  [inline]
 

Assigns to this embedding descriptor the same data as is contained in the given embedding descriptor.

Parameters:
cloneMe the embedding descriptor to clone.

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).