art::EmptyEvent::Config Struct Reference

Classes
struct	KeysToIgnore

Public Attributes
Atom< std::string >	module_type {Name("module_type")}
TableFragment< ProcessingLimits::Config >	limitsConfig
Atom< int >	numberEventsInRun
Atom< int >	numberEventsInSubRun
Atom< uint32_t >	maxTime
Atom< uint32_t >	eventCreationDelay
Atom< bool >	resetEventOnSubRun {Name("resetEventOnSubRun"), true}
OptionalAtom< RunNumber_t >	firstRun {Name("firstRun")}
OptionalAtom< SubRunNumber_t >	firstSubRun {Name("firstSubRun")}
OptionalAtom< EventNumber_t >	firstEvent {Name("firstEvent")}
OptionalDelegatedParameter	timestampPlugin

Detailed Description

Definition at line 46 of file EmptyEvent_source.cc.

Member Data Documentation

Atom<uint32_t> art::EmptyEvent::Config::eventCreationDelay

Initial value:

{
        Name("eventCreationDelay"),
        Comment("The 'eventCreationDelay' parameter is an integral value\n"
                "in the range [0, 1000000), corresponding to microseconds.\n"
                "If specified, the input source will sleep for the specified "
                "duration\n"
                "of time before each new event, subrun, or run is created.\n"),
        0u}

Definition at line 63 of file EmptyEvent_source.cc.

OptionalAtom<EventNumber_t> art::EmptyEvent::Config::firstEvent {Name("firstEvent")}

Definition at line 74 of file EmptyEvent_source.cc.

OptionalAtom<RunNumber_t> art::EmptyEvent::Config::firstRun {Name("firstRun")}

Definition at line 72 of file EmptyEvent_source.cc.

OptionalAtom<SubRunNumber_t> art::EmptyEvent::Config::firstSubRun {Name("firstSubRun")}

Definition at line 73 of file EmptyEvent_source.cc.

TableFragment<ProcessingLimits::Config> art::EmptyEvent::Config::limitsConfig

Definition at line 48 of file EmptyEvent_source.cc.

Atom<uint32_t> art::EmptyEvent::Config::maxTime

Initial value:

{
        Name("maxTime"),
        Comment(
          "If specified, the 'maxTime' parameter indicates the maximum "
          "allowed\n"
          "wall-clock time (in seconds) for which new events may be created.\n"
          "This option is mutually exclusive with the 'maxEvents' and "
          "'maxSubRuns'\n"
          "configuration parameters."),
        std::numeric_limits<uint32_t>::max()}

Definition at line 53 of file EmptyEvent_source.cc.

Atom<std::string> art::EmptyEvent::Config::module_type {Name("module_type")}

Definition at line 47 of file EmptyEvent_source.cc.

Atom<int> art::EmptyEvent::Config::numberEventsInRun

Initial value:

{Name("numberEventsInRun"),
                                  limitsConfig().maxEvents()}

Definition at line 49 of file EmptyEvent_source.cc.

Atom<int> art::EmptyEvent::Config::numberEventsInSubRun

Initial value:

{Name("numberEventsInSubRun"),
                                     limitsConfig().maxSubRuns()}

Definition at line 51 of file EmptyEvent_source.cc.

Atom<bool> art::EmptyEvent::Config::resetEventOnSubRun {Name("resetEventOnSubRun"), true}

Definition at line 71 of file EmptyEvent_source.cc.

OptionalDelegatedParameter art::EmptyEvent::Config::timestampPlugin

Initial value:

{
        Name("timestampPlugin"),
        Comment(
          "The 'timestampPlugin' parameter must be a FHiCL table\n"
          "of the form:\n\n"
          "  timestampPlugin: {\n"
          "    plugin_type: <plugin specification>\n"
          "    ...\n"
          "  }\n\n"
          "See the notes in art/Framework/Core/EmptyEventTimestampPlugin.h\n"
          "for more details.")}

Definition at line 75 of file EmptyEvent_source.cc.

---

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

• art/Framework/Modules/EmptyEvent_source.cc