#include <MDFrameValidator.h>

Inheritance diagram for Mantid::API::MDFrameValidator:

Public Member Functions
Kernel::IValidator_sptr	clone () const override
	Clone the current state. More...

std::string	getType () const
	Gets the type of the validator. More...

	MDFrameValidator (std::string frameName)
	Constructor. More...

Private Member Functions
std::string	checkValidity (const IMDWorkspace_sptr &workspace) const override
	Check for validity. More...

Private Attributes
const std::string	m_frameID
	The name of the required frame. More...

Detailed Description

Definition at line 19 of file MDFrameValidator.h.

Constructor & Destructor Documentation

◆ MDFrameValidator()

Mantid::API::MDFrameValidator::MDFrameValidator ( std::string frameName )

explicit

Constructor.

Parameters

frameName :: The name of the frame that the workspace must have.

Definition at line 20 of file MDFrameValidator.cpp.

Member Function Documentation

◆ checkValidity()

std::string Mantid::API::MDFrameValidator::checkValidity ( const IMDWorkspace_sptr & workspace ) const

overrideprivate

Check for validity.

Checks that the frame of the MDWorkspace matches the expected frame.

Parameters

workspace :: The workspace to test

Returns: A user level description of the error or "" for no error

Definition at line 32 of file MDFrameValidator.cpp.

References index, m_frameID, and workspace.

◆ clone()

Kernel::IValidator_sptr Mantid::API::MDFrameValidator::clone ( ) const

override

Clone the current state.

Definition at line 25 of file MDFrameValidator.cpp.

◆ getType()

std::string Mantid::API::MDFrameValidator::getType ( ) const

inline

Gets the type of the validator.

Definition at line 23 of file MDFrameValidator.h.

Member Data Documentation

◆ m_frameID

const std::string Mantid::API::MDFrameValidator::m_frameID

private

The name of the required frame.

Definition at line 32 of file MDFrameValidator.h.

Referenced by checkValidity().

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

Framework/API/inc/MantidAPI/MDFrameValidator.h
Framework/API/src/MDFrameValidator.cpp

Public Member Functions

Private Member Functions

Private Attributes