LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
art::CatalogInterface Class Referenceabstract

#include "CatalogInterface.h"

Inheritance diagram for art::CatalogInterface:
art::TrivialFileDelivery

Public Member Functions

virtual ~CatalogInterface () noexcept=default
 
void configure (std::vector< std::string > const &items)
 
int getNextFileURI (std::string &uri, double &waitTime)
 
void updateStatus (std::string const &uri, FileDisposition status)
 
void outputFileClosed (std::string const &module_label, std::string const &fileFQname)
 
void outputFileOpened (std::string const &module_label)
 
void outputModuleInitiated (std::string const &module_label, fhicl::ParameterSet const &pset)
 
void eventSelected (std::string const &module_label, EventID const &event_id, HLTGlobalStatus const &acceptance_info)
 
bool isSearchable ()
 
void rewind ()
 

Private Member Functions

virtual void doConfigure (std::vector< std::string > const &item)=0
 
virtual int doGetNextFileURI (std::string &uri, double &waitTime)=0
 
virtual void doUpdateStatus (std::string const &uri, FileDisposition status)=0
 
virtual void doOutputFileOpened (std::string const &module_label)=0
 
virtual void doOutputModuleInitiated (std::string const &module_label, fhicl::ParameterSet const &pset)=0
 
virtual void doOutputFileClosed (std::string const &module_label, std::string const &fileFQname)=0
 
virtual void doEventSelected (std::string const &module_label, EventID const &event_id, HLTGlobalStatus const &acceptance_info)=0
 
virtual bool doIsSearchable ()=0
 
virtual void doRewind ()=0
 

Detailed Description

Definition at line 28 of file CatalogInterface.h.

Constructor & Destructor Documentation

virtual art::CatalogInterface::~CatalogInterface ( )
virtualdefaultnoexcept

Member Function Documentation

void art::CatalogInterface::configure ( std::vector< std::string > const &  items)
inline

Definition at line 65 of file CatalogInterface.h.

References doConfigure().

66  {
67  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
68  doConfigure(items);
69  }
virtual void doConfigure(std::vector< std::string > const &item)=0
virtual void art::CatalogInterface::doConfigure ( std::vector< std::string > const &  item)
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by configure().

virtual void art::CatalogInterface::doEventSelected ( std::string const &  module_label,
EventID const &  event_id,
HLTGlobalStatus const &  acceptance_info 
)
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by eventSelected().

virtual int art::CatalogInterface::doGetNextFileURI ( std::string &  uri,
double &  waitTime 
)
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by getNextFileURI().

virtual bool art::CatalogInterface::doIsSearchable ( )
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by isSearchable().

virtual void art::CatalogInterface::doOutputFileClosed ( std::string const &  module_label,
std::string const &  fileFQname 
)
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by outputFileClosed().

virtual void art::CatalogInterface::doOutputFileOpened ( std::string const &  module_label)
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by outputFileOpened().

virtual void art::CatalogInterface::doOutputModuleInitiated ( std::string const &  module_label,
fhicl::ParameterSet const &  pset 
)
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by outputModuleInitiated().

virtual void art::CatalogInterface::doRewind ( )
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by rewind().

virtual void art::CatalogInterface::doUpdateStatus ( std::string const &  uri,
FileDisposition  status 
)
privatepure virtual

Implemented in art::TrivialFileDelivery.

Referenced by updateStatus().

void art::CatalogInterface::eventSelected ( std::string const &  module_label,
EventID const &  event_id,
HLTGlobalStatus const &  acceptance_info 
)
inline

Definition at line 109 of file CatalogInterface.h.

References doEventSelected().

112  {
113  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
114  doEventSelected(module_label, event_id, acceptance_info);
115  }
virtual void doEventSelected(std::string const &module_label, EventID const &event_id, HLTGlobalStatus const &acceptance_info)=0
int art::CatalogInterface::getNextFileURI ( std::string &  uri,
double &  waitTime 
)
inline

Definition at line 72 of file CatalogInterface.h.

References doGetNextFileURI().

73  {
74  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
75  return doGetNextFileURI(uri, waitTime);
76  }
virtual int doGetNextFileURI(std::string &uri, double &waitTime)=0
bool art::CatalogInterface::isSearchable ( )
inline

Definition at line 118 of file CatalogInterface.h.

References doIsSearchable().

119  {
120  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
121  return doIsSearchable();
122  }
virtual bool doIsSearchable()=0
void art::CatalogInterface::outputFileClosed ( std::string const &  module_label,
std::string const &  fileFQname 
)
inline

Definition at line 86 of file CatalogInterface.h.

References doOutputFileClosed().

88  {
89  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
90  doOutputFileClosed(module_label, fileFQname);
91  }
virtual void doOutputFileClosed(std::string const &module_label, std::string const &fileFQname)=0
void art::CatalogInterface::outputFileOpened ( std::string const &  module_label)
inline

Definition at line 94 of file CatalogInterface.h.

References doOutputFileOpened().

95  {
96  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
97  doOutputFileOpened(module_label);
98  }
virtual void doOutputFileOpened(std::string const &module_label)=0
void art::CatalogInterface::outputModuleInitiated ( std::string const &  module_label,
fhicl::ParameterSet const &  pset 
)
inline

Definition at line 101 of file CatalogInterface.h.

References doOutputModuleInitiated().

103  {
104  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
105  doOutputModuleInitiated(module_label, pset);
106  }
virtual void doOutputModuleInitiated(std::string const &module_label, fhicl::ParameterSet const &pset)=0
void art::CatalogInterface::rewind ( )
inline

Definition at line 125 of file CatalogInterface.h.

References DECLARE_ART_SERVICE_INTERFACE, doRewind(), and art::SHARED.

126  {
127  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
128  doRewind();
129  }
virtual void doRewind()=0
void art::CatalogInterface::updateStatus ( std::string const &  uri,
FileDisposition  status 
)
inline

Definition at line 79 of file CatalogInterface.h.

References doUpdateStatus().

80  {
81  HEP_CONCURRENCY_ASSERT_ONLY_ONE_THREAD();
82  doUpdateStatus(uri, status);
83  }
virtual void doUpdateStatus(std::string const &uri, FileDisposition status)=0

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