icarus::trigger::FixBeamGateInfo::Config Struct Reference

Classes
struct	ChangeGate
	Settings to change a gate. More...

Public Types
enum	BeamType_t { BeamType_t::kUnknown = sim::kUnknown, BeamType_t::kBNB = sim::kBNB, BeamType_t::kNuMI = sim::kNuMI }
using	Name = fhicl::Name
using	Comment = fhicl::Comment
using	microsecond = util::quantities::points::microsecond
using	microseconds = util::quantities::intervals::microseconds

Static Public Member Functions
static sim::BeamType_t	getBeamType (fhicl::Atom< std::string > const &type)
	Converts a FHiCL atom into a beam type. More...
static std::vector < sim::BeamType_t >	getBeamTypes (fhicl::Sequence< std::string > const &type)
	Converts a FHiCL sequence into a vector of beam types. More...

Public Attributes
fhicl::Atom< art::InputTag >	BeamGateTag
fhicl::Sequence < fhicl::TableAs < BeamChangeRecipe, ChangeGate > >	Changes
fhicl::Atom< bool >	KeepInstanceName
fhicl::Atom< std::string >	OutputInstanceName
fhicl::Atom< std::string >	LogCategory

Static Public Attributes
static util::MultipleChoiceSelection < BeamType_t > const	BeamTypeSelector
	Selector for Type parameter. More...

Detailed Description

Definition at line 149 of file FixBeamGateInfo_module.cc.

Member Typedef Documentation

using icarus::trigger::FixBeamGateInfo::Config::Comment = fhicl::Comment

Definition at line 158 of file FixBeamGateInfo_module.cc.

using icarus::trigger::FixBeamGateInfo::Config::microsecond = util::quantities::points::microsecond

Definition at line 160 of file FixBeamGateInfo_module.cc.

using icarus::trigger::FixBeamGateInfo::Config::microseconds = util::quantities::intervals::microseconds

Definition at line 161 of file FixBeamGateInfo_module.cc.

using icarus::trigger::FixBeamGateInfo::Config::Name = fhicl::Name

Definition at line 157 of file FixBeamGateInfo_module.cc.

Member Enumeration Documentation

enum icarus::trigger::FixBeamGateInfo::Config::BeamType_t

strong

Enumerator
kUnknown
kBNB
kNuMI

Definition at line 151 of file FixBeamGateInfo_module.cc.

                          { // we need to translate enum into a strong type
        kUnknown = sim::kUnknown
      , kBNB     = sim::kBNB
      , kNuMI    = sim::kNuMI
    };

Member Function Documentation

sim::BeamType_t icarus::trigger::FixBeamGateInfo::Config::getBeamType ( fhicl::Atom< std::string > const &  type )

static

Converts a FHiCL atom into a beam type.

Definition at line 550 of file FixBeamGateInfo_module.cc.

{
  try {
    return static_cast<sim::BeamType_t>
      (BeamTypeSelector.parse(type()).value());
  }
  catch (util::MultipleChoiceSelectionBase::UnknownOptionError const& e)
  {
    throw art::Exception(art::errors::Configuration)
      << "Invalid value for '" << type.name()
      << "' parameter: '" << e.label() << "'; valid options: "
      << BeamTypeSelector.optionListString() << ".\n";
  }
} // icarus::trigger::FixBeamGateInfo::Config::getBeamType()

auto icarus::trigger::FixBeamGateInfo::Config::getBeamTypes ( fhicl::Sequence< std::string > const &  type )

static

Converts a FHiCL sequence into a vector of beam types.

Definition at line 568 of file FixBeamGateInfo_module.cc.

{
  std::vector<sim::BeamType_t> beamTypes;
  beamTypes.reserve(types.size());
  for (std::string const& type: types()) {
    try {
      beamTypes.push_back
        (static_cast<sim::BeamType_t>(BeamTypeSelector.parse(type).value()));
    }
    catch (util::MultipleChoiceSelectionBase::UnknownOptionError const& e)
    {
      throw art::Exception(art::errors::Configuration)
        << "Invalid value for '" << types.name()
        << "' parameter: '" << e.label() << "'; valid options: "
        << BeamTypeSelector.optionListString() << ".\n";
    }
  }
  return beamTypes;
} // icarus::trigger::FixBeamGateInfo::Config::getBeamTypes()

Member Data Documentation

fhicl::Atom<art::InputTag> icarus::trigger::FixBeamGateInfo::Config::BeamGateTag

Initial value:

{
      Name{ "BeamGateTag" },
      Comment{ "beam gate data product to operate on" }
      
      }

Definition at line 225 of file FixBeamGateInfo_module.cc.

util::MultipleChoiceSelection< FixBeamGateInfo::Config::BeamType_t > const icarus::trigger::FixBeamGateInfo::Config::BeamTypeSelector

static

Initial value:

{
        { BeamType_t::kUnknown, "unknown" }
      , { BeamType_t::kBNB,     "BNB" }
      , { BeamType_t::kNuMI,    "NuMI" }
    }

Selector for Type parameter.

Definition at line 258 of file FixBeamGateInfo_module.cc.

fhicl::Sequence<fhicl::TableAs<BeamChangeRecipe, ChangeGate> > icarus::trigger::FixBeamGateInfo::Config::Changes

Initial value:

{
      Name{ "Changes" },
      Comment{ "sets of changes to apply to the beam gate" }
      
      }

Definition at line 231 of file FixBeamGateInfo_module.cc.

fhicl::Atom<bool> icarus::trigger::FixBeamGateInfo::Config::KeepInstanceName

Initial value:

{
      Name{ "KeepInstanceName" },
      Comment
        { "output data product has the same instance name as in BeamGateTag" },
      false 
      }

Definition at line 237 of file FixBeamGateInfo_module.cc.

fhicl::Atom<std::string> icarus::trigger::FixBeamGateInfo::Config::LogCategory

Initial value:

{
      Name{ "LogCategory" },
      Comment{ "name of the category used for the output" },
      "FixBeamGateInfo" 
      }

Definition at line 250 of file FixBeamGateInfo_module.cc.

fhicl::Atom<std::string> icarus::trigger::FixBeamGateInfo::Config::OutputInstanceName

Initial value:

{
      Name{ "OutputInstanceName" },
      Comment{ "instance name for the output data product" },
      ""
      }

Definition at line 244 of file FixBeamGateInfo_module.cc.

---

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

• FixBeamGateInfo_module.cc