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

Verify that a workspace has valid sample shape. More...

#include <SampleShapeValidator.h>

Inheritance diagram for Mantid::API::SampleShapeValidator:

Public Member Functions

Kernel::IValidator_sptr clone () const override
 
std::string getType () const
 

Private Member Functions

std::string checkValidity (const std::shared_ptr< ExperimentInfo > &value) const override
 Checks that the workspace has a valid sample shape defined. More...
 

Detailed Description

Verify that a workspace has valid sample shape.

Definition at line 20 of file SampleShapeValidator.h.

Member Function Documentation

◆ checkValidity()

std::string Mantid::API::SampleShapeValidator::checkValidity ( const std::shared_ptr< ExperimentInfo > &  value) const
overrideprivate

Checks that the workspace has a valid sample shape defined.

Parameters
value:: The workspace to test
Returns
A user level description if a problem exists or ""

Definition at line 24 of file SampleShapeValidator.cpp.

References value.

◆ clone()

Kernel::IValidator_sptr Mantid::API::SampleShapeValidator::clone ( ) const
override
Returns
A copy of the validator as a new object

Definition at line 17 of file SampleShapeValidator.cpp.

◆ getType()

std::string Mantid::API::SampleShapeValidator::getType ( ) const
Returns
A string identifier for the type of validator

Definition at line 14 of file SampleShapeValidator.cpp.


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