#include "TrivialFileDelivery.h"

Inheritance diagram for art::TrivialFileDelivery:

Classes
struct	Config

Public Types
using	Parameters = ServiceTable< Config >

Public Member Functions
	TrivialFileDelivery (Parameters const &config)

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
void	doConfigure (std::vector< std::string > const &items) override

int	doGetNextFileURI (std::string &uri, double &waitTime) override

void	doUpdateStatus (std::string const &uri, FileDisposition status) override

void	doOutputFileOpened (std::string const &module_label) override

void	doOutputModuleInitiated (std::string const &module_label, fhicl::ParameterSet const &pset) override

void	doOutputFileClosed (std::string const &module_label, std::string const &file) override

void	doEventSelected (std::string const &module_label, EventID const &event_id, HLTGlobalStatus const &acceptance_info) override

bool	doIsSearchable () override

void	doRewind () override

std::vector< std::string >	extractFileListFromPset (fhicl::ParameterSet const &pset)

std::string	prependFileDesignation (std::string const &name) const

Private Attributes
std::vector< std::string >	fileList {}

std::vector< std::string >::const_iterator	nextFile {fileList.cbegin()}

std::vector< std::string >::const_iterator	endOfFiles {fileList.cend()}

Detailed Description

Definition at line 31 of file TrivialFileDelivery.h.

Member Typedef Documentation

using art::TrivialFileDelivery::Parameters = ServiceTable<Config>

Definition at line 36 of file TrivialFileDelivery.h.

Constructor & Destructor Documentation

art::TrivialFileDelivery::TrivialFileDelivery ( TrivialFileDelivery::Parameters const & config )

Definition at line 23 of file TrivialFileDelivery_service.cc.

25 {}

Member Function Documentation

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

inlineinherited

Definition at line 65 of file CatalogInterface.h.

References art::CatalogInterface::doConfigure().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   doConfigure(items);
 }

void art::TrivialFileDelivery::doConfigure ( std::vector< std::string > const & items )

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 28 of file TrivialFileDelivery_service.cc.

 {
   fileList = items;
   nextFile = fileList.begin();
   endOfFiles = fileList.end();
 }

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

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 76 of file TrivialFileDelivery_service.cc.

79 {}

int art::TrivialFileDelivery::doGetNextFileURI	(	std::string &	uri,
		double &	waitTime
	)

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 36 of file TrivialFileDelivery_service.cc.

References art::NO_MORE_FILES, and art::SUCCESS.

 {
   FileDeliveryStatus stat;
   if (nextFile == endOfFiles) {
     stat = FileDeliveryStatus::NO_MORE_FILES;
     return stat;
   }
   auto pos = nextFile->find("://"); // Look for protocol.
   if (pos == std::string::npos) {   // Bare filename.
     throwIfFileNotExist(nextFile->c_str());
     uri = prependFileDesignation(*nextFile);
   } else if (nextFile->substr(0, pos) == "file") { // file://
     throwIfFileNotExist(nextFile->c_str() + pos + 3);
     uri = *nextFile;
   } else { // Unknown URI.
     uri = *nextFile;
   }
   waitTime = 0.0;
   stat = FileDeliveryStatus::SUCCESS;
   ++nextFile;
   return stat;
 }

bool art::TrivialFileDelivery::doIsSearchable ( )

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 82 of file TrivialFileDelivery_service.cc.

 {
   return true;
 }

void art::TrivialFileDelivery::doOutputFileClosed	(	std::string const &	module_label,
		std::string const &	file
	)

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 72 of file TrivialFileDelivery_service.cc.

74 {}

void art::TrivialFileDelivery::doOutputFileOpened ( std::string const & module_label )

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 65 of file TrivialFileDelivery_service.cc.

66 {}

void art::TrivialFileDelivery::doOutputModuleInitiated	(	std::string const &	module_label,
		fhicl::ParameterSet const &	pset
	)

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 68 of file TrivialFileDelivery_service.cc.

70 {}

void art::TrivialFileDelivery::doRewind ( )

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 87 of file TrivialFileDelivery_service.cc.

 {
   nextFile = fileList.begin();
 }

void art::TrivialFileDelivery::doUpdateStatus	(	std::string const &	uri,
		FileDisposition	status
	)

overrideprivatevirtual

Implements art::CatalogInterface.

Definition at line 62 of file TrivialFileDelivery_service.cc.

63 {}

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

inlineinherited

Definition at line 110 of file CatalogInterface.h.

References art::CatalogInterface::doEventSelected().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   doEventSelected(module_label, event_id, acceptance_info);
 }

std::vector< std::string > art::TrivialFileDelivery::extractFileListFromPset ( fhicl::ParameterSet const & pset )

private

Definition at line 94 of file TrivialFileDelivery_service.cc.

References fhicl::ParameterSet::get().

 {
   auto const& p = pset.get<ParameterSet>("source");
   return p.get<std::vector<std::string>>("fileNames");
   // TODO -- How do we properly throw if either source or fileNames is absent?
   // get() does throw, but is it the right throw and should we be catching it?
 }

int art::CatalogInterface::getNextFileURI	(	std::string &	uri,
		double &	waitTime
	)

inlineinherited

Definition at line 72 of file CatalogInterface.h.

References art::CatalogInterface::doGetNextFileURI().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   return doGetNextFileURI(uri, waitTime);
 }

bool art::CatalogInterface::isSearchable ( )

inlineinherited

Definition at line 119 of file CatalogInterface.h.

References art::CatalogInterface::doIsSearchable().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   return doIsSearchable();
 }

void art::CatalogInterface::outputFileClosed	(	std::string const &	module_label,
		std::string const &	fileFQname
	)

inlineinherited

Definition at line 87 of file CatalogInterface.h.

References art::CatalogInterface::doOutputFileClosed().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   doOutputFileClosed(module_label, fileFQname);
 }

void art::CatalogInterface::outputFileOpened ( std::string const & module_label )

inlineinherited

Definition at line 95 of file CatalogInterface.h.

References art::CatalogInterface::doOutputFileOpened().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   doOutputFileOpened(module_label);
 }

void art::CatalogInterface::outputModuleInitiated	(	std::string const &	module_label,
		fhicl::ParameterSet const &	pset
	)

inlineinherited

Definition at line 102 of file CatalogInterface.h.

References art::CatalogInterface::doOutputModuleInitiated().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   doOutputModuleInitiated(module_label, pset);
 }

std::string art::TrivialFileDelivery::prependFileDesignation ( std::string const & name ) const

private

Definition at line 103 of file TrivialFileDelivery_service.cc.

References DEFINE_ART_SERVICE_INTERFACE_IMPL, and s.

 {
   std::string const s{"file://"};
   return s + name;
 }

void art::CatalogInterface::rewind ( )

inlineinherited

Definition at line 126 of file CatalogInterface.h.

References DECLARE_ART_SERVICE_INTERFACE, art::CatalogInterface::doRewind(), and art::LEGACY.

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   doRewind();
 }

void art::CatalogInterface::updateStatus	(	std::string const &	uri,
		FileDisposition	status
	)

inlineinherited

Definition at line 79 of file CatalogInterface.h.

References art::CatalogInterface::doUpdateStatus().

 {
   CET_ASSERT_ONLY_ONE_THREAD();
   doUpdateStatus(uri, status);
 }

Member Data Documentation

std::vector<std::string>::const_iterator art::TrivialFileDelivery::endOfFiles {fileList.cend()}

private

Definition at line 66 of file TrivialFileDelivery.h.

std::vector<std::string> art::TrivialFileDelivery::fileList {}

private

Definition at line 64 of file TrivialFileDelivery.h.

std::vector<std::string>::const_iterator art::TrivialFileDelivery::nextFile {fileList.cbegin()}

private

Definition at line 65 of file TrivialFileDelivery.h.

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

art/Framework/Services/Optional/TrivialFileDelivery.h
art/Framework/Services/Optional/TrivialFileDelivery_service.cc

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation