ArrayBoundedValidator.h

#ifndef MANTID_KERNEL_ARRAYBOUNDEDVALIDATOR_H_
#define MANTID_KERNEL_ARRAYBOUNDEDVALIDATOR_H_

#include "MantidKernel/DllConfig.h"
#include "MantidKernel/IValidator.h"
#include "MantidKernel/TypedValidator.h"
#include "MantidKernel/BoundedValidator.h"
#include <string>
#include <vector>

namespace Mantid {
namespace Kernel {
/** @class ArrayBoundedValidator ArrayBoundedValidator.h
   Kernel/ArrayBoundedValidator.h

    ArrayBoundedValidator is a validator that requires all values in an array
    to be between upper or lower bounds, or both.

    @author Michael Reuter, NScD Oak Ridge National Laboratory
    @date 09/11/2010

    Copyright &copy; 2007-10 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>
*/
template <typename TYPE>
class MANTID_KERNEL_DLL ArrayBoundedValidator
    : public TypedValidator<std::vector<TYPE>> {
public:
  ArrayBoundedValidator();
  ArrayBoundedValidator(const ArrayBoundedValidator<TYPE> &abv);
  ArrayBoundedValidator(const TYPE lowerBound, const TYPE upperBound);
  ArrayBoundedValidator(BoundedValidator<TYPE> &bv);
  ~ArrayBoundedValidator() override;
  /// Clone the current state
  IValidator_sptr clone() const override;
  /// Return the object that checks the bounds
  boost::shared_ptr<BoundedValidator<TYPE>> getValidator() const;

  /// Return if it has a lower bound
  bool hasLower() const;
  /// Return if it has a lower bound
  bool hasUpper() const;
  /// Return the lower bound value
  const TYPE &lower() const;
  /// Return the upper bound value
  const TYPE &upper() const;

  /// Set lower bound value
  void setLower(const TYPE &value);
  /// Set upper bound value
  void setUpper(const TYPE &value);
  /// Clear lower bound value
  void clearLower();
  /// Clear upper bound value
  void clearUpper();

private:
  std::string checkValidity(const std::vector<TYPE> &value) const override;

  /// The object used to do the actual validation
  boost::shared_ptr<BoundedValidator<TYPE>> boundVal;
};

} // Kernel
} // Mantid

#endif /* MANTID_KERNEL_ARRAYBOUNDEDVALIDATOR_H_ */