Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | List of all members
Mantid::DataObjects::MDFramesToSpecialCoordinateSystem Class Reference

MDFrameFromMDWorkspace: Each dimension of the MDWorkspace contains an MDFrame. More...

#include <MDFramesToSpecialCoordinateSystem.h>

Public Member Functions

boost::optional< Mantid::Kernel::SpecialCoordinateSystemoperator() (const Mantid::API::IMDWorkspace *workspace) const
 Get the Special Coordinate System based on the MDFrame information. More...
 

Private Member Functions

void checkQCompatibility (Mantid::Kernel::SpecialCoordinateSystem specialCoordinateSystem, boost::optional< Mantid::Kernel::SpecialCoordinateSystem > qFrameType) const
 Make sure that the QFrame types are the same. More...
 
bool isUnknownFrame (const Mantid::Geometry::IMDDimension_const_sptr &dimension) const
 

Detailed Description

MDFrameFromMDWorkspace: Each dimension of the MDWorkspace contains an MDFrame.

The acutal frame which is common to all dimensions is extracted.

Definition at line 20 of file MDFramesToSpecialCoordinateSystem.h.

Member Function Documentation

◆ checkQCompatibility()

void Mantid::DataObjects::MDFramesToSpecialCoordinateSystem::checkQCompatibility ( Mantid::Kernel::SpecialCoordinateSystem  specialCoordinateSystem,
boost::optional< Mantid::Kernel::SpecialCoordinateSystem qFrameType 
) const
private

Make sure that the QFrame types are the same.

Parameters
specialCoordinateSystemthe q frame type to test.
qFrameTypethe current q frame type

Definition at line 76 of file MDFramesToSpecialCoordinateSystem.cpp.

Referenced by operator()().

◆ isUnknownFrame()

bool Mantid::DataObjects::MDFramesToSpecialCoordinateSystem::isUnknownFrame ( const Mantid::Geometry::IMDDimension_const_sptr dimension) const
private

Definition at line 92 of file MDFramesToSpecialCoordinateSystem.cpp.

Referenced by operator()().

◆ operator()()

boost::optional< Mantid::Kernel::SpecialCoordinateSystem > Mantid::DataObjects::MDFramesToSpecialCoordinateSystem::operator() ( const Mantid::API::IMDWorkspace workspace) const

Get the Special Coordinate System based on the MDFrame information.

Parameters
workspacethe workspace which is being queried
Returns
either a special coordinate or an empty optional

Definition at line 20 of file MDFramesToSpecialCoordinateSystem.cpp.

References checkQCompatibility(), isUnknownFrame(), Mantid::Kernel::None, and workspace.


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