art::ClosingCriteria Class Reference

#include "ClosingCriteria.h"

Classes
struct	Config

Public Member Functions
	ClosingCriteria (Config const &fp)
	ClosingCriteria (FileProperties const &fp, std::string const &granularity)
	ClosingCriteria ()=default
auto const &	fileProperties () const
auto	granularity () const
bool	should_close (FileProperties const &) const

Private Attributes
FileProperties	closingCriteria_
Granularity	granularity_

Detailed Description

Definition at line 155 of file ClosingCriteria.h.

Constructor & Destructor Documentation

art::ClosingCriteria::ClosingCriteria

(

Config const &

fp

)

Definition at line 34 of file ClosingCriteria.cc.

References closingCriteria_, art::ClosingCriteria::Config::granularity, art::ClosingCriteria::Config::maxAge, art::ClosingCriteria::Config::maxEvents, art::ClosingCriteria::Config::maxInputFiles, art::ClosingCriteria::Config::maxRuns, art::ClosingCriteria::Config::maxSize, and art::ClosingCriteria::Config::maxSubRuns.

  : ClosingCriteria{FileProperties{c.maxEvents(),
                                   c.maxSubRuns(),
                                   c.maxRuns(),
                                   c.maxInputFiles(),
                                   c.maxSize(),
                                   seconds_t{c.maxAge()}},
                    c.granularity()}
{
  auto const& cc = closingCriteria_;
  config_assert(cc.nEvents() > 0, "maxEvents must be greater than 0.");
  config_assert(cc.nSubRuns() > 0, "maxSubRuns must be greater than 0.");
  config_assert(cc.nRuns() > 0, "maxRuns must be greater than 0.");
  config_assert(cc.nInputFiles() > 0, "maxInputFiles must be greater than 0.");
  config_assert(cc.size() > 0, "maxSize must be greater than 0 KiB.");
  config_assert(cc.age() > decltype(cc.age())::zero(),
                "maxAge must be greater than 0 seconds.");
}

art::ClosingCriteria::ClosingCriteria	(	FileProperties const &	fp,
		std::string const &	granularity
	)

Definition at line 53 of file ClosingCriteria.cc.

References granularity(), granularity_, and art::Granularity::value().

  : closingCriteria_{fp}, granularity_{Granularity::value(granularity)}
{}

art::ClosingCriteria::ClosingCriteria ( )

default

Member Function Documentation

auto const& art::ClosingCriteria::fileProperties ( ) const

inline

Definition at line 185 of file ClosingCriteria.h.

    {
      return closingCriteria_;
    }

auto art::ClosingCriteria::granularity ( ) const

inline

Definition at line 190 of file ClosingCriteria.h.

Referenced by ClosingCriteria(), art::RootOutput::fileGranularity(), art::TFileService::maybeSwitchFiles_(), and art::detail::shouldFastClone().

    {
      return granularity_;
    }

bool art::ClosingCriteria::should_close

(

FileProperties const &

fp

)

const

Definition at line 59 of file ClosingCriteria.cc.

References art::FileProperties::age(), closingCriteria_, art::FileProperties::nEvents(), art::FileProperties::nInputFiles(), art::FileProperties::nRuns(), art::FileProperties::nSubRuns(), and art::FileProperties::size().

Referenced by art::RootOutputFile::requestsToCloseFile(), and art::TFileService::requestsToCloseFile_().

{
  return fp.size() >= closingCriteria_.size() ||
         fp.nEvents() >= closingCriteria_.nEvents() ||
         fp.nSubRuns() >= closingCriteria_.nSubRuns() ||
         fp.nRuns() >= closingCriteria_.nRuns() ||
         fp.nInputFiles() >= closingCriteria_.nInputFiles() ||
         fp.age() >= closingCriteria_.age();
}

Member Data Documentation

FileProperties art::ClosingCriteria::closingCriteria_

private

Definition at line 198 of file ClosingCriteria.h.

Referenced by ClosingCriteria(), and should_close().

Granularity art::ClosingCriteria::granularity_

private

Initial value:

{
      Granularity::value(Defaults::granularity_default())}

Definition at line 199 of file ClosingCriteria.h.

Referenced by ClosingCriteria().

---

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

• art/Framework/IO/ClosingCriteria.h
• art/Framework/IO/ClosingCriteria.cc