RResultHandle.hxx

Go to the documentation of this file.

// Author: Stefan Wunsch, Enrico Guiraud CERN  09/2020
 
/*************************************************************************
 * Copyright (C) 1995-2020, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT_RDF_RRESULTHANDLE
#define ROOT_RDF_RRESULTHANDLE
 
#include "ROOT/RResultPtr.hxx"
#include "ROOT/RDF/RLoopManager.hxx"
#include "ROOT/RDF/RActionBase.hxx"
#include "ROOT/RDF/Utils.hxx" // TypeID2TypeName
 
#include <memory>
#include <sstream>
#include <typeinfo>
#include <stdexcept> // std::runtime_error
 
namespace ROOT {
namespace RDF {
 
/// \brief A type-erased version of RResultPtr and RResultMap.
/// RResultHandles are used to invoke ROOT::RDF::RunGraphs() and can also be useful
/// to store result pointers of different types in the same collection. Knowledge
/// about the actual result type will still be needed to access it.
/// \note Varied results are stripped away when a RResultMap is converted to a RResultHandle:
///       Only the nominal result will be accessible from the RResultHandle.
class RResultHandle {
   ROOT::Detail::RDF::RLoopManager *fLoopManager = nullptr; //< Pointer to the loop manager
   /// Owning pointer to the action that will produce this result.
   /// Ownership is shared with RResultPtrs and RResultHandles that refer to the same result.
   std::shared_ptr<ROOT::Internal::RDF::RActionBase> fActionPtr;
   std::shared_ptr<void> fObjPtr; ///< Type erased shared pointer encapsulating the wrapped result
   /// Owning pointer to the varied action that will produce these results if any.
   /// Null if the RResultHandle was created from a RResultPtr, so no variations were present.
   std::shared_ptr<ROOT::Internal::RDF::RActionBase> fVariedActionPtr;
   const std::type_info *fType = nullptr; ///< Type of the wrapped result
 
   // The ROOT::RDF::RunGraphs helper has to access the loop manager to check whether two RResultHandles belong to the same computation graph
   friend unsigned int RunGraphs(std::vector<RResultHandle>);
 
   /// Get the pointer to the encapsulated result.
   /// Ownership is not transferred to the caller.
   /// Triggers event loop and execution of all actions booked in the associated RLoopManager.
   void* Get()
   {
      if (!fActionPtr->HasRun())
         fLoopManager->Run();
      return fObjPtr.get();
   }
 
   /// Compare given type to the type of the wrapped result and throw if the types don't match.
   void CheckType(const std::type_info& type)
   {
      if (*fType != type) {
         std::stringstream ss;
         ss << "Got the type " << ROOT::Internal::RDF::TypeID2TypeName(type)
            << " but the RResultHandle refers to a result of type " << ROOT::Internal::RDF::TypeID2TypeName(*fType)
            << ".";
         throw std::runtime_error(ss.str());
      }
   }
 
   void ThrowIfNull()
   {
      if (fObjPtr == nullptr)
         throw std::runtime_error("Trying to access the contents of a null RResultHandle.");
   }
 
public:
   template <class T>
   RResultHandle(const RResultPtr<T> &resultPtr) : fLoopManager(resultPtr.fLoopManager), fActionPtr(resultPtr.fActionPtr), fObjPtr(resultPtr.fObjPtr), fType(&typeid(T)) {}
   template <class T>
   RResultHandle(const Experimental::RResultMap<T> &resultMap)
      : fLoopManager(resultMap.fLoopManager),
        fActionPtr(resultMap.fNominalAction),
        fObjPtr(resultMap.fMap.at("nominal")),
        fVariedActionPtr(resultMap.fVariedAction),
        fType(&typeid(T))
   {
   }
 
   RResultHandle(const RResultHandle&) = default;
   RResultHandle(RResultHandle&&) = default;
   RResultHandle() = default;
 
   /// Get the pointer to the encapsulated object.
   /// Triggers event loop and execution of all actions booked in the associated RLoopManager.
   /// If the RResultHandle was created from a RResultMap, this returns a pointer to the nominal value.
   /// \tparam T Type of the action result
   template <class T>
   T* GetPtr()
   {
      ThrowIfNull();
      CheckType(typeid(T));
      return static_cast<T*>(Get());
   }
 
   /// Get a const reference to the encapsulated object.
   /// Triggers event loop and execution of all actions booked in the associated RLoopManager.
   /// If the RResultHandle was created from a RResultMap, this returns a pointer to the nominal value.
   /// \tparam T Type of the action result
   template <class T>
   const T& GetValue()
   {
      ThrowIfNull();
      CheckType(typeid(T));
      return *static_cast<T*>(Get());
   }
 
   /// Get an RResultPtr to the encapsulated object.
   /// \tparam T Type of the action result
   template <class T>
   R__DEPRECATED(6, 32, "Please use RResultPtr directly and only cast to RResultHandle in order to call RunGraphs.")
   RResultPtr<T> GetResultPtr()
   {
      CheckType(typeid(T));
      return RResultPtr<T>(std::static_pointer_cast<T>(fObjPtr), fLoopManager, fActionPtr);
   }
 
   /// Check whether the result has already been computed
   ///
   /// ~~~{.cpp}
   /// std::vector<RResultHandle> results;
   /// results.emplace_back(df.Mean<double>("var"));
   /// res.IsReady(); // false, access will trigger event loop
   /// std::cout << res.GetValue<double>() << std::endl; // triggers event loop
   /// res.IsReady(); // true
   /// ~~~
   bool IsReady() const {
      if (fActionPtr == nullptr)
         return false;
      return fActionPtr->HasRun();
   }
 
   bool operator==(const RResultHandle &rhs) const
   {
      return fObjPtr == rhs.fObjPtr && fVariedActionPtr == rhs.fVariedActionPtr;
   }
 
   bool operator!=(const RResultHandle &rhs) const
   {
      return !(fObjPtr == rhs.fObjPtr) && fVariedActionPtr == rhs.fVariedActionPtr;
   }
};
 
} // namespace RDF
} // namespace ROOT
 
#endif // ROOT_RDF_RRESULTHANDLE