art::ClosingCriteria Class Reference

#include "ClosingCriteria.h"

Classes
struct	Config
struct	Defaults

Public Member Functions
	~ClosingCriteria ()
	ClosingCriteria ()
	ClosingCriteria (Config const &fp)
	ClosingCriteria (FileProperties const &fp, std::string const &granularity)
FileProperties const &	fileProperties () const
Granularity	granularity () const
bool	should_close (FileProperties const &) const

Private Attributes
FileProperties	closingCriteria_
Granularity	granularity_

Detailed Description

Definition at line 69 of file ClosingCriteria.h.

Constructor & Destructor Documentation

art::ClosingCriteria::~ClosingCriteria ( )

default

Referenced by art::operator<<().

art::ClosingCriteria::ClosingCriteria

(

)

Definition at line 232 of file ClosingCriteria.cc.

References granularity_, art::ClosingCriteria::Defaults::granularity_default(), and art::Granularity::value().

    : closingCriteria_{}
    , granularity_{Granularity::value(Defaults::granularity_default())}
  {}

art::ClosingCriteria::ClosingCriteria

(

Config const &

fp

)

Definition at line 242 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(),
                                     chrono::seconds{c.maxAge()}},
                      c.granularity()}
  {
    auto const& cc = closingCriteria_;
    config_require(cc.nEvents() > 0, "maxEvents must be greater than 0.");
    config_require(cc.nSubRuns() > 0, "maxSubRuns must be greater than 0.");
    config_require(cc.nRuns() > 0, "maxRuns must be greater than 0.");
    config_require(cc.nInputFiles() > 0,
                   "maxInputFiles must be greater than 0.");
    config_require(cc.size() > 0, "maxSize must be greater than 0 KiB.");
    config_require(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 237 of file ClosingCriteria.cc.

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

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

Member Function Documentation

FileProperties const & art::ClosingCriteria::fileProperties

(

)

const

Definition at line 263 of file ClosingCriteria.cc.

References closingCriteria_.

  {
    return closingCriteria_;
  }

Granularity art::ClosingCriteria::granularity

(

)

const

Definition at line 269 of file ClosingCriteria.cc.

References granularity_.

Referenced by ClosingCriteria().

  {
    return granularity_;
  }

bool art::ClosingCriteria::should_close

(

FileProperties const &

fp

)

const

Definition at line 275 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().

  {
    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 144 of file ClosingCriteria.h.

Referenced by ClosingCriteria(), fileProperties(), and should_close().

Granularity art::ClosingCriteria::granularity_

private

Initial value:

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

Definition at line 145 of file ClosingCriteria.h.

Referenced by ClosingCriteria(), and granularity().

---

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

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