Mantid
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Mantid::Geometry::SymmetryElement Class Referenceabstract

SymmetryElement is an interface for representing symmetry elements that occur for example in space and point groups. More...

#include <SymmetryElement.h>

Inheritance diagram for Mantid::Geometry::SymmetryElement:
Mantid::Geometry::SymmetryElementIdentity Mantid::Geometry::SymmetryElementInversion Mantid::Geometry::SymmetryElementTranslation Mantid::Geometry::SymmetryElementWithAxis Mantid::Geometry::SymmetryElementMirror Mantid::Geometry::SymmetryElementRotation

Public Member Functions

virtual std::shared_ptr< SymmetryElementclone () const =0
 
std::string hmSymbol () const
 Returns the internally stored Hermann-Mauguin symbol. More...
 
virtual ~SymmetryElement ()=default
 

Protected Member Functions

 SymmetryElement (std::string symbol)
 Constructor with symbol argument. More...
 

Protected Attributes

std::string m_hmSymbol
 

Detailed Description

SymmetryElement is an interface for representing symmetry elements that occur for example in space and point groups.

The base class itself can not be used, it only defines a (very small) interface that currently only contains the Hermann-Mauguin symbol of the element, as that is the one common factor for all symmetry elements. There are however classes for identity, translation, inversion, rotation and mirror.

However, these classes should not be instantiated directly, they are merely storing the information on a symmetry element. Instead, they should be generated through SymmetryElementFactory, which generates the elements from SymmetryOperation-objects. Please see the documentation of SymmetryElementFactory for details and examples.

Author
Michael Wedel, Paul Scherrer Institut - SINQ
Date
05/02/2015

Definition at line 38 of file SymmetryElement.h.

Constructor & Destructor Documentation

◆ ~SymmetryElement()

virtual Mantid::Geometry::SymmetryElement::~SymmetryElement ( )
virtualdefault

◆ SymmetryElement()

Mantid::Geometry::SymmetryElement::SymmetryElement ( std::string  symbol)
protected

Constructor with symbol argument.

Definition at line 17 of file SymmetryElement.cpp.

Member Function Documentation

◆ clone()

virtual std::shared_ptr< SymmetryElement > Mantid::Geometry::SymmetryElement::clone ( ) const
pure virtual

◆ hmSymbol()

std::string Mantid::Geometry::SymmetryElement::hmSymbol ( ) const
inline

Returns the internally stored Hermann-Mauguin symbol.

Definition at line 45 of file SymmetryElement.h.

Referenced by export_SymmetryElement().

Member Data Documentation

◆ m_hmSymbol

std::string Mantid::Geometry::SymmetryElement::m_hmSymbol
protected

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