art::Granularity Class Reference

#include "OutputFileGranularity.h"

Public Types
enum	BT {   Event, SubRun, Run, InputFile,   Job, Unset }

Public Member Functions
	~Granularity () noexcept
	Granularity (BT const b) noexcept
	Granularity (Granularity const &rhs) noexcept
	Granularity (Granularity &&rhs) noexcept
Granularity &	operator= (Granularity const &rhs) noexcept
Granularity &	operator= (Granularity &&rhs) noexcept
BT	operator() () const
	operator std::size_t () const

Static Public Member Functions
static constexpr std::size_t	NBoundaries ()
static BT	value (std::string const &spec)

Private Attributes
std::atomic< BT >	b_

Detailed Description

Definition at line 13 of file OutputFileGranularity.h.

Member Enumeration Documentation

enum art::Granularity::BT

Enumerator
Event
SubRun
Run
InputFile
Job
Unset

Definition at line 15 of file OutputFileGranularity.h.

{ Event, SubRun, Run, InputFile, Job, Unset };

Constructor & Destructor Documentation

art::Granularity::~Granularity ( )

inlinenoexcept

Definition at line 53 of file OutputFileGranularity.h.

{}

art::Granularity::Granularity ( BT const  b )

inlinenoexcept

Definition at line 54 of file OutputFileGranularity.h.

: b_{b} {}

art::Granularity::Granularity ( Granularity const &  rhs )

inlinenoexcept

Definition at line 55 of file OutputFileGranularity.h.

: b_{rhs.b_.load()} {}

art::Granularity::Granularity ( Granularity &&  rhs )

inlinenoexcept

Definition at line 56 of file OutputFileGranularity.h.

: b_{rhs.b_.load()} {}

Member Function Documentation

static constexpr std::size_t art::Granularity::NBoundaries ( )

inlinestatic

Definition at line 19 of file OutputFileGranularity.h.

References Unset.

    {
      return Unset;
    }

art::Granularity::operator std::size_t ( ) const

inline

Definition at line 78 of file OutputFileGranularity.h.

References b_.

{ return static_cast<std::size_t>(b_.load()); }

BT art::Granularity::operator() ( ) const

inline

Definition at line 74 of file OutputFileGranularity.h.

References b_.

    {
      return b_.load();
    }

Granularity& art::Granularity::operator= ( Granularity const &  rhs )

inlinenoexcept

Definition at line 58 of file OutputFileGranularity.h.

References b_.

    {
      if (this != &rhs) {
        b_ = rhs.b_.load();
      }
      return *this;
    }

Granularity& art::Granularity::operator= ( Granularity &&  rhs )

inlinenoexcept

Definition at line 66 of file OutputFileGranularity.h.

References b_.

    {
      b_ = rhs.b_.load();
      return *this;
    }

static BT art::Granularity::value ( std::string const &  spec )

inlinestatic

Definition at line 24 of file OutputFileGranularity.h.

References art::errors::Configuration, Event, InputFile, Job, Run, SubRun, and Unset.

Referenced by art::ClosingCriteria::ClosingCriteria().

    {
      if (spec == "Event") {
        return Event;
      } else if (spec == "SubRun") {
        return SubRun;
      } else if (spec == "Run") {
        return Run;
      } else if (spec == "InputFile") {
        return InputFile;
      } else if (spec == "Job") {
        return Job;
      } else if (spec == "Unset") {
        return Unset;
      } else {
        throw art::Exception(art::errors::Configuration)
          << "Specified output-file switching boundary (\"" << spec
          << "\") not supported.\n"
             "Please choose from:\n"
             "   \"Event\"\n"
             "   \"SubRun\"\n"
             "   \"Run\"\n"
             "   \"InputFile\"\n"
             "   \"Job\"\n"
             "   \"Unset\"";
      }
    }

Member Data Documentation

std::atomic<BT> art::Granularity::b_

private

Definition at line 81 of file OutputFileGranularity.h.

Referenced by operator std::size_t(), operator()(), and operator=().

---

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

• art/Framework/Core/OutputFileGranularity.h