artdaq  v3_09_01
artdaq::CommandableFragmentGenerator::Config Struct Reference

Configuration of the CommandableFragmentGenerator. May be used for parameter validation More...

#include <artdaq/Generators/CommandableFragmentGenerator.hh>

Public Attributes

fhicl::Atom< std::string > generator_type {fhicl::Name{"generator"}, fhicl::Comment{"Name of the CommandableFragmentGenerator plugin to load"}}
 "generator" (REQUIRED) Name of the CommandableFragmentGenerator plugin to load
 
fhicl::Atom< Fragment::type_t > expected_fragment_type {fhicl::Name{"expected_fragment_type"}, fhicl::Comment{"The type of Fragments this CFG will be generating. \"Empty\" will auto-detect type based on Fragments generated."}, Fragment::type_t(Fragment::EmptyFragmentType)}
 "expected_fragment_type" (Default: 231, EmptyFragmentType) : The type of Fragments this CFG will be generating. "Empty" will auto - detect type based on Fragments generated.
 
fhicl::Atom< size_t > sleep_on_no_data_us {fhicl::Name{"sleep_on_no_data_us"}, fhicl::Comment{"How long to sleep after calling getNext_ if no data is returned"}, 0}
 "sleep_on_no_data_us" (Default: 0 (no sleep)) : How long to sleep after calling getNext_ if no data is returned
 
fhicl::Atom< bool > separate_monitoring_thread {fhicl::Name{"separate_monitoring_thread"}, fhicl::Comment{"Whether a thread that calls the checkHWStatus_ method should be created"}, false}
 "separate_monitoring_thread" (Default: false) : Whether a thread that calls the checkHWStatus_ method should be created
 
fhicl::Atom< int64_t > hardware_poll_interval_us {fhicl::Name{"hardware_poll_interval_us"}, fhicl::Comment{"If a separate monitoring thread is used, how often should it call checkHWStatus_"}, 0}
 "hardware_poll_interval_us" (Default: 0) : If a separate monitoring thread is used, how often should it call checkHWStatus_
 
fhicl::Atom< int > board_id {fhicl::Name{"board_id"}, fhicl::Comment{"The identification number for this CommandableFragmentGenerator"}}
 "board_id" (REQUIRED) : The identification number for this CommandableFragmentGenerator
 
fhicl::Sequence
< Fragment::fragment_id_t > 
fragment_ids {fhicl::Name("fragment_ids"), fhicl::Comment("A list of Fragment IDs created by this CommandableFragmentGenerator")}
 
fhicl::Atom< int > fragment_id {fhicl::Name{"fragment_id"}, fhicl::Comment{"The Fragment ID created by this CommandableFragmentGenerator"}, -99}
 
fhicl::Atom< int > sleep_on_stop_us {fhicl::Name{"sleep_on_stop_us"}, fhicl::Comment{"How long to sleep before returning when stop transition is called"}, 0}
 "sleep_on_stop_us" (Default: 0) : How long to sleep before returning when stop transition is called
 

Detailed Description

Configuration of the CommandableFragmentGenerator. May be used for parameter validation

Definition at line 78 of file CommandableFragmentGenerator.hh.

Member Data Documentation

fhicl::Atom<int> artdaq::CommandableFragmentGenerator::Config::fragment_id {fhicl::Name{"fragment_id"}, fhicl::Comment{"The Fragment ID created by this CommandableFragmentGenerator"}, -99}

"fragment_id" (Default: -99) : The Fragment ID created by this CommandableFragmentGenerator Note that only one of fragment_ids and fragment_id should be specified in the configuration

Definition at line 97 of file CommandableFragmentGenerator.hh.

fhicl::Sequence<Fragment::fragment_id_t> artdaq::CommandableFragmentGenerator::Config::fragment_ids {fhicl::Name("fragment_ids"), fhicl::Comment("A list of Fragment IDs created by this CommandableFragmentGenerator")}

"fragment_ids" (Default: empty vector) : A list of Fragment IDs created by this CommandableFragmentGenerator Note that only one of fragment_ids and fragment_id should be specified in the configuration

Definition at line 94 of file CommandableFragmentGenerator.hh.


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