Mantid::Geometry::QSample Class Reference

QSample : Q in the sample frame. More...

#include <QSample.h>

Inheritance diagram for Mantid::Geometry::QSample:

Public Member Functions
bool	canConvertTo (const Kernel::MDUnit &otherUnit) const override
QSample *	clone () const override
Mantid::Kernel::SpecialCoordinateSystem	equivalientSpecialCoordinateSystem () const override
const Kernel::MDUnit &	getMDUnit () const override
Kernel::UnitLabel	getUnitLabel () const override
bool	isQ () const override
bool	isSameType (const MDFrame &frame) const override
std::string	name () const override
	QSample ()
	Constructor. More...
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	QSampleName = "QSample"

Private Attributes
const std::unique_ptr< const Mantid::Kernel::InverseAngstromsUnit >	m_unit
	immutable unit for qlab. More...

Detailed Description

QSample : Q in the sample frame.

Definition at line 21 of file QSample.h.

Constructor & Destructor Documentation

QSample()

Mantid::Geometry::QSample::QSample

(

)

Constructor.

Definition at line 17 of file QSample.cpp.

Referenced by clone().

Member Function Documentation

canConvertTo()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 25 of file QSample.cpp.

References getMDUnit().

clone()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 29 of file QSample.cpp.

References QSample().

equivalientSpecialCoordinateSystem()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 31 of file QSample.cpp.

References Mantid::Kernel::QSample.

getMDUnit()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 21 of file QSample.cpp.

References m_unit.

Referenced by canConvertTo().

getUnitLabel()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 19 of file QSample.cpp.

References m_unit.

isQ()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 35 of file QSample.cpp.

isSameType()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 37 of file QSample.cpp.

References isSameType(), tmp, and UNUSED_ARG.

Referenced by isSameType().

name()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 27 of file QSample.cpp.

References QSampleName.

setMDUnit()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 23 of file QSample.cpp.

Member Data Documentation

m_unit

const std::unique_ptr<const Mantid::Kernel::InverseAngstromsUnit> Mantid::Geometry::QSample::m_unit

private

immutable unit for qlab.

Definition at line 37 of file QSample.h.

Referenced by getMDUnit(), and getUnitLabel().

QSampleName

const std::string Mantid::Geometry::QSample::QSampleName = "QSample"

static

Definition at line 23 of file QSample.h.

Referenced by Mantid::Geometry::QSampleFrameFactory::canInterpret(), Mantid::MDAlgorithms::SetMDFrame::createMDFrame(), Mantid::MDAlgorithms::ConvertToDiffractionMDWorkspace::exec(), Mantid::MDAlgorithms::SetMDFrame::init(), name(), Mantid::MDAlgorithms::LoadMD::setMDFrameOnWorkspaceFromLegacyFile(), Mantid::MDAlgorithms::MDWSTransform::setQ3DDimensionsNames(), Mantid::MDAlgorithms::CreateMDWorkspace::validateInputs(), Mantid::MDAlgorithms::ImportMDHistoWorkspaceBase::validateInputs(), Mantid::MDAlgorithms::MDNorm::validateInputs(), and Mantid::MDAlgorithms::RecalculateTrajectoriesExtents::validateInputs().

---

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

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