CommonBinsValidator.h

#ifndef MANTID_API_COMMONBINSVALIDATOR_H_
#define MANTID_API_COMMONBINSVALIDATOR_H_

#include "MantidAPI/MatrixWorkspaceValidator.h"

namespace Mantid {
namespace API {

/**
  A validator which provides a <I>TENTATIVE</I> check that a workspace
  contains common bins in each spectrum.
  For efficiency reasons, it only checks that the first and last spectra have
  common bins, so it is important to carry out a full check within the
  algorithm itself.

  Copyright &copy; 2015 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
  National Laboratory & European Spallation Source

  This file is part of Mantid.

  Mantid is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.

  Mantid is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  File change history is stored at: <https://github.com/mantidproject/mantid>
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class MANTID_API_DLL CommonBinsValidator : public MatrixWorkspaceValidator {
public:
  /// Gets the type of the validator
  std::string getType() const { return "commonbins"; }
  /// Clone the current state
  Kernel::IValidator_sptr clone() const override;

private:
  /// Check for validity
  std::string checkValidity(const MatrixWorkspace_sptr &value) const override;
};

} // namespace API
} // namespace Mantid

#endif /* MANTID_API_COMMONBINSVALIDATOR_H_ */