OptionalBool.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/PropertyWithValue.h"
#include "MantidKernel/PropertyWithValueJSON.h"
 
#include <iosfwd>
#include <map>
#include <string>
 
namespace Json {
class Value;
}
 
namespace Mantid {
namespace Kernel {
 
class MANTID_KERNEL_DLL OptionalBool {
public:
  enum Value : unsigned char { False, True, Unset };
  static std::map<std::string, Value> strToEnumMap();
  static std::map<Value, std::string> enumToStrMap();
  const static std::string StrUnset;
  const static std::string StrFalse;
  const static std::string StrTrue;
 
public:
  OptionalBool();
  OptionalBool(bool arg);
  OptionalBool(Value arg);
  OptionalBool(std::string arg);
  OptionalBool(char const *arg);
  OptionalBool(const int arg);
  OptionalBool(const OptionalBool &other) = default;
  OptionalBool &operator=(const OptionalBool &other) = default;
  OptionalBool &operator=(std::string const &arg);
  OptionalBool &operator=(char const *arg);
  OptionalBool &operator=(const int arg);
  bool operator==(const OptionalBool &other) const;
  bool operator!=(const OptionalBool &other) const;
  Value getValue() const;
  Value Validate(const std::string &arg);
  virtual ~OptionalBool() = default;
 
private:
  friend MANTID_KERNEL_DLL std::ostream &operator<<(std::ostream &os, OptionalBool const &object);
  friend MANTID_KERNEL_DLL std::istream &operator>>(std::istream &istream, OptionalBool &object);
 
  Value m_arg;
};
 
MANTID_KERNEL_DLL std::ostream &operator<<(std::ostream &os, OptionalBool const &object);
 
MANTID_KERNEL_DLL std::istream &operator>>(std::istream &istream, OptionalBool &object);
 
MANTID_KERNEL_DLL ::Json::Value encodeAsJson(const OptionalBool &);
 
namespace pwvjdetail {
 
template <> struct ToCpp<OptionalBool> {
  bool operator()(const Json::Value &value);
};
 
} // namespace pwvjdetail
 
// Instantiated and exported by PropertyWithValue.cpp
MANTID_KERNEL_EXTERN_TEMPLATE(PropertyWithValue<OptionalBool>);
MANTID_KERNEL_EXTERN_TEMPLATE(PropertyWithValue<std::vector<OptionalBool>>);
 
} // namespace Kernel
} // namespace Mantid