Interface.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/core/FrameworkExceptions.h>
#include <framework/gearbox/Unit.h>
 
#include <string>
 
class TObject;
 
namespace Belle2 {
 
  class GearDir;
 
  namespace gearbox {
    BELLE2_DEFINE_EXCEPTION(PathEmptyError, "Path '%1%' does not exist or is empty")
    BELLE2_DEFINE_EXCEPTION(ConversionError, "Path '%1%': Could not convert '%2%' to numerical value")
    BELLE2_DEFINE_EXCEPTION(TObjectConversionError, "Path '%1%': Could not convert to TObject! Malformed data?")

    class Interface {
    public:

      Interface(): m_path("/") {}

      virtual ~Interface() {}

      virtual int getNumberNodes(const std::string& path = "") const = 0;

      bool exists(const std::string& path = "") const { return getNumberNodes(path) > 0; }

      operator bool() const { return exists(); }
 

      std::vector<GearDir> getNodes(const std::string& path = "") const;

      std::string getPath() const { return m_path; }

      virtual std::string getString(const std::string& path = "") const noexcept(false) = 0;

      virtual std::pair<std::string, std::string> getStringWithUnit(const std::string& path) const noexcept(false) = 0;

      std::string getString(const std::string& path, const std::string& defaultValue) const;

      virtual const TObject* getTObject(const std::string& path) const noexcept(false) = 0;

      double getDouble(const std::string& path = "") const noexcept(false);

      double getDouble(const std::string& path, double defaultValue) const noexcept(false);

      int getInt(const std::string& path = "") const noexcept(false);

      int getInt(const std::string& path, int defaultValue) const noexcept(false);

      bool getBool(const std::string& path = "") const noexcept(false);

      bool getBool(const std::string& path, bool defaultValue) const;

      double getWithUnit(const std::string& path) const noexcept(false);

      double getWithUnit(const std::string& path, double defaultValue) const noexcept(false);

 
      std::vector<double> getArray(const std::string& path) const noexcept(false);

      std::vector<double> getArray(const std::string& path, const std::vector<double>& defaultValue) const noexcept(false);
 

      double getLength(const std::string& path = "") const noexcept(false)
      {
        return getWithUnit(path);
      }

      double getLength(const std::string& path, double defaultValue) const noexcept(false)
      {
        return getWithUnit(path, defaultValue);
      }

      double getAngle(const std::string& path = "") const noexcept(false)
      {
        return getWithUnit(path);
      }

      double getAngle(const std::string& path, double defaultValue) const noexcept(false)
      {
        return getWithUnit(path, defaultValue);
      }

      double getEnergy(const std::string& path = "") const noexcept(false)
      {
        return getWithUnit(path);
      }

      double getEnergy(const std::string& path, double defaultValue) const noexcept(false)
      {
        return getWithUnit(path, defaultValue);
      }

      double getDensity(const std::string& path = "") const noexcept(false)
      {
        return getWithUnit(path);
      }

      double getDensity(const std::string& path, double defaultValue) const noexcept(false)
      {
        return getWithUnit(path, defaultValue);
      }

      double getTime(const std::string& path = "") const noexcept(false)
      {
        return getWithUnit(path);
      }

      double getTime(const std::string& path, double defaultValue) const noexcept(false)
      {
        return getWithUnit(path, defaultValue);
      }

      double getFrequency(const std::string& path = "") const noexcept(false)
      {
        return getWithUnit(path);
      }

      double getFrequency(const std::string& path, double defaultValue) const noexcept(false)
      {
        return getWithUnit(path, defaultValue);
      }
 
    protected:

      std::string ensureNode(const std::string& path) const ;
      std::string ensurePath(const std::string& path) const;
      std::string addIndex(const std::string& path, int index) const;
      std::string joinPath(const std::string& path, const std::string& subpath) const;

      std::string m_path;
 
    };
  }
}