Mantid::Geometry::GeneralFrame Class Reference

GeneralFrame : Any MDFrame that isn't related to momemtum transfer. More...

#include <GeneralFrame.h>

Inheritance diagram for Mantid::Geometry::GeneralFrame:

Public Member Functions
bool	canConvertTo (const Kernel::MDUnit &otherUnit) const override
GeneralFrame *	clone () const override
Mantid::Kernel::SpecialCoordinateSystem	equivalientSpecialCoordinateSystem () const override
	GeneralFrame (std::string frameName, const Kernel::UnitLabel &unit)
	GeneralFrame (std::string frameName, std::unique_ptr< Mantid::Kernel::MDUnit > unit)
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
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	GeneralFrameDistance = "Distance"
static const std::string	GeneralFrameName = "General Frame"
static const std::string	GeneralFrameTOF = "Time of Flight"

Private Attributes
const std::string	m_frameName
	Frame name. More...
std::unique_ptr< Mantid::Kernel::MDUnit >	m_unit
	Label unit. More...

Detailed Description

GeneralFrame : Any MDFrame that isn't related to momemtum transfer.

Definition at line 21 of file GeneralFrame.h.

Constructor & Destructor Documentation

GeneralFrame() [1/2]

Mantid::Geometry::GeneralFrame::GeneralFrame	(	std::string	frameName,
		const Kernel::UnitLabel &	unit
	)

Definition at line 20 of file GeneralFrame.cpp.

GeneralFrame() [2/2]

Mantid::Geometry::GeneralFrame::GeneralFrame	(	std::string	frameName,
		std::unique_ptr< Mantid::Kernel::MDUnit >	unit
	)

Definition at line 17 of file GeneralFrame.cpp.

Member Function Documentation

canConvertTo()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 32 of file GeneralFrame.cpp.

References m_unit.

clone()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 36 of file GeneralFrame.cpp.

References m_frameName, and m_unit.

equivalientSpecialCoordinateSystem()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 40 of file GeneralFrame.cpp.

References Mantid::Kernel::None.

getMDUnit()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 25 of file GeneralFrame.cpp.

References m_unit.

getUnitLabel()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 23 of file GeneralFrame.cpp.

References m_unit.

isQ()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 44 of file GeneralFrame.cpp.

isSameType()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 46 of file GeneralFrame.cpp.

References isSameType(), tmp, and UNUSED_ARG.

Referenced by isSameType().

name()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 34 of file GeneralFrame.cpp.

References m_frameName.

setMDUnit()

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

overridevirtual

Implements Mantid::Geometry::MDFrame.

Definition at line 27 of file GeneralFrame.cpp.

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

Member Data Documentation

GeneralFrameDistance

const std::string Mantid::Geometry::GeneralFrame::GeneralFrameDistance = "Distance"

static

Definition at line 23 of file GeneralFrame.h.

Referenced by Mantid::MDAlgorithms::ConvertSpiceDataToRealSpace::createDataMDWorkspace(), Mantid::MDAlgorithms::ConvertSpiceDataToRealSpace::createMonitorMDWorkspace(), Mantid::DataObjects::MDEventsTestHelper::makeFakeMDHistoWorkspace(), and Mantid::DataObjects::MDEventsTestHelper::makeFakeMDHistoWorkspaceGeneral().

GeneralFrameName

const std::string Mantid::Geometry::GeneralFrame::GeneralFrameName = "General Frame"

static

Definition at line 25 of file GeneralFrame.h.

Referenced by Mantid::MDAlgorithms::ImportMDHistoWorkspaceBase::createEmptyOutputWorkspace(), Mantid::MDAlgorithms::SetMDFrame::createMDFrame(), Mantid::MDAlgorithms::ConvertToDetectorFaceMD::exec(), Mantid::MDAlgorithms::CreateMDWorkspace::exec(), Mantid::MDAlgorithms::ImportMDEventWorkspace::exec(), Mantid::MDAlgorithms::SetMDFrame::init(), Mantid::MDAlgorithms::LoadMD::setMDFrameOnWorkspaceFromLegacyFile(), Mantid::MDAlgorithms::CreateMDWorkspace::validateInputs(), and Mantid::MDAlgorithms::ImportMDHistoWorkspaceBase::validateInputs().

GeneralFrameTOF

const std::string Mantid::Geometry::GeneralFrame::GeneralFrameTOF = "Time of Flight"

static

Definition at line 24 of file GeneralFrame.h.

m_frameName

const std::string Mantid::Geometry::GeneralFrame::m_frameName

private

Frame name.

Definition at line 42 of file GeneralFrame.h.

Referenced by clone(), and name().

m_unit

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

private

Label unit.

Definition at line 40 of file GeneralFrame.h.

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

---

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

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