LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
art::ClosingCriteria::Config Struct Reference

#include "ClosingCriteria.h"

Public Types

using Name = fhicl::Name
 
using Comment = fhicl::Comment
 
template<typename T >
using Atom = fhicl::Atom< T >
 
template<typename T >
using OptionalAtom = fhicl::OptionalAtom< T >
 

Public Attributes

Atom< unsigned > maxEvents {Name("maxEvents"), Defaults::unsigned_max()}
 
Atom< unsigned > maxSubRuns {Name("maxSubRuns"), Defaults::unsigned_max()}
 
Atom< unsigned > maxRuns {Name("maxRuns"), Defaults::unsigned_max()}
 
Atom< unsigned > maxInputFiles
 
Atom< unsigned > maxSize
 
Atom< unsigned > maxAge
 
Atom< std::string > granularity
 

Detailed Description

Definition at line 94 of file ClosingCriteria.h.

Member Typedef Documentation

template<typename T >
using art::ClosingCriteria::Config::Atom = fhicl::Atom<T>

Definition at line 98 of file ClosingCriteria.h.

Definition at line 100 of file ClosingCriteria.h.

Member Data Documentation

Atom<std::string> art::ClosingCriteria::Config::granularity
Initial value:
{
Name("granularity"),
"The 'granularity' parameter specifies the level at which\n"
"a file may be closed, and thereby the granularity of the file.\n"
"The following values are possible:\n\n"
" Value Meaning\n"
" =======================================================\n"
" \"Event\" Allow file switch at next Event\n"
" \"SubRun\" Allow file switch at next SubRun\n"
" \"Run\" Allow file switch at next Run\n"
" \"InputFile\" Allow file switch at next InputFile\n"
" \"Job\" File closes at the end of Job\n\n"
"For example, if a granularity of \"SubRun\" is specified, but the\n"
"file has reached the maximum events written to disk (as specified\n"
"by the 'maxEvents' parameter), switching to a new file will NOT\n"
"happen until a new SubRun has been reached (or there are no more\n"
"Events/SubRuns/Runs to process)."),

Definition at line 113 of file ClosingCriteria.h.

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

Atom<unsigned> art::ClosingCriteria::Config::maxAge
Initial value:
{Name("maxAge"),
Comment("Maximum age of output file (in seconds)"),

Definition at line 109 of file ClosingCriteria.h.

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

Atom<unsigned> art::ClosingCriteria::Config::maxEvents {Name("maxEvents"), Defaults::unsigned_max()}

Definition at line 101 of file ClosingCriteria.h.

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

Atom<unsigned> art::ClosingCriteria::Config::maxInputFiles
Initial value:
{Name("maxInputFiles"),

Definition at line 104 of file ClosingCriteria.h.

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

Atom<unsigned> art::ClosingCriteria::Config::maxRuns {Name("maxRuns"), Defaults::unsigned_max()}

Definition at line 103 of file ClosingCriteria.h.

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

Atom<unsigned> art::ClosingCriteria::Config::maxSize
Initial value:
{Name("maxSize"),
Comment("Maximum size of file (in KiB)"),

Definition at line 106 of file ClosingCriteria.h.

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

Atom<unsigned> art::ClosingCriteria::Config::maxSubRuns {Name("maxSubRuns"), Defaults::unsigned_max()}

Definition at line 102 of file ClosingCriteria.h.

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


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