Mantid::Geometry::HKL Class Reference

HKL : HKL MDFrame. More...

#include <HKL.h>

Inheritance diagram for Mantid::Geometry::HKL:

Public Member Functions
bool	canConvertTo (const Kernel::MDUnit &otherUnit) const override
HKL *	clone () const override
Mantid::Kernel::SpecialCoordinateSystem	equivalientSpecialCoordinateSystem () const override
const Kernel::MDUnit &	getMDUnit () const override
Kernel::UnitLabel	getUnitLabel () const override
	HKL (const HKL &other)
	Assignment. More...
	HKL (Kernel::MDUnit *unit)
	Constructor. More...
	HKL (std::unique_ptr< Kernel::MDUnit > &unit)
	Constructor. More...
bool	isQ () const override
bool	isSameType (const MDFrame &frame) const override
std::string	name () const override
HKL &	operator= (const HKL &other)
bool	setMDUnit (const Mantid::Kernel::MDUnit &newUnit) override
Public Member Functions inherited from Mantid::Geometry::MDFrame
virtual bool	canConvertTo (const Mantid::Kernel::MDUnit &otherUnit) const =0
virtual MDFrame *	clone () const =0
virtual Mantid::Kernel::SpecialCoordinateSystem	equivalientSpecialCoordinateSystem () const =0
virtual const Mantid::Kernel::MDUnit &	getMDUnit () const =0
virtual Mantid::Kernel::UnitLabel	getUnitLabel () const =0
virtual bool	isQ () const =0
virtual bool	isSameType (const MDFrame &frame) const =0
virtual std::string	name () const =0
virtual bool	setMDUnit (const Mantid::Kernel::MDUnit &newUnit)=0
virtual	~MDFrame ()=default

Static Public Attributes
static const std::string	HKLName = "HKL"

Private Attributes
std::unique_ptr< Kernel::MDUnit >	m_unit

Detailed Description

HKL : HKL MDFrame.

Definition at line 21 of file HKL.h.

Constructor & Destructor Documentation

HKL() [1/3]

Mantid::Geometry::HKL::HKL

(

const HKL &

other

)

Assignment.

Parameters

other

: Other unit

Returns

assigned unit.

Definition at line 45 of file HKL.cpp.

HKL() [2/3]

Mantid::Geometry::HKL::HKL

(

std::unique_ptr< Kernel::MDUnit > &

unit

)

Constructor.

Parameters

unit	: Unit to use

Definition at line 27 of file HKL.cpp.

References m_unit.

HKL() [3/3]

Mantid::Geometry::HKL::HKL

(

Kernel::MDUnit *

unit

)

Constructor.

Parameters

unit	: Unit to use

Definition at line 38 of file HKL.cpp.

Member Function Documentation

canConvertTo()

bool Mantid::Geometry::HKL::canConvertTo ( const Kernel::MDUnit &  otherUnit ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 63 of file HKL.cpp.

References m_unit.

clone()

HKL * Mantid::Geometry::HKL::clone ( ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 67 of file HKL.cpp.

References m_unit.

equivalientSpecialCoordinateSystem()

Mantid::Kernel::SpecialCoordinateSystem Mantid::Geometry::HKL::equivalientSpecialCoordinateSystem ( ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 69 of file HKL.cpp.

References Mantid::Kernel::HKL.

getMDUnit()

const Kernel::MDUnit & Mantid::Geometry::HKL::getMDUnit ( ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 56 of file HKL.cpp.

References m_unit.

getUnitLabel()

Kernel::UnitLabel Mantid::Geometry::HKL::getUnitLabel ( ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 54 of file HKL.cpp.

References m_unit.

isQ()

bool Mantid::Geometry::HKL::isQ ( ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 73 of file HKL.cpp.

isSameType()

bool Mantid::Geometry::HKL::isSameType ( const MDFrame &  frame ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 75 of file HKL.cpp.

References isSameType(), tmp, and UNUSED_ARG.

Referenced by isSameType().

name()

std::string Mantid::Geometry::HKL::name ( ) const

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 65 of file HKL.cpp.

References HKLName.

operator=()

HKL & Mantid::Geometry::HKL::operator=

(

const HKL &

other

)

Definition at line 47 of file HKL.cpp.

References m_unit.

setMDUnit()

bool Mantid::Geometry::HKL::setMDUnit ( const Mantid::Kernel::MDUnit &  newUnit )

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 58 of file HKL.cpp.

References Mantid::Kernel::MDUnit::clone(), and m_unit.

Member Data Documentation

HKLName

const std::string Mantid::Geometry::HKL::HKLName = "HKL"

static

Definition at line 27 of file HKL.h.

Referenced by Mantid::Geometry::HKLFrameFactory::canInterpret(), Mantid::MDAlgorithms::SetMDFrame::createMDFrame(), Mantid::MDAlgorithms::ConvertToDiffractionMDWorkspace::exec(), MantidQt::API::getMissingHKLDimensionIndex(), Mantid::MDAlgorithms::SetMDFrame::init(), MantidQt::API::isHKLDimensions(), name(), Mantid::MDAlgorithms::LoadMD::setMDFrameOnWorkspaceFromLegacyFile(), Mantid::MDAlgorithms::MDWSTransform::setQ3DDimensionsNames(), Mantid::MDAlgorithms::MDNorm::setQUnit(), Mantid::MDAlgorithms::CreateMDWorkspace::validateInputs(), and Mantid::MDAlgorithms::ImportMDHistoWorkspaceBase::validateInputs().

m_unit

std::unique_ptr<Kernel::MDUnit> Mantid::Geometry::HKL::m_unit

private

Definition at line 41 of file HKL.h.

Referenced by canConvertTo(), clone(), getMDUnit(), getUnitLabel(), HKL(), operator=(), and setMDUnit().

---

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

• Framework/Geometry/inc/MantidGeometry/MDGeometry/HKL.h
• Framework/Geometry/src/MDGeometry/HKL.cpp