OutputHandle.h

Go to the documentation of this file.

#ifndef DataFormats_Common_OutputHandle_h
#define DataFormats_Common_OutputHandle_h

/*----------------------------------------------------------------------
  
Handle: Non-owning "smart pointer" for reference to EDProducts and
their Provenances.

This is a very preliminary version, and lacks safety features and
elegance.

If the pointed-to object or provenance destroyed, use of the
Handle becomes undefined. There is no way to query the Handle to
discover if this has happened.

Handles can have:
  -- Product and Provenance pointers both null;
  -- Both pointers valid

To check validity, one can use the isValid() function.

If failedToGet() returns true then the requested data is not available
If failedToGet() returns false but isValid() is also false then no attempt 
  to get data has occurred

----------------------------------------------------------------------*/

#include "DataFormats/Provenance/interface/ProductProvenance.h"

#include "boost/shared_ptr.hpp"

namespace cms {
  class Exception;
}

namespace edm {
  class ConstBranchDescription;
  class EDProduct;
  class OutputHandle {
  public:
    OutputHandle() :
      wrap_(0),
      desc_(0),
      productProvenance_() {}

    OutputHandle(OutputHandle const& h) :
      wrap_(h.wrap_),
      desc_(h.desc_),
      productProvenance_(h.productProvenance_),
      whyFailed_(h.whyFailed_){}

    OutputHandle(EDProduct const* prod, ConstBranchDescription const* desc, boost::shared_ptr<ProductProvenance> productProvenance) :
      wrap_(prod),
      desc_(desc),
      productProvenance_(productProvenance) {}

    OutputHandle(boost::shared_ptr<cms::Exception> const& iWhyFailed):
      wrap_(0),
      desc_(0),
      productProvenance_(),
      whyFailed_(iWhyFailed) {}
    
    ~OutputHandle() {}

    void swap(OutputHandle& other) {
      using std::swap;
      std::swap(wrap_, other.wrap_);
      std::swap(desc_, other.desc_);
      std::swap(productProvenance_, other.productProvenance_);
      swap(whyFailed_,other.whyFailed_);
    }

    
    OutputHandle& operator=(OutputHandle const& rhs) {
      OutputHandle temp(rhs);
      this->swap(temp);
      return *this;
    }

    bool isValid() const {
      return wrap_ && desc_ &&productProvenance_;
    }

    bool failedToGet() const {
      return 0 != whyFailed_.get();
    }
    
    EDProduct const* wrapper() const {
      return wrap_;
    }

    boost::shared_ptr<cms::Exception> whyFailed() const {
      return whyFailed_;
    }

    ProductProvenance const* productProvenance() const {
      return productProvenance_.get();
    }

    boost::shared_ptr<ProductProvenance> productProvenanceSharedPtr() const {
      return productProvenance_;
    }

    ConstBranchDescription const* desc() const {
      return desc_;
    }

  private:
    EDProduct const* wrap_;
    ConstBranchDescription const* desc_;
    boost::shared_ptr<ProductProvenance> productProvenance_;
    boost::shared_ptr<cms::Exception> whyFailed_;
  };

  // Free swap function
  inline
  void
  swap(OutputHandle& a, OutputHandle& b) {
    a.swap(b);
  }
}

#endif