Mantid::Geometry::SymmetryElementWithAxis Class Reference

SymmetryElementWithAxis does not represent any symmetry element directly. More...

#include <SymmetryElement.h>

Inheritance diagram for Mantid::Geometry::SymmetryElementWithAxis:

Public Member Functions
V3R	getAxis () const
	Returns the internally stored axis. More...
V3R	getTranslation () const
	Returns the internally stored translation vector. More...
Public Member Functions inherited from Mantid::Geometry::SymmetryElement
virtual std::shared_ptr< SymmetryElement >	clone () const =0
std::string	hmSymbol () const
	Returns the internally stored Hermann-Mauguin symbol. More...
virtual	~SymmetryElement ()=default

Protected Member Functions
void	setAxis (const V3R &axis)
	Sets the axis, throws std::invalid_argument if the axis is (0,0,0). More...
	SymmetryElementWithAxis (const std::string &symbol, const V3R &axis, const V3R &translation)
	Constructor for SymmetryElementWithAxis. More...
Protected Member Functions inherited from Mantid::Geometry::SymmetryElement
	SymmetryElement (std::string symbol)
	Constructor with symbol argument. More...

Protected Attributes
V3R	m_axis
V3R	m_translation
Protected Attributes inherited from Mantid::Geometry::SymmetryElement
std::string	m_hmSymbol

Detailed Description

SymmetryElementWithAxis does not represent any symmetry element directly.

It serves as a base class for rotation-axes and mirror-planes, as both are described by an axis and may have a translation component (screws and glides). The axis-vector can not be (0,0,0).

Definition at line 118 of file SymmetryElement.h.

Constructor & Destructor Documentation

SymmetryElementWithAxis()

Mantid::Geometry::SymmetryElementWithAxis::SymmetryElementWithAxis ( const std::string &  symbol, const V3R &  axis, const V3R &  translation  )

protected

Constructor for SymmetryElementWithAxis.

Definition at line 34 of file SymmetryElement.cpp.

References setAxis().

Member Function Documentation

getAxis()

V3R Mantid::Geometry::SymmetryElementWithAxis::getAxis ( ) const

inline

Returns the internally stored axis.

Definition at line 121 of file SymmetryElement.h.

getTranslation()

V3R Mantid::Geometry::SymmetryElementWithAxis::getTranslation ( ) const

inline

Returns the internally stored translation vector.

Definition at line 124 of file SymmetryElement.h.

setAxis()

void Mantid::Geometry::SymmetryElementWithAxis::setAxis ( const V3R &  axis )

protected

Sets the axis, throws std::invalid_argument if the axis is (0,0,0).

Definition at line 40 of file SymmetryElement.cpp.

References m_axis.

Referenced by SymmetryElementWithAxis().

Member Data Documentation

m_axis

V3R Mantid::Geometry::SymmetryElementWithAxis::m_axis

protected

Definition at line 131 of file SymmetryElement.h.

Referenced by Mantid::Geometry::SymmetryElementRotation::clone(), Mantid::Geometry::SymmetryElementMirror::clone(), and setAxis().

m_translation

V3R Mantid::Geometry::SymmetryElementWithAxis::m_translation

protected

Definition at line 132 of file SymmetryElement.h.

Referenced by Mantid::Geometry::SymmetryElementRotation::clone(), and Mantid::Geometry::SymmetryElementMirror::clone().

---

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

• Framework/Geometry/inc/MantidGeometry/Crystal/SymmetryElement.h
• Framework/Geometry/src/Crystal/SymmetryElement.cpp