Regina Calculation Engine
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
regina::detail::BoundaryComponentBase< dim > Class Template Reference

Helper class that provides core functionality for a boundary component of a dim-dimensional triangulation. More...

#include <triangulation/detail/boundarycomponent.h>

Inheritance diagram for regina::detail::BoundaryComponentBase< dim >:
regina::Output< BoundaryComponentBase< dim > > regina::MarkedElement regina::BoundaryComponent< dim >

Public Member Functions

size_t index () const
 Returns the index of this boundary component in the underlying triangulation. More...
 
bool isOrientable () const
 Determines if this boundary component is orientable. More...
 
 BoundaryComponentBase (const BoundaryComponentBase &)=delete
 
BoundaryComponentBaseoperator= (const BoundaryComponentBase &)=delete
 
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...
 
size_t markedIndex () const
 Returns the index at which this object is stored in an MarkedVector. More...
 

Protected Member Functions

 BoundaryComponentBase ()=default
 Default constructor that leaves orientability uninitialised. More...
 

Protected Attributes

bool orientable_
 Is this boundary component orientable? More...
 

Friends

class Triangulation< dim >
 Allow access to private members. More...
 

Detailed Description

template<int dim>
class regina::detail::BoundaryComponentBase< dim >

Helper class that provides core functionality for a boundary component of a dim-dimensional triangulation.

Each boundary component is represented by the class BoundaryComponent<dim>, which uses this as a base class. End users should not need to refer to BoundaryComponentBase directly.

See the BoundaryComponent class notes for further information.

Python
This base class is not present, but the "end user" class BoundaryComponent<dim> is.
Template Parameters
dimthe dimension of the underlying triangulation. This must be between 2 and 15 inclusive.

Member Function Documentation

◆ detail()

std::string regina::Output< BoundaryComponentBase< dim > , false >::detail ( ) const
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.

Returns
a detailed text representation of this object.

◆ str()

std::string regina::Output< BoundaryComponentBase< dim > , false >::str ( ) const
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.

Python
In addition to str(), this is also used as the Python "stringification" function str().
Returns
a short text representation of this object.

◆ utf8()

std::string regina::Output< BoundaryComponentBase< dim > , false >::utf8 ( ) const
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.

Returns
a short text representation of this object.

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

Copyright © 1999-2021, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).