gallery::Event Class Reference

#include <Event.h>

Public Types
template<typename T >
using	HandleT = Handle< T >

Public Member Functions
	Event (std::vector< std::string > const &fileNames, bool useTTreeCache=true, unsigned int eventsToLearnUsedBranches=7)
template<typename PROD >
gallery::ValidHandle< PROD >	getValidHandle (art::InputTag const &) const
template<typename PROD >
bool	getByLabel (art::InputTag const &, Handle< PROD > &result) const
template<typename PROD >
void	getManyByType (std::vector< Handle< PROD >> &result) const
template<typename PROD >
std::vector< art::InputTag >	getInputTags () const
template<typename PROD >
std::vector< art::ProductToken< PROD > >	getProductTokens () const
art::EventAuxiliary const &	eventAuxiliary () const
art::History const &	history () const
art::ProcessHistoryID const &	processHistoryID () const
art::ProcessHistory const &	processHistory () const
art::BranchDescription const &	getProductDescription (art::ProductID) const
long long	numberOfEventsInFile () const
long long	eventEntry () const
long long	fileEntry () const
void	goToEntry (long long entry)
bool	isValid () const
bool	atEnd () const
void	toBegin ()
void	first ()
Event &	operator++ ()
void	next ()
Event &	operator-- ()
void	previous ()
TFile *	getTFile () const
TTree *	getTTree () const

Private Member Functions
ProductWithID	getByLabel (std::type_info const &typeInfoOfWrapper, art::InputTag const &inputTag) const
std::vector< ProductWithID >	getManyByType (std::type_info const &typeInfoOfWrapper) const
void	throwProductNotFoundException (std::type_info const &typeInfo, art::InputTag const &tag) const
std::shared_ptr< art::Exception const >	makeProductNotFoundException (std::type_info const &typeInfo, art::InputTag const &tag) const
void	checkForEnd () const
void	updateAfterEventChange (long long oldFileEntry)

Private Attributes
bool	randomAccessOK_
std::unique_ptr< EventNavigator >	eventNavigator_
std::unique_ptr< DataGetterHelper >	dataGetterHelper_
bool	useTTreeCache_
unsigned int	eventsToLearnUsedBranches_
unsigned int	eventsProcessed_ {}

Detailed Description

Definition at line 42 of file Event.h.

Member Typedef Documentation

template<typename T >

using gallery::Event::HandleT = Handle<T>

Definition at line 124 of file Event.h.

Constructor & Destructor Documentation

gallery::Event::Event ( std::vector< std::string > const &  fileNames, bool  useTTreeCache = true, unsigned int  eventsToLearnUsedBranches = 7  )

explicit

Definition at line 12 of file Event.cc.

    : randomAccessOK_{fileNames.size() == 1}
    , eventNavigator_{std::make_unique<EventNavigator>(fileNames)}
    , dataGetterHelper_{std::make_unique<DataGetterHelper>(
        eventNavigator_.get(),
        std::make_shared<EventHistoryGetter>(eventNavigator_.get()))}
    , useTTreeCache_{useTTreeCache}
    , eventsToLearnUsedBranches_{eventsToLearnUsedBranches}
  {

    if (eventsToLearnUsedBranches_ < 1)
      eventsToLearnUsedBranches_ = 1;
    if (!atEnd()) {
      bool constexpr initializeTheCache{false};
      dataGetterHelper_->updateFile(eventNavigator_->getTFile(),
                                    eventNavigator_->getTTree(),
                                    initializeTheCache);
    }
  }

Member Function Documentation

bool gallery::Event::atEnd

(

)

const

Definition at line 101 of file Event.cc.

  {
    return eventNavigator_->atEnd();
  }

void gallery::Event::checkForEnd ( ) const

private

Definition at line 220 of file Event.cc.

  {
    if (atEnd()) {
      throw art::Exception(art::errors::LogicError)
        << "You have requested data past the last event\n";
    }
  }

art::EventAuxiliary const & gallery::Event::eventAuxiliary

(

)

const

Definition at line 35 of file Event.cc.

  {
    return eventNavigator_->eventAuxiliary();
  }

long long gallery::Event::eventEntry

(

)

const

Definition at line 71 of file Event.cc.

  {
    return eventNavigator_->eventEntry();
  }

long long gallery::Event::fileEntry

(

)

const

Definition at line 77 of file Event.cc.

  {
    return eventNavigator_->fileEntry();
  }

void gallery::Event::first ( )

inline

Definition at line 237 of file Event.h.

{
  return toBegin();
}

template<typename PROD >

bool gallery::Event::getByLabel ( art::InputTag const &  inputTag, Handle< PROD > &  result  ) const

inline

Definition at line 174 of file Event.h.

{
  checkForEnd();
  if (inputTag.empty()) {
    result = Handle<PROD>{makeProductNotFoundException(typeid(PROD), inputTag)};
    return false;
  }

  std::type_info const& typeInfoOfWrapper{typeid(art::Wrapper<PROD>)};
  auto res = getByLabel(typeInfoOfWrapper, inputTag);
  auto edProduct = res.first;

  auto ptrToWrapper = dynamic_cast<art::Wrapper<PROD> const*>(edProduct);

  if (ptrToWrapper == nullptr) {
    result = Handle<PROD>{makeProductNotFoundException(typeid(PROD), inputTag)};
    return false;
  }
  auto product = ptrToWrapper->product();
  result = Handle<PROD>{product, res.second};
  return true;
}

ProductWithID gallery::Event::getByLabel ( std::type_info const &  typeInfoOfWrapper, art::InputTag const &  inputTag  ) const

private

Definition at line 185 of file Event.cc.

  {
    return dataGetterHelper_->getByLabel(typeInfoOfWrapper, inputTag);
  }

template<typename PROD >

std::vector< art::InputTag > gallery::Event::getInputTags ( ) const

inline

Definition at line 218 of file Event.h.

{
  std::type_info const& typeInfoOfWrapper{typeid(art::Wrapper<PROD>)};
  return dataGetterHelper_->getInputTags(typeInfoOfWrapper);
}

template<typename PROD >

void gallery::Event::getManyByType ( std::vector< Handle< PROD >> &  result ) const

inline

Definition at line 200 of file Event.h.

{
  std::type_info const& typeInfoOfWrapper{typeid(art::Wrapper<PROD>)};
  auto products = getManyByType(typeInfoOfWrapper);
  std::vector<Handle<PROD>> tmp;
  cet::transform_all(products, back_inserter(tmp), [](auto const& pr) {
    auto product = pr.first;
    auto wrapped_product = dynamic_cast<art::Wrapper<PROD> const*>(product);
    assert(wrapped_product != nullptr);
    auto user_product = wrapped_product->product();
    assert(user_product != nullptr);
    return Handle<PROD>{user_product, pr.second};
  });
  swap(tmp, result);
}

std::vector< ProductWithID > gallery::Event::getManyByType ( std::type_info const &  typeInfoOfWrapper ) const

private

Definition at line 192 of file Event.cc.

  {
    return dataGetterHelper_->getManyByType(typeInfoOfWrapper);
  }

art::BranchDescription const & gallery::Event::getProductDescription

(

art::ProductID

pid

)

const

Definition at line 59 of file Event.cc.

  {
    return dataGetterHelper_->getProductDescription(pid);
  }

template<typename PROD >

std::vector< art::ProductToken< PROD > > gallery::Event::getProductTokens ( ) const

inline

Definition at line 226 of file Event.h.

{
  std::vector<art::ProductToken<PROD>> result;
  auto const tags = getInputTags<PROD>();
  cet::transform_all(tags, back_inserter(result), [](auto const& tag) {
    return art::ProductToken<PROD>{tag};
  });
  return result;
}

TFile * gallery::Event::getTFile

(

)

const

Definition at line 173 of file Event.cc.

  {
    return eventNavigator_->getTFile();
  }

TTree * gallery::Event::getTTree

(

)

const

Definition at line 179 of file Event.cc.

  {
    return eventNavigator_->getTTree();
  }

template<typename PROD >

gallery::ValidHandle< PROD > gallery::Event::getValidHandle ( art::InputTag const &  inputTag ) const

inline

Definition at line 156 of file Event.h.

{
  checkForEnd();
  std::type_info const& typeInfoOfWrapper{typeid(art::Wrapper<PROD>)};
  auto res = getByLabel(typeInfoOfWrapper, inputTag);
  auto edProduct = res.first;

  auto ptrToWrapper = dynamic_cast<art::Wrapper<PROD> const*>(edProduct);
  if (ptrToWrapper == nullptr) {
    throwProductNotFoundException(typeid(PROD), inputTag);
  }

  auto product = ptrToWrapper->product();
  return ValidHandle<PROD>{product, res.second};
}

void gallery::Event::goToEntry

(

long long

entry

)

Definition at line 83 of file Event.cc.

  {
    if (!randomAccessOK_)
      throwIllegalRandomAccess();
    if (entry < 0)
      throwIllegalRandomAccess();
    if (entry >= numberOfEventsInFile())
      throwIllegalRandomAccess();
    eventNavigator_->goToEntry(entry);
  }

art::History const & gallery::Event::history

(

)

const

Definition at line 41 of file Event.cc.

  {
    return eventNavigator_->history();
  }

bool gallery::Event::isValid

(

)

const

Definition at line 95 of file Event.cc.

  {
    return eventNavigator_->isValid();
  }

std::shared_ptr< art::Exception const > gallery::Event::makeProductNotFoundException ( std::type_info const &  typeInfo, art::InputTag const &  tag  ) const

private

Definition at line 206 of file Event.cc.

  {
    auto e = std::make_shared<art::Exception>(art::errors::ProductNotFound);
    *e << "Failed to find product for \n  type = '"
       << art::TypeID{typeInfo}.className() << "'\n  module = '" << tag.label()
       << "'\n  productInstance = '"
       << ((!tag.instance().empty()) ? tag.instance().c_str() : "")
       << "'\n  process='"
       << ((!tag.process().empty()) ? tag.process().c_str() : "") << "'\n";
    return e;
  }

void gallery::Event::next

(

)

Definition at line 161 of file Event.cc.

  {
    operator++();
  }

long long gallery::Event::numberOfEventsInFile

(

)

const

Definition at line 65 of file Event.cc.

  {
    return eventNavigator_->entriesInCurrentFile();
  }

Event & gallery::Event::operator++

(

)

Definition at line 119 of file Event.cc.

  {
    auto const oldFileEntry = fileEntry();
    eventNavigator_->next();
    updateAfterEventChange(oldFileEntry);
    return *this;
  }

Event & gallery::Event::operator--

(

)

Definition at line 128 of file Event.cc.

  {
    if (!randomAccessOK_)
      throwIllegalRandomAccess();
    if (atEnd())
      throwIllegalDecrement();
    auto const oldFileEntry = fileEntry();
    eventNavigator_->previous();
    updateAfterEventChange(oldFileEntry);
    return *this;
  }

void gallery::Event::previous

(

)

Definition at line 167 of file Event.cc.

  {
    operator--();
  }

art::ProcessHistory const & gallery::Event::processHistory

(

)

const

Definition at line 53 of file Event.cc.

  {
    return eventNavigator_->processHistory();
  }

art::ProcessHistoryID const & gallery::Event::processHistoryID

(

)

const

Definition at line 47 of file Event.cc.

  {
    return eventNavigator_->processHistoryID();
  }

void gallery::Event::throwProductNotFoundException ( std::type_info const &  typeInfo, art::InputTag const &  tag  ) const

private

Definition at line 198 of file Event.cc.

  {
    auto e = makeProductNotFoundException(typeInfo, tag);
    throw *e;
  }

void gallery::Event::toBegin

(

)

Definition at line 107 of file Event.cc.

  {
    long long const oldEventEntry = eventEntry();
    long long const oldFileEntry = fileEntry();
    eventNavigator_->toBegin();
    if (oldEventEntry == eventEntry() && oldFileEntry == fileEntry()) {
      return;
    }
    updateAfterEventChange(oldFileEntry);
  }

void gallery::Event::updateAfterEventChange ( long long  oldFileEntry )

private

Definition at line 141 of file Event.cc.

  {
    ++eventsProcessed_;
    if (atEnd())
      return;
    if (oldFileEntry != fileEntry()) {
      bool initializeTheCache =
        useTTreeCache_ && eventsProcessed_ >= eventsToLearnUsedBranches_;
      dataGetterHelper_->updateFile(eventNavigator_->getTFile(),
                                    eventNavigator_->getTTree(),
                                    initializeTheCache);
    } else {
      dataGetterHelper_->updateEvent();
      if (useTTreeCache_ && eventsProcessed_ == eventsToLearnUsedBranches_) {
        dataGetterHelper_->initializeTTreeCache();
      }
    }
  }

Member Data Documentation

std::unique_ptr<DataGetterHelper> gallery::Event::dataGetterHelper_

private

Definition at line 146 of file Event.h.

std::unique_ptr<EventNavigator> gallery::Event::eventNavigator_

private

Definition at line 145 of file Event.h.

unsigned int gallery::Event::eventsProcessed_ {}

private

Definition at line 150 of file Event.h.

unsigned int gallery::Event::eventsToLearnUsedBranches_

private

Definition at line 149 of file Event.h.

bool gallery::Event::randomAccessOK_

private

Definition at line 144 of file Event.h.

bool gallery::Event::useTTreeCache_

private

Definition at line 148 of file Event.h.

---

The documentation for this class was generated from the following files:

• gallery/gallery/Event.h
• gallery/gallery/Event.cc