Capabilities.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 "CapabilityUtils.h"

#ifdef MOOSE_UNIT_TEST
// forward declare unit tests
#include "gtest/gtest.h"
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, boolTest);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, intTest);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, stringTest);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, versionTest);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, multipleTest);
class GTEST_TEST_CLASS_NAME_(CapabilitiesTest, parseFail);
#endif

namespace Moose
{

class Capabilities
{
public:
  virtual ~Capabilities() {}

  static Capabilities & getCapabilityRegistry();

  void add(const std::string & capability, CapabilityUtils::Type value, const std::string & doc);
  void add(const std::string & capability, const char * value, const char * doc);

  std::string dump() const;

  CapabilityUtils::Result check(const std::string & requested_capabilities) const;

  Capabilities(Capabilities const &) = delete;
  Capabilities & operator=(Capabilities const &) = delete;

  Capabilities(Capabilities &&) = delete;
  Capabilities & operator=(Capabilities &&) = delete;

protected:
  std::map<std::string, std::pair<CapabilityUtils::Type, std::string>> _capability_registry;

private:
  // Private constructor for singleton pattern
  Capabilities() {}

#ifdef MOOSE_UNIT_TEST
  FRIEND_TEST(::CapabilitiesTest, boolTest);
  FRIEND_TEST(::CapabilitiesTest, intTest);
  FRIEND_TEST(::CapabilitiesTest, stringTest);
  FRIEND_TEST(::CapabilitiesTest, versionTest);
  FRIEND_TEST(::CapabilitiesTest, multipleTest);
  FRIEND_TEST(::CapabilitiesTest, parseFail);
#endif
};

} // namespace Moose