art::OutputWorker Class Reference

#include <OutputWorker.h>

Inheritance diagram for art::OutputWorker:

Public Member Functions
virtual	~OutputWorker ()
	OutputWorker (std::shared_ptr< OutputModule > mod, ModuleDescription const &, WorkerParams const &)
std::string const &	lastClosedFileName () const
bool	closeFile ()
bool	fileIsOpen () const
void	incrementInputFileNumber ()
bool	requestsToCloseFile () const
bool	openFile (FileBlock const &fb)
void	writeRun (RunPrincipal &rp)
void	writeSubRun (SubRunPrincipal &srp)
void	writeEvent (EventPrincipal &ep, ModuleContext const &mc)
void	setRunAuxiliaryRangeSetID (RangeSet const &)
void	setSubRunAuxiliaryRangeSetID (RangeSet const &)
bool	limitReached () const
void	setFileStatus (OutputFileStatus)
void	configure (OutputModuleDescription const &desc)
Granularity	fileGranularity () const
virtual void	selectProducts (ProductTables const &)
Public Member Functions inherited from art::WorkerT< OutputModule >
	WorkerT (std::shared_ptr< OutputModule >, ModuleDescription const &, WorkerParams const &)
Public Member Functions inherited from art::Worker
virtual	~Worker ()=default
	Worker (ModuleDescription const &, WorkerParams const &)
void	beginJob (detail::SharedResources const &)
void	endJob ()
void	respondToOpenInputFile (FileBlock const &fb)
void	respondToCloseInputFile (FileBlock const &fb)
void	respondToOpenOutputFiles (FileBlock const &fb)
void	respondToCloseOutputFiles (FileBlock const &fb)
bool	doWork (Transition, Principal &, ModuleContext const &)
void	doWork_event (hep::concurrency::WaitingTaskPtr workerInPathDoneTask, EventPrincipal &, ModuleContext const &)
void	doWork_event (EventPrincipal &, ModuleContext const &)
ScheduleID	scheduleID () const
ModuleDescription const &	description () const
std::string const &	label () const
bool	returnCode () const
hep::concurrency::SerialTaskQueueChain *	serialTaskQueueChain () const
void	reset ()
std::size_t	timesVisited () const
std::size_t	timesRun () const
std::size_t	timesPassed () const
std::size_t	timesFailed () const
std::size_t	timesExcept () const
void	runWorker (EventPrincipal &, ModuleContext const &)

Private Attributes
ServiceHandle< CatalogInterface >	ci_ {}
Granularity	fileGranularity_ {Granularity::Unset}

Additional Inherited Members
Public Types inherited from art::WorkerT< OutputModule >
using	ModuleType = OutputModule
Public Types inherited from art::Worker
enum	State {   Ready, Pass, Fail, Working,   ExceptionThrown }
Protected Member Functions inherited from art::WorkerT< OutputModule >
OutputModule &	module ()
OutputModule const &	module () const
Protected Attributes inherited from art::Worker
std::atomic< std::size_t >	counts_visited_ {}
std::atomic< std::size_t >	counts_run_ {}
std::atomic< std::size_t >	counts_passed_ {}
std::atomic< std::size_t >	counts_failed_ {}
std::atomic< std::size_t >	counts_thrown_ {}

Detailed Description

Definition at line 25 of file OutputWorker.h.

Constructor & Destructor Documentation

art::OutputWorker::~OutputWorker ( )

virtualdefault

art::OutputWorker::OutputWorker	(	std::shared_ptr< OutputModule >	mod,
		ModuleDescription const &	md,
		WorkerParams const &	wp
	)

Definition at line 15 of file OutputWorker.cc.

    : WorkerT<OutputModule>{mod, md, wp}

Member Function Documentation

bool art::OutputWorker::closeFile

(

)

Definition at line 32 of file OutputWorker.cc.

  {
    bool const didCloseFile{module().doCloseFile()};
    if (didCloseFile) {
      ci_->outputFileClosed(description().moduleLabel(), lastClosedFileName());
    }
    return didCloseFile;
  }

void art::OutputWorker::configure

(

OutputModuleDescription const &

desc

)

Definition at line 112 of file OutputWorker.cc.

  {
    module().configure(desc);
  }

Granularity art::OutputWorker::fileGranularity

(

)

const

Definition at line 124 of file OutputWorker.cc.

  {
    return module().fileGranularity();
  }

bool art::OutputWorker::fileIsOpen

(

)

const

Definition at line 94 of file OutputWorker.cc.

  {
    return module().fileIsOpen();
  }

void art::OutputWorker::incrementInputFileNumber

(

)

Definition at line 42 of file OutputWorker.cc.

  {
    return module().incrementInputFileNumber();
  }

std::string const & art::OutputWorker::lastClosedFileName

(

)

const

Initial value:

{
    ci_->outputModuleInitiated(
      label(),
      fhicl::ParameterSetRegistry::get(description().parameterSetID()))

Definition at line 26 of file OutputWorker.cc.

  {
    return module().lastClosedFileName();
  }

bool art::OutputWorker::limitReached

(

)

const

Definition at line 106 of file OutputWorker.cc.

  {
    return module().limitReached();
  }

bool art::OutputWorker::openFile

(

FileBlock const &

fb

)

Definition at line 54 of file OutputWorker.cc.

  {
    bool const didOpenFile{module().doOpenFile(fb)};
    if (didOpenFile) {
      ci_->outputFileOpened(description().moduleLabel());
    }
    return didOpenFile;
  }

bool art::OutputWorker::requestsToCloseFile

(

)

const

Definition at line 48 of file OutputWorker.cc.

  {
    return module().requestsToCloseFile();
  }

void art::OutputWorker::selectProducts ( ProductTables const &  tables )

virtual

Definition at line 118 of file OutputWorker.cc.

  {
    module().selectProducts(tables);
  }

void art::OutputWorker::setFileStatus

(

OutputFileStatus

ofs

)

Definition at line 100 of file OutputWorker.cc.

  {
    return module().setFileStatus(ofs);
  }

void art::OutputWorker::setRunAuxiliaryRangeSetID

(

RangeSet const &

rs

)

Definition at line 82 of file OutputWorker.cc.

  {
    module().doSetRunAuxiliaryRangeSetID(rs);
  }

void art::OutputWorker::setSubRunAuxiliaryRangeSetID

(

RangeSet const &

rs

)

Definition at line 88 of file OutputWorker.cc.

  {
    module().doSetSubRunAuxiliaryRangeSetID(rs);
  }

void art::OutputWorker::writeEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc
	)

Definition at line 76 of file OutputWorker.cc.

  {
    module().doWriteEvent(ep, mc);
  }

void art::OutputWorker::writeRun

(

RunPrincipal &

rp

)

Definition at line 64 of file OutputWorker.cc.

  {
    module().doWriteRun(rp);
  }

void art::OutputWorker::writeSubRun

(

SubRunPrincipal &

srp

)

Definition at line 70 of file OutputWorker.cc.

  {
    module().doWriteSubRun(srp);
  }

Member Data Documentation

ServiceHandle<CatalogInterface> art::OutputWorker::ci_ {}

private

Definition at line 53 of file OutputWorker.h.

Granularity art::OutputWorker::fileGranularity_ {Granularity::Unset}

private

Definition at line 54 of file OutputWorker.h.

---

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

• art/art/Framework/Core/OutputWorker.h
• art/art/Framework/Core/OutputWorker.cc