Classes | Public Types | Static Public Member Functions | Public Attributes | List of all members
art::Scheduler::Config Struct Reference

#include <Scheduler.h>

Classes

struct  DebugConfig
 

Public Types

using Name = fhicl::Name
 
using Comment = fhicl::Comment
 

Static Public Member Functions

static constexpr unsigned kb ()
 
static constexpr unsigned mb ()
 

Public Attributes

fhicl::Atom< unsigned > num_threads {Name{"num_threads"}, 1}
 
fhicl::Atom< ScheduleID::size_typenum_schedules
 
fhicl::Atom< unsigned > stack_size
 
fhicl::Atom< boolhandleEmptyRuns {Name{"handleEmptyRuns"}, true}
 
fhicl::Atom< boolhandleEmptySubRuns {Name{"handleEmptySubRuns"}, true}
 
fhicl::Atom< boolerrorOnMissingConsumes
 
fhicl::Atom< boolerrorOnSIGINT {Name{"errorOnSIGINT"}, true}
 
fhicl::Atom< boolwantSummary {Name{"wantSummary"}, false}
 
fhicl::Atom< boolpruneConfig {Name{"pruneConfig"}, true}
 
fhicl::Atom< boolreportUnused {Name{"reportUnused"}, true}
 
fhicl::Atom< std::stringdataDependencyGraph
 
fhicl::OptionalTable< DebugConfigdebug
 
fhicl::TableFragment< ActionTable::ConfigactionTable {}
 

Detailed Description

Definition at line 17 of file Scheduler.h.

Member Typedef Documentation

using art::Scheduler::Config::Comment = fhicl::Comment

Definition at line 32 of file Scheduler.h.

using art::Scheduler::Config::Name = fhicl::Name

Definition at line 31 of file Scheduler.h.

Member Function Documentation

static constexpr unsigned art::Scheduler::Config::kb ( )
inlinestatic

Definition at line 19 of file Scheduler.h.

20  {
21  return 1024;
22  }
static constexpr unsigned art::Scheduler::Config::mb ( )
inlinestatic

Definition at line 24 of file Scheduler.h.

25  {
26  return kb() * kb();
27  }
static constexpr unsigned kb()
Definition: Scheduler.h:19

Member Data Documentation

fhicl::TableFragment<ActionTable::Config> art::Scheduler::Config::actionTable {}

Definition at line 67 of file Scheduler.h.

fhicl::Atom<std::string> art::Scheduler::Config::dataDependencyGraph
Initial value:
{Name{"dataDependencyGraph"},
{}}

Definition at line 54 of file Scheduler.h.

fhicl::OptionalTable<DebugConfig> art::Scheduler::Config::debug
Initial value:
{
Name{"debug"},
"The entries in the 'debug' table below are filled whenever the\n"
"command-line program options are parsed. Any user-provided values\n"
"will be overriden by the command-line."}}

Definition at line 61 of file Scheduler.h.

fhicl::Atom<bool> art::Scheduler::Config::errorOnMissingConsumes
Initial value:
{Name{"errorOnMissingConsumes"},
false}

Definition at line 48 of file Scheduler.h.

fhicl::Atom<bool> art::Scheduler::Config::errorOnSIGINT {Name{"errorOnSIGINT"}, true}

Definition at line 50 of file Scheduler.h.

fhicl::Atom<bool> art::Scheduler::Config::handleEmptyRuns {Name{"handleEmptyRuns"}, true}

Definition at line 46 of file Scheduler.h.

fhicl::Atom<bool> art::Scheduler::Config::handleEmptySubRuns {Name{"handleEmptySubRuns"}, true}

Definition at line 47 of file Scheduler.h.

fhicl::Atom<ScheduleID::size_type> art::Scheduler::Config::num_schedules
Initial value:
{Name{"num_schedules"},
1}

Definition at line 34 of file Scheduler.h.

fhicl::Atom<unsigned> art::Scheduler::Config::num_threads {Name{"num_threads"}, 1}

Definition at line 33 of file Scheduler.h.

fhicl::Atom<bool> art::Scheduler::Config::pruneConfig {Name{"pruneConfig"}, true}

Definition at line 52 of file Scheduler.h.

fhicl::Atom<bool> art::Scheduler::Config::reportUnused {Name{"reportUnused"}, true}

Definition at line 53 of file Scheduler.h.

fhicl::Atom<unsigned> art::Scheduler::Config::stack_size
Initial value:
{
Name{"stack_size"},
Comment{"The stack size (in bytes) that the TBB scheduler will use for "
"its threads.\n"
"The default stack size TBB specifies is 1 MB, which can be "
"inadequate for\n"
"various workflows. Because of that, art picks a default of "
"10 MB, which\n"
"more closely approximates the stack size of the main thread."},
10 * mb()}

Definition at line 36 of file Scheduler.h.

fhicl::Atom<bool> art::Scheduler::Config::wantSummary {Name{"wantSummary"}, false}

Definition at line 51 of file Scheduler.h.


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