Capability.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include <optional>
#include <set>
#include <string>
#include <variant>

#ifdef MOOSE_UNIT_TEST
// forward declare unit tests
#include "gtest/gtest.h"
class GTEST_TEST_CLASS_NAME_(CapabilityTest, negateValue);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, isInstallationType);
#endif

namespace Moose
{
class Capability
{
public:
  using Value = std::variant<bool, int, std::string>;

  Capability() = delete;
  Capability(const std::string_view name,
             const Capability::Value & value,
             const std::string_view doc);

  const std::string & getName() const { return _name; }

  const std::string & getDoc() const { return _doc; }

  const Capability::Value & getValue() const { return _value; }

  bool getExplicit() const { return _explicit; }

  const std::optional<std::set<std::string>> & queryEnumeration() const { return _enumeration; }

  const std::set<std::string> & getEnumeration() const;

  bool hasEnumeration(const std::string & value) const;

  Capability & setExplicit();

  Capability & setEnumeration(const std::set<std::string> & enumeration);

#if defined(MOOSE_UNIT_TEST) || defined(FOR_PYCAPABILITIES)

  inline void negateValue();
#endif

  const bool * queryBoolValue() const { return std::get_if<bool>(&_value); }
  const int * queryIntValue() const { return std::get_if<int>(&_value); }
  const std::string * queryStringValue() const { return std::get_if<std::string>(&_value); }

  bool hasBoolValue() const { return std::holds_alternative<bool>(_value); }

  bool hasIntValue() const { return std::holds_alternative<int>(_value); }

  bool hasStringValue() const { return std::holds_alternative<std::string>(_value); }

  bool getBoolValue() const;
  int getIntValue() const;
  const std::string & getStringValue() const;

  std::string valueToString() const;

  std::string toString() const;

  std::string enumerationToString() const;

private:
#ifdef MOOSE_UNIT_TEST
  FRIEND_TEST(::CapabilityTest, negateValue);
  FRIEND_TEST(::CapabilitiesTest, isInstallationType);
#endif

  std::string _name;
  std::string _doc;
  Capability::Value _value;
  bool _explicit;
  std::optional<std::set<std::string>> _enumeration;
};

#if defined(MOOSE_UNIT_TEST) || defined(FOR_PYCAPABILITIES)
void
Capability::negateValue()
{
  _explicit = false;
  _enumeration.reset();
  _value = false;
}
#endif
}