edm::Handle< GenericObject > Class Template Reference

#include <GenericHandle.h>

Public Member Functions
void	clear ()
bool	failedToGet () const
	Handle (std::string const &iName)
	Throws exception if iName is not a known C++ class type. More...
	Handle (TypeWithDict const &iType)
	Throws exception if iType is invalid. More...
	Handle (Handle< GenericObject > const &h)
	Handle (ObjectWithDict const &prod, Provenance const *prov, ProductID const &)
ProductID	id () const
bool	isValid () const
ObjectWithDict const &	operator* () const
ObjectWithDict const *	operator-> () const
Handle< GenericObject > &	operator= (Handle< GenericObject > const &rhs)
ObjectWithDict const *	product () const
Provenance const *	provenance () const
void	setWhyFailedFactory (std::shared_ptr< HandleExceptionFactory > const &iWhyFailed)
void	swap (Handle< GenericObject > &other)
TypeWithDict const &	type () const

Private Attributes
ObjectWithDict	prod_
Provenance const *	prov_
TypeWithDict	type_
std::shared_ptr< HandleExceptionFactory >	whyFailedFactory_

Detailed Description

template<>
class edm::Handle< GenericObject >

Definition at line 43 of file GenericHandle.h.

Constructor & Destructor Documentation

edm::Handle< GenericObject >::Handle ( std::string const &  iName )

inline

Throws exception if iName is not a known C++ class type.

Definition at line 46 of file GenericHandle.h.

References edm::errors::NotFound, and edm::Exception::throwThis().

                                   : type_(TypeWithDict::byName(iName)), prod_(), prov_(nullptr) {
      if (!bool(type_)) {
        Exception::throwThis(errors::NotFound,
                             "Handle<GenericObject> told to use uknown type '",
                             iName.c_str(),
                             "'.\n Please check spelling or that a module uses this type in the job.");
      }
    }

edm::Handle< GenericObject >::Handle ( TypeWithDict const &  iType )

inline

Throws exception if iType is invalid.

Definition at line 56 of file GenericHandle.h.

References edm::errors::NotFound, and edm::Exception::throwThis().

                                      : type_(iType), prod_(), prov_(nullptr) {
      if (!bool(iType)) {
        Exception::throwThis(errors::NotFound, "Handle<GenericObject> given an invalid type");
      }
    }

edm::Handle< GenericObject >::Handle ( Handle< GenericObject > const &  h )

inline

Definition at line 62 of file GenericHandle.h.

        : type_(h.type_), prod_(h.prod_), prov_(h.prov_), whyFailedFactory_(h.whyFailedFactory_) {}

edm::Handle< GenericObject >::Handle ( ObjectWithDict const &  prod, Provenance const *  prov, ProductID const &    )

inline

Definition at line 65 of file GenericHandle.h.

        : type_(prod.typeOf()), prod_(prod), prov_(prov) {
      assert(prod_);
      assert(prov_);
    }

Member Function Documentation

void edm::Handle< GenericObject >::clear ( void  )

inline

Definition at line 105 of file GenericHandle.h.

Referenced by Vispa.Views.WidgetView.WidgetView::closeEvent(), Vispa.Views.BoxDecayView.BoxDecayView::closeEvent(), Vispa.Share.FindAlgorithm.FindAlgorithm::findUsingFindDialog(), Vispa.Views.LineDecayView.LineDecayView::setDataObjects(), Vispa.Views.WidgetView.WidgetView::setDataObjects(), Vispa.Views.TreeView.TreeView::updateContent(), Vispa.Views.TableView.TableView::updateContent(), Vispa.Views.BoxDecayView.BoxDecayView::updateContent(), and Vispa.Views.PropertyView.PropertyView::updateContent().

                 {
      prov_ = nullptr;
      whyFailedFactory_ = nullptr;
    }

bool edm::Handle< GenericObject >::failedToGet ( ) const

inline

Definition at line 90 of file GenericHandle.h.

References electrons_cff::bool.

{ return bool(whyFailedFactory_); }

ProductID edm::Handle< GenericObject >::id ( void  ) const

inline

Definition at line 103 of file GenericHandle.h.

{ return prov_->productID(); }

bool edm::Handle< GenericObject >::isValid ( void  ) const

inline

Definition at line 88 of file GenericHandle.h.

Referenced by ntupleDataFormat._Object::_checkIsValid(), and core.AutoHandle.AutoHandle::ReallyLoad().

{ return prod_ && nullptr != prov_; }

ObjectWithDict const& edm::Handle< GenericObject >::operator* ( void  ) const

inline

Definition at line 98 of file GenericHandle.h.

{ return *(this->product()); }

ObjectWithDict const* edm::Handle< GenericObject >::operator-> ( ) const

inline

Definition at line 97 of file GenericHandle.h.

{ return this->product(); }

Handle<GenericObject>& edm::Handle< GenericObject >::operator= ( Handle< GenericObject > const &  rhs )

inline

Definition at line 82 of file GenericHandle.h.

References edm::swap(), and groupFilesInBlocks::temp.

                                                                       {
      Handle<GenericObject> temp(rhs);
      this->swap(temp);
      return *this;
    }

ObjectWithDict const* edm::Handle< GenericObject >::product ( ) const

inline

Definition at line 91 of file GenericHandle.h.

                                          {
      if (this->failedToGet()) {
        whyFailedFactory_->make()->raise();
      }
      return &prod_;
    }

Provenance const* edm::Handle< GenericObject >::provenance ( ) const

inline

Definition at line 101 of file GenericHandle.h.

{ return prov_; }

void edm::Handle< GenericObject >::setWhyFailedFactory ( std::shared_ptr< HandleExceptionFactory > const &  iWhyFailed )

inline

Definition at line 110 of file GenericHandle.h.

Referenced by edm::convert_handle().

                                                                                      {
      whyFailedFactory_ = iWhyFailed;
    }

void edm::Handle< GenericObject >::swap ( Handle< GenericObject > &  other )

inline

Definition at line 73 of file GenericHandle.h.

References prod_, prov_, edm::swap(), std::swap(), type_, and whyFailedFactory_.

                                            {
      // use unqualified swap for user defined classes
      using std::swap;
      swap(type_, other.type_);
      std::swap(prod_, other.prod_);
      swap(prov_, other.prov_);
      swap(whyFailedFactory_, other.whyFailedFactory_);
    }

TypeWithDict const& edm::Handle< GenericObject >::type ( ) const

inline

Definition at line 100 of file GenericHandle.h.

Referenced by edm::convert_handle(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::inputCommands(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputCommands(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputEventContent(), and Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::properties().

{ return type_; }

Member Data Documentation

ObjectWithDict edm::Handle< GenericObject >::prod_

private

Definition at line 116 of file GenericHandle.h.

Referenced by swap().

Provenance const* edm::Handle< GenericObject >::prov_

private

Definition at line 117 of file GenericHandle.h.

Referenced by swap().

TypeWithDict edm::Handle< GenericObject >::type_

private

Definition at line 115 of file GenericHandle.h.

Referenced by Modules.Service::__str__(), Modules.Service::_placeImpl(), Modules.ESSource::_placeImpl(), Modules.ESProducer::_placeImpl(), Modules.ESPrefer::copy(), Mixins._TypedParameterizable::dumpPython(), Modules.ESPrefer::dumpPythonAs(), Modules.Service::dumpSequencePython(), RandomRunSource.RandomRunSource::insertInto(), Modules.Service::insertInto(), ExternalGeneratorFilter.ExternalGeneratorFilter::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::moduleLabel_(), Modules.ESProducer::moduleLabel_(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), Modules.ESPrefer::nameInProcessDesc_(), and swap().

std::shared_ptr<HandleExceptionFactory> edm::Handle< GenericObject >::whyFailedFactory_

private

Definition at line 118 of file GenericHandle.h.

Referenced by swap().