Skip to content
Snippets Groups Projects
DirectoryValidator.h 1.9 KiB
Newer Older
#ifndef MANTID_KERNEL_DirectoryValidator_H_
#define MANTID_KERNEL_DirectoryValidator_H_

//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "IValidator.h"
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/FileValidator.h"
#include <string>
#include <vector>

namespace Mantid {
namespace Kernel {
/** DirectoryValidator is a validator that checks that a directory path is
   valid.

    @author Janik Zikovsky, SNS
    @date Nov 12, 2010

    Copyright &copy; 2008-9 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_KERNEL_DLL DirectoryValidator : public FileValidator {
public:
  explicit DirectoryValidator(bool testDirectoryExists = true);
  std::vector<std::string> allowedValues() const override;
  IValidator_sptr clone() const override;
  std::string checkValidity(const std::string &value) const override;
};

} // namespace Kernel
} // namespace Mantid

#endif /*MANTID_KERNEL_DirectoryValidator_H_*/