fhicl::ParameterSet Class Reference

#include "ParameterSet.h"

Public Types
using	ps_atom_t = fhicl::detail::ps_atom_t
using	ps_sequence_t = fhicl::detail::ps_sequence_t
using	annot_t = std::unordered_map< std::string, std::string >

Public Member Functions
bool	is_empty () const
ParameterSetID	id () const
std::string	to_string () const
std::string	to_compact_string () const
std::string	to_indented_string () const
std::string	to_indented_string (unsigned initial_indent_level) const
std::string	to_indented_string (unsigned initial_indent_level, bool annotate) const
std::string	to_indented_string (unsigned initial_indent_level, detail::print_mode pm) const
std::vector< std::string >	get_names () const
std::vector< std::string >	get_pset_names () const
std::vector< std::string >	get_all_keys () const
bool	has_key (std::string const &key) const
bool	is_key_to_table (std::string const &key) const
bool	is_key_to_sequence (std::string const &key) const
bool	is_key_to_atom (std::string const &key) const
template<class T >
std::optional< T >	get_if_present (std::string const &key) const
template<class T , class Via >
std::optional< T >	get_if_present (std::string const &key, T convert(Via const &)) const
template<class T >
bool	get_if_present (std::string const &key, T &value) const
template<class T , class Via >
bool	get_if_present (std::string const &key, T &value, T convert(Via const &)) const
template<class T >
T	get (std::string const &key) const
template<class T , class Via >
T	get (std::string const &key, T convert(Via const &)) const
template<class T >
T	get (std::string const &key, T const &default_value) const
template<class T , class Via >
T	get (std::string const &key, T const &default_value, T convert(Via const &)) const
std::string	get_src_info (std::string const &key) const
void	walk (ParameterSetWalker &psw) const
void	put (std::string const &key)
template<class T >
void	put (std::string const &key, T const &value)
void	put_or_replace (std::string const &key)
template<class T >
void	put_or_replace (std::string const &key, T const &value)
template<class T >
void	put_or_replace_compatible (std::string const &key, T const &value)
bool	erase (std::string const &key)
bool	operator== (ParameterSet const &other) const
bool	operator!= (ParameterSet const &other) const
template<>
void	put (std::string const &key, fhicl::extended_value const &value)

Static Public Member Functions
static ParameterSet	make (intermediate_table const &tbl)
static ParameterSet	make (extended_value const &xval)
static ParameterSet	make (std::string const &str)
static ParameterSet	make (std::string const &filename, cet::filepath_maker &maker)

Private Types
using	map_t = std::map< std::string, std::any >
using	map_iter_t = map_t::const_iterator

Private Member Functions
void	insert_ (std::string const &key, std::any const &value)
void	insert_or_replace_ (std::string const &key, std::any const &value)
void	insert_or_replace_compatible_ (std::string const &key, std::any const &value)
std::string	to_string_ (bool compact=false) const
std::string	stringify_ (std::any const &a, bool compact=false) const
bool	key_is_type_ (std::string const &key, std::function< bool(std::any const &)> func) const
template<class T >
std::optional< T >	get_one_ (std::string const &key) const
bool	find_one_ (std::string const &key) const
std::optional< ParameterSet >	descend_ (std::vector< std::string > const &names) const

Private Attributes
map_t	mapping_
annot_t	srcMapping_
ParameterSetID	id_

Detailed Description

Definition at line 36 of file ParameterSet.h.

Member Typedef Documentation

using fhicl::ParameterSet::annot_t = std::unordered_map<std::string, std::string>

Definition at line 40 of file ParameterSet.h.

using fhicl::ParameterSet::map_iter_t = map_t::const_iterator

private

Definition at line 123 of file ParameterSet.h.

using fhicl::ParameterSet::map_t = std::map<std::string, std::any>

private

Definition at line 122 of file ParameterSet.h.

using fhicl::ParameterSet::ps_atom_t = fhicl::detail::ps_atom_t

Definition at line 38 of file ParameterSet.h.

using fhicl::ParameterSet::ps_sequence_t = fhicl::detail::ps_sequence_t

Definition at line 39 of file ParameterSet.h.

Member Function Documentation

std::optional< ParameterSet > ParameterSet::descend_ ( std::vector< std::string > const &  names ) const

private

Definition at line 223 of file ParameterSet.cc.

References util::empty().

{
  if (empty(names)) {
    return std::make_optional(*this);
  }
  ParameterSet const* p{this};
  std::optional<ParameterSet> result;
  for (auto const& name : names) {
    if (!p->find_one_(name)) {
      return std::nullopt;
    }
    if (!p->is_key_to_table(name)) {
      return std::nullopt;
    }

    if (result = p->get_one_<ParameterSet>(name); not result) {
      return std::nullopt;
    }
    p = &result.value();
  }
  return result;
}

bool ParameterSet::erase

(

std::string const &

key

)

Definition at line 338 of file ParameterSet.cc.

{
  bool const did_erase{1u == mapping_.erase(key)};
  id_.invalidate();
  return did_erase;
}

bool ParameterSet::find_one_ ( std::string const &  key ) const

private

Definition at line 209 of file ParameterSet.cc.

References fhicl::detail::find_an_any(), and fhicl::detail::get_sequence_indices().

{
  auto skey = detail::get_sequence_indices(simple_key);

  auto it = mapping_.find(skey.name());
  if (it == mapping_.end()) {
    return false;
  }

  auto a = it->second;
  return detail::find_an_any(skey.indices().cbegin(), skey.indices().cend(), a);
}

template<class T >

T fhicl::ParameterSet::get

(

std::string const &

key

)

const

Definition at line 314 of file ParameterSet.h.

References fhicl::cant_find.

Referenced by pmtana::AlgoCFD::AlgoCFD(), pmtana::AlgoFixedWindow::AlgoFixedWindow(), pmtana::AlgoSiPM::AlgoSiPM(), pmtana::AlgoSlidingWindow::AlgoSlidingWindow(), pmtana::AlgoThreshold::AlgoThreshold(), artg4tk::artg4tkMain::artg4tkMain(), fhicl::detail::ValuePrinter::before_action(), fhicl::detail::Prettifier::before_action(), artg4tk::CheckDRCalorimeterHits::beginJob(), cluster::BlurredClusteringAlg::BlurredClusteringAlg(), reco_tool::CandHitDerivative::CandHitDerivative(), reco_tool::CandHitMorphological::CandHitMorphological(), wc::CellTree::CellTree(), cheat::CheckBackTracking::CheckBackTracking(), pid::Chi2PIDAlg::Chi2PIDAlg(), cluster::ClusterCrawlerAlg::ClusterCrawlerAlg(), ClusteringValidation::ClusteringValidation::ClusteringValidation(), cluster::ClusterMatchAlg::ClusterMatchAlg(), cluster::ClusterMatchTQ::ClusterMatchTQ(), altns::ExampleAction::Config(), mf::service::ELdestination::Category::Config::Config(), trigger::TriggerAlgoBase::Config(), evwgh::PPFXCVWeightCalc::Configure(), evwgh::PPFXMIPPKaonWeightCalc::Configure(), evwgh::PPFXMIPPPionWeightCalc::Configure(), evwgh::PPFXOtherWeightCalc::Configure(), evwgh::PPFXTargAttenWeightCalc::Configure(), evwgh::PPFXThinKaonWeightCalc::Configure(), evwgh::PPFXThinMesonWeightCalc::Configure(), evwgh::PPFXThinNucAWeightCalc::Configure(), evwgh::PPFXThinNucWeightCalc::Configure(), evwgh::PPFXThinPionWeightCalc::Configure(), evwgh::PPFXTotAbsorpWeightCalc::Configure(), evwgh::PPFXWeightCalc::Configure(), evwgh::PPFXThinNeutronPionWeightCalc::Configure(), evd_tool::ICARUSDrawer::configure(), evd_tool::MicroBooNEDrawer::configure(), evdb_tool::DrawGausHits::configure(), spacecharge::SpaceChargeStandard::Configure(), lar_cluster3d::ClusterParamsBuilder::configure(), evwgh::WeightManager::Configure(), lar_cluster3d::DBScanAlg::configure(), lar_cluster3d::ClusterMergeAlg::configure(), lar_cluster3d::ClusterPathFinder::configure(), lar_cluster3d::ConvexHullPathFinder::configure(), lar_cluster3d::VoronoiPathFinder::configure(), lar_cluster3d::MinSpanTreeAlg::configure(), lar_cluster3d::kdTree::configure(), lar_cluster3d::MSTPathFinder::configure(), lar_cluster3d::SpacePointHit3DBuilder::configure(), evd_tool::ProtoDUNEDrawer::configure(), evd_tool::StandardDrawer::configure(), trk::TrackContainmentAlg::Configure(), detinfo::LArPropertiesStandard::Configure(), lar_cluster3d::StandardHit3DBuilder::configure(), lar_cluster3d::SnippetHit3DBuilder::configure(), rndm::details::PerEventPolicy< SEED >::configure(), evwgh::GenieWeightCalc::Configure(), lar_pandora::LArPandora::ConstructHitCollectionToolParameterSet(), corner::CornerFinderAlg::CornerFinderAlg(), trkf::CosmicTrackerAlg::CosmicTrackerAlg(), art::PathManager::createModulesAndWorkers(), testing::GeometryTesterEnvironment< ConfigurationClass >::CreateNewGeometry(), rndm::details::AutoIncrementPolicy< SEED >::createSeed(), rndm::details::LinearMappingPolicy< SEED >::createSeed(), rndm::details::PredefinedOffsetPolicy< SEED >::createSeed(), evgb::CRYHelper::CRYHelper(), art::EventSelector::data_for(), cluster::DBScanAlg::DBScanAlg(), evgen::Decay0Gen::Decay0Gen(), DECLARE_ART_SERVICE_INTERFACE_IMPL(), fhicl::decompose_parameterset(), apa::DisambigAlg::DisambigAlg(), evd::Display3DPad::Display3DPad(), fhicl::PrinterFor< T >::do_atomic_print(), fhicl::OptionalSequence< T, N >::do_preset_value(), fhicl::Sequence< float, 3u >::do_preset_value(), fhicl::OptionalSequence< T,-1ull >::do_preset_value(), fhicl::Sequence< T,-1ull >::do_preset_value(), fhicl::PrinterFor< T >::do_sequence_print(), fhicl::Atom< T >::do_set_value(), artg4tk::ArtG4tkModelConfig::DoFill(), evdb_tool::DrawSimEnergyDeposit3D::DrawSimEnergyDeposit3D(), cluster::EndPointAlg::EndPointAlg(), art::detail::ensure_only_one_thread(), art::EventProcessor::EventProcessor(), vertex::FeatureVertexFinderAna::FeatureVertexFinderAna(), opdet::FIFOHistogramAna::FIFOHistogramAna(), artg4tk::ArtG4tkModelConfig::Fill(), opdet::SimPhotonCounterAlg::FillRanges(), hit::GausHitFinder::GausHitFinder(), hit::GausHitFinderAna::GausHitFinderAna(), phot::PropagationTimeModel::generateVUVParams(), geo::Geometry::Geometry(), evd::DrawingPad::GeometryDraw(), fhicl::DelegatedParameter::get(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), rndm::details::PerInstancePolicy< SEED >::getInstanceSeed(), artg4tk::RunSettingsService::getSettings(), hit::HitAnaModule::HitAnaModule(), hit::HitFinderAna::HitFinderAna(), cluster::HoughBaseAlg::HoughBaseAlg(), lar_cluster3d::HoughSeedFinderAlg::HoughSeedFinderAlg(), fluxr::DK2NuInterface::Init(), larg4::ISCalcAna::ISCalcAna(), detsim::ISCalculationSeparate::ISCalculationSeparate(), detinfo::DetectorPropertiesServiceStandard::isDetectorPropertiesServiceStandard(), opdet::SimPhotonCounter::isVisible(), trkf::KalmanFilterAlg::KalmanFilterAlg(), larg4::LArG4Ana::LArG4Ana(), larg4::LArG4DetectorService::LArG4DetectorService(), sim::LArG4Parameters::LArG4Parameters(), lar_pandora::LArPandoraEventDump::LArPandoraEventDump(), reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation(), detinfo::LArPropertiesStandard::LArPropertiesStandard(), larg::LArSimChannelAna::LArSimChannelAna(), sim::LArVoxelCalculator::LArVoxelCalculator(), opdet::LEDCalibrationAna::LEDCalibrationAna(), hit::MagDriftAna::MagDriftAna(), art::InputSourceFactory::make(), art::make_tool(), art::EmptyEvent::makePlugin_(), rndm::details::makeRandomSeedPolicy(), art::detail::ServiceCacheEntry::makeService(), hit::MCHitAnaExample::MCHitAnaExample(), sim::MCRecoEdep::MCRecoEdep(), sim::MCShowerRecoPart::MCShowerRecoPart(), sim::MCTrackRecoAlg::MCTrackRecoAlg(), art::PathManager::moduleInformation_(), ems::MultiEMShowers::MultiEMShowers(), DUNE::MuonTrackingEff::MuonTrackingEff(), mvapid::MVAAlg::MVAAlg(), DUNE::NeutrinoShowerEff::NeutrinoShowerEff(), DUNE::NeutrinoTrackingEff::NeutrinoTrackingEff(), evgen::NueAr40CCGenerator::NueAr40CCGenerator(), opdet::OpDigiAna::OpDigiAna(), opdet::OpDigiProperties::OpDigiProperties(), opdet::OpFlashAna::OpFlashAna(), opdet::OpFlashMCTruthAna::OpFlashMCTruthAna(), opdet::OpFlashSimpleAna::OpFlashSimpleAna(), opdet::OpHitAna::OpHitAna(), opreco::OpticalRecoAna::OpticalRecoAna(), lar_cluster3d::ParallelHitsSeedFinderAlg::ParallelHitsSeedFinderAlg(), testing::BasicTesterEnvironment< ConfigurationClass >::ParseEnvironmentOptions(), cheat::ParticleInventoryService::ParticleInventoryService(), lar_cluster3d::PCASeedFinderAlg::PCASeedFinderAlg(), phot::PDFastSimPAR::PDFastSimPAR(), reco_tool::PeakFitterGaussElimination::PeakFitterGaussElimination(), pmtana::PedAlgoEdges::PedAlgoEdges(), pmtana::PedAlgoRmsSlider::PedAlgoRmsSlider(), pmtana::PedAlgoRollingMean::PedAlgoRollingMean(), pmtana::PedAlgoUB::PedAlgoUB(), opdet::PhotonInf::PhotonInf(), phot::PhotonLibraryAnalyzer::PhotonLibraryAnalyzer(), phot::PhotonVisibilityService::PhotonVisibilityService(), pmtana::PMTAna::PMTAna(), detinfo::DetectorPropertiesServiceStandard::postOpenFile(), fluxr::PPFXFluxReader::PPFXFluxReader(), lar_cluster3d::PrincipalComponentsAlg::PrincipalComponentsAlg(), art::detail::print_config_summary(), art::detail::print_module_types(), art::detail::print_service_types(), phot::PropagationTimeModel::PropagationTimeModel(), art::ProvenanceDumper< DETAIL, Enable >::ProvenanceDumper(), cheat::RecoCheckAna::RecoCheckAna(), wcls::WireCellToolkit::reconfigure(), evd::AnalysisDrawingOptions::reconfigure(), evd::ColorDrawingOptions::reconfigure(), evd::RecoDrawingOptions::reconfigure(), evd::EvdLayoutOptions::reconfigure(), evd::SimulationDrawingOptions::reconfigure(), evdb::Colors::reconfigure(), nutools::dbi::DBIService::reconfigure(), evdb::EventDisplay::reconfigure(), mag::MagneticFieldStandard::reconfigure(), trkf::StitchAlg::reconfigure(), tss::Segmentation2D::reconfigure(), trkf::SeedFinderAlgorithm::reconfigure(), lar_pandora::PFParticleTrackAna::reconfigure(), lar_pandora::PFParticleValidation::reconfigure(), lar_pandora::PFParticleCosmicAna::reconfigure(), lar_pandora::PFParticleAnalysis::reconfigure(), lar_pandora::PFParticleMonitoring::reconfigure(), lar_pandora::ConsolidatedPFParticleAnalysisTemplate::reconfigure(), lar_pandora::PFParticleHitDumper::reconfigure(), t0::IndirectHitParticleAssns::reconfigure(), lar_cluster3d::SkeletonAlg::reconfigure(), lariov::SIOVPmtGainProvider::Reconfigure(), evd::RawDrawingOptions::reconfigure(), phot::PhotonVisibilityService::reconfigure(), t0::DirectHitParticleAssns::reconfigure(), noisefilteralg::WireCellNoiseFilter::reconfigure(), lariov::SIOVElectronicsCalibProvider::Reconfigure(), lariov::DatabaseRetrievalAlg::Reconfigure(), util::DatabaseUtil::reconfigure(), evd::InfoTransfer::reconfigure(), rwgt::ReweightAna::reconfigure(), lcvn::ICVNZlibMaker::reconfigure(), lcvn::LArNuCVNZlibMaker::reconfigure(), lariov::DetPedestalRetrievalAlg::Reconfigure(), cluster::MergeClusterAlg::reconfigure(), hit::CCHitFinderAlg::reconfigure(), shower::TrackShowerSeparationAlg::reconfigure(), evdb::ServiceTable::RegisterService(), hit::RFFHitFinderAlg::RFFHitFinderAlg(), art::RPManager::RPManager(), art::run_art(), dnn::SavePiMu::SavePiMu(), evdb::ScanOptions::ScanOptions(), phot::ScintTimeLAr::ScintTimeLAr(), fhicl::detail::TableBase::select_pset(), testing::BasicTesterEnvironment< ConfigurationClass >::ServiceParameters(), lar::standalone::SetupGeometry(), lar::standalone::SetupGeometryWithChannelMapping(), lar::standalone::SetupMessageFacility(), ShowerRecoTools::ShowerBayesianTrucatingdEdx::ShowerBayesianTrucatingdEdx(), shower::ShowerEnergyAlg::ShowerEnergyAlg(), ShowerQuality::ShowerQuality(), shwf::ShowerReco::ShowerReco(), detsim::SimDriftedElectronClusterAna::SimDriftedElectronClusterAna(), opdet::SimPhotonCounterAlg::SimPhotonCounterAlg(), lariov::SimpleChannelStatus::SimpleChannelStatus(), detsim::SimWireAna::SimWireAna(), lariov::SIOVChannelStatusProvider::SIOVChannelStatusProvider(), cluster::SmallClusterFinderAlg::SmallClusterFinderAlg(), evdb_tool::SpacePoint3DDrawerHitAsymmetry::SpacePoint3DDrawerHitAsymmetry(), evdb_tool::SpacePoint3DDrawerHitCharge::SpacePoint3DDrawerHitCharge(), trkf::SpacePointAlg::SpacePointAlg(), sppt::SpacePointAlg_TimeSort::SpacePointAlg_TimeSort(), evgen::SpectrumVolumeGen::SpectrumVolumeGen(), rndm::details::AutoIncrementPolicy< SEED >::static_configure(), rndm::details::LinearMappingPolicy< SEED >::static_configure(), rndm::details::PredefinedOffsetPolicy< SEED >::static_configure(), shower::TCShowerElectronLikelihood::TCShowerElectronLikelihood(), testing::BasicTesterEnvironment< ConfigurationClass >::TesterParameters(), phot::TFLoaderMLP::TFLoaderMLP(), trkf::Track3DKalmanHitAlg::Track3DKalmanHitAlg(), calo::TrackCalorimetryAlg::TrackCalorimetryAlg(), trk::TrackContainmentAnalyzer::TrackContainmentAnalyzer(), tca::TrajClusterAlg::TrajClusterAlg(), lartriton::TritonClient::TritonClient(), evdb::Colors::UnpackColorScale(), evdb::ParameterSetEditRow::UnpackParameter(), wavdenoise_tool::WaveformDenoiseTf::WaveformDenoiseTf(), wavrec_tool::WaveformRecogTf::WaveformRecogTf(), wframerec_tool::WireframeRecogTf::WireframeRecogTf(), and cheat::PhotonBackTracker::~PhotonBackTracker().

{
  auto result = get_if_present<T>(key);
  return result ? *result : throw fhicl::exception(cant_find, key);
}

template<class T , class Via >

T fhicl::ParameterSet::get	(	std::string const &	key,
		T	convertVia const &
	)		const

Definition at line 322 of file ParameterSet.h.

References fhicl::cant_find.

{
  auto result = get_if_present<T>(key, convert);
  return result ? *result : throw fhicl::exception(cant_find, key);
}

template<class T >

T fhicl::ParameterSet::get	(	std::string const &	key,
		T const &	default_value
	)		const

Definition at line 330 of file ParameterSet.h.

{
  auto result = get_if_present<T>(key);
  return result ? *result : default_value;
}

template<class T , class Via >

T fhicl::ParameterSet::get	(	std::string const &	key,
		T const &	default_value,
		T	convertVia const &
	)		const

Definition at line 338 of file ParameterSet.h.

{
  auto result = get_if_present<T>(key, convert);
  return result ? *result : default_value;
}

vector< string > ParameterSet::get_all_keys

(

)

const

Definition at line 201 of file ParameterSet.cc.

References fhicl::detail::KeyAssembler::result().

Referenced by evwgh::GenieWeightCalc::Configure().

{
  KeyAssembler ka;
  walk(ka);
  return ka.result();
}

template<class T >

std::optional< T > fhicl::ParameterSet::get_if_present

(

std::string const &

key

)

const

Definition at line 267 of file ParameterSet.h.

References fhicl::detail::get_names().

Referenced by rndm::details::RangeCheckHelper< SEED >::configure(), rndm::details::RandomPolicy< SEED >::configure(), rndm::details::RandomPolicy< SEED >::createSeed(), rndm::details::LinearMappingPolicy< SEED >::createSeed(), evgen::Decay0Gen::Decay0Gen(), fhicl::Atom< T >::do_set_value(), fhicl::OptionalAtom< T >::do_set_value(), mf::service::ELdestination::ELdestination(), art::detail::ensure_only_one_thread(), evgen::GENIEGen::GENIEGen(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), rndm::details::PerInstancePolicy< SEED >::getInstanceSeed(), fhicl::detail::TableBase::maybe_select_pset(), rndm::NuRandomService::readSeedParameter(), testing::ProviderSetupClass< detinfo::LArPropertiesStandard >::setup(), testing::ProviderSetupClass< detinfo::DetectorClocksStandard >::setup(), testing::ProviderSetupClass< detinfo::DetectorPropertiesStandard >::setup(), testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility(), evgen::SpectrumVolumeGen::SpectrumVolumeGen(), rndm::details::LinearMappingPolicy< SEED >::static_configure(), and tca::TrajClusterAlg::TrajClusterAlg().

{
  auto keys = detail::get_names(key);
  if (auto ps = descend_(keys.tables())) {
    return ps->get_one_<T>(keys.last());
  }
  return std::nullopt;
}

template<class T , class Via >

std::optional< T > fhicl::ParameterSet::get_if_present	(	std::string const &	key,
		T	convertVia const &
	)		const

Definition at line 278 of file ParameterSet.h.

{
  auto go_between = get_if_present<Via>(key);
  if (not go_between) {
    return std::nullopt;
  }
  return std::make_optional(convert(*go_between));
} // get_if_present<>()

template<class T >

bool fhicl::ParameterSet::get_if_present	(	std::string const &	key,
		T &	value
	)		const

Definition at line 290 of file ParameterSet.h.

{
  if (auto present_parameter = get_if_present<T>(key)) {
    value = *present_parameter;
    return true;
  }
  return false;
}

template<class T , class Via >

bool fhicl::ParameterSet::get_if_present	(	std::string const &	key,
		T &	value,
		T	convertVia const &
	)		const

Definition at line 301 of file ParameterSet.h.

{
  if (auto present_parameter = get_if_present<T>(key, convert)) {
    result = *present_parameter;
    return true;
  }
  return false;
} // get_if_present<>()

vector< string > ParameterSet::get_names

(

)

const

Definition at line 179 of file ParameterSet.cc.

Referenced by artg4tk::CheckDRCalorimeterHits::analyze(), fhicl::decompose_parameterset(), artg4tk::ArtG4tkModelConfig::Fill(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), evdb::ParameterSetEditFrame::ParameterSetEditFrame(), art::detail::print_module_types(), art::detail::print_service_types(), art::detail::print_table_numbers(), and art::RPManager::RPManager().

{
  vector<string> keys;
  cet::transform_all(mapping_, std::back_inserter(keys), [](auto const& pr) {
    return pr.first;
  });
  return keys;
}

template<class T >

std::optional< T > fhicl::ParameterSet::get_one_ ( std::string const &  key ) const

private

Definition at line 364 of file ParameterSet.h.

References fhicl::cant_find, util::quantities::concepts::decode(), e, fhicl::detail::find_an_any(), fhicl::detail::get_sequence_indices(), fhicl::type_mismatch, and value.

{
  T value;
  try {
    auto skey = detail::get_sequence_indices(key);

    map_iter_t it = mapping_.find(skey.name());
    if (it == mapping_.end()) {
      return std::nullopt;
    }

    auto a = it->second;
    if (!detail::find_an_any(
          skey.indices().cbegin(), skey.indices().cend(), a)) {
      throw fhicl::exception(error::cant_find);
    }

    using detail::decode;
    decode(a, value);
    return std::make_optional(value);
  }
  catch (fhicl::exception const& e) {
    std::ostringstream errmsg;
    errmsg << "\nUnsuccessful attempt to convert FHiCL parameter '" << key
           << "' to type '" << cet::demangle_symbol(typeid(value).name())
           << "'.\n\n"
           << "[Specific error:]";
    throw fhicl::exception(type_mismatch, errmsg.str(), e);
  }
  catch (std::exception const& e) {
    std::ostringstream errmsg;
    errmsg << "\nUnsuccessful attempt to convert FHiCL parameter '" << key
           << "' to type '" << cet::demangle_symbol(typeid(value).name())
           << "'.\n\n"
           << "[Specific error:]\n"
           << e.what() << "\n\n";
    throw fhicl::exception(type_mismatch, errmsg.str());
  }
}

vector< string > ParameterSet::get_pset_names

(

)

const

Definition at line 189 of file ParameterSet.cc.

References fhicl::detail::is_table(), and value.

Referenced by evd::Display3DPad::Display3DPad(), mf::service::ELdestination::ELdestination(), and hit::GausHitFinder::GausHitFinder().

{
  vector<string> keys;
  for (auto const& [key, value] : mapping_) {
    if (is_table(value)) {
      keys.push_back(key);
    }
  }
  return keys;
}

std::string ParameterSet::get_src_info

(

std::string const &

key

)

const

Definition at line 257 of file ParameterSet.cc.

Referenced by fhicl::detail::PrettifierAnnotated::before_action(), fhicl::detail::PrettifierPrefixAnnotated::before_action(), and fhicl::detail::ValidateThenSet::delegated_parameter().

{
  auto result = srcMapping_.find(key);
  return result != srcMapping_.cend() ? result->second : "";
}

bool ParameterSet::has_key

(

std::string const &

key

)

const

Definition at line 247 of file ParameterSet.cc.

References fhicl::detail::get_names().

Referenced by fhicl::detail::ValidateThenSet::before_action(), cluster::ClusterCrawlerAlg::ClusterCrawlerAlg(), spacecharge::SpaceChargeStandard::Configure(), lar_pandora::LArPandora::ConstructHitCollectionToolParameterSet(), geo::Geometry::Geometry(), rndm::details::PerInstancePolicy< SEED >::getInstanceSeed(), detinfo::DetectorClocksStandard::IsRightConfig(), phot::PhotonVisibilityService::PhotonVisibilityService(), evd::RecoDrawingOptions::reconfigure(), hit::CCHitFinderAlg::reconfigure(), art::run_art(), and tca::TrajClusterAlg::TrajClusterAlg().

{
  auto keys = detail::get_names(key);
  auto ps = descend_(keys.tables());
  return ps ? ps->find_one_(keys.last()) : false;
}

ParameterSetID ParameterSet::id

(

)

const

Definition at line 153 of file ParameterSet.cc.

References fhicl::ParameterSetID::reset().

Referenced by fhicl::decompose_parameterset(), art::EventProcessor::EventProcessor(), art::Source< T >::finishProductRegistration_(), art::PathManager::makeTriggerResultsInserter_(), art::PathManager::moduleInformation_(), operator==(), and art::RPManager::RPManager().

{
  if (!id_.is_valid()) {
    id_.reset(*this);
  }
  return id_;
}

void ParameterSet::insert_ ( std::string const &  key, std::any const &  value  )

private

Definition at line 290 of file ParameterSet.cc.

References fhicl::cant_insert.

{
  check_put_local_key(key);
  if (!mapping_.emplace(key, value).second) {
    throw exception(cant_insert) << "key " << key << " already exists.";
  }
  id_.invalidate();
}

void ParameterSet::insert_or_replace_ ( std::string const &  key, std::any const &  value  )

private

Definition at line 300 of file ParameterSet.cc.

References value.

{
  check_put_local_key(key);
  mapping_[key] = value;
  id_.invalidate();
}

void ParameterSet::insert_or_replace_compatible_ ( std::string const &  key, std::any const &  value  )

private

Definition at line 308 of file ParameterSet.cc.

References fhicl::cant_insert, fhicl::detail::is_nil(), fhicl::detail::is_sequence(), fhicl::detail::is_table(), and value.

{
  check_put_local_key(key);
  auto item = mapping_.find(key);
  if (item == mapping_.end()) {
    insert_(key, value);
    return;
  } else {
    if (!detail::is_nil(value)) {
      auto is_non_nil_atom = [](any const& v) {
        return !(detail::is_sequence(v) || detail::is_table(v) ||
                 detail::is_nil(v));
      };
      if (detail::is_sequence(item->second) && !detail::is_sequence(value)) {
        throw exception(cant_insert)
          << "can't use non-sequence to replace sequence.";
      } else if (detail::is_table(item->second) && !detail::is_table(value)) {
        throw exception(cant_insert) << "can't use non-table to replace table.";
      } else if (is_non_nil_atom(item->second) &&
                 (detail::is_sequence(value) || detail::is_table(value))) {
        throw exception(cant_insert)
          << "can't use non-atom to replace non-nil atom.";
      }
    }
    item->second = value;
  }
  id_.invalidate();
}

bool ParameterSet::is_empty

(

)

const

Definition at line 147 of file ParameterSet.cc.

{
  return mapping_.empty();
}

bool fhicl::ParameterSet::is_key_to_atom ( std::string const &  key ) const

inline

Definition at line 220 of file ParameterSet.h.

References fhicl::detail::is_sequence(), and fhicl::detail::is_table().

Referenced by rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), and rndm::details::PerInstancePolicy< SEED >::getInstanceSeed().

{
  return key_is_type_(key, [](std::any const& a) {
    return !(detail::is_sequence(a) || detail::is_table(a));
  });
}

bool fhicl::ParameterSet::is_key_to_sequence ( std::string const &  key ) const

inline

Definition at line 214 of file ParameterSet.h.

References fhicl::detail::is_sequence().

Referenced by fhicl::decompose_parameterset(), and fhicl::detail::ValidateThenSet::enter_sequence().

{
  return key_is_type_(key, &detail::is_sequence);
}

bool fhicl::ParameterSet::is_key_to_table ( std::string const &  key ) const

inline

Definition at line 208 of file ParameterSet.h.

References fhicl::detail::is_table().

Referenced by fhicl::decompose_parameterset(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), rndm::details::PerInstancePolicy< SEED >::getInstanceSeed(), and fluxr::DK2NuInterface::Init().

{
  return key_is_type_(key, &detail::is_table);
}

bool ParameterSet::key_is_type_ ( std::string const &  key, std::function< bool(std::any const &)>  func  ) const

private

Definition at line 346 of file ParameterSet.cc.

References fhicl::cant_find, fhicl::detail::find_an_any(), fhicl::detail::get_names(), and fhicl::detail::get_sequence_indices().

{
  auto split_keys = detail::get_names(key);
  auto ps = descend_(split_keys.tables());
  if (not ps) {
    throw exception(error::cant_find, key);
  }

  auto skey = detail::get_sequence_indices(split_keys.last());

  auto it = ps->mapping_.find(skey.name());
  if (it == ps->mapping_.end()) {
    throw exception(error::cant_find, key);
  }

  auto a = it->second;
  return detail::find_an_any(
           skey.indices().cbegin(), skey.indices().cend(), a) ?
           func(a) :
           throw exception(error::cant_find, key);
}

fhicl::ParameterSet fhicl::ParameterSet::make ( intermediate_table const &  tbl )

static

Definition at line 68 of file ParameterSet.cc.

References put(), and value.

Referenced by evdb::ServiceTable::ApplyEdits(), testing::BasicTesterEnvironment< ConfigurationClass >::CompileParameterSet(), fhicl::detail::fhicl_get_impl(), fhicl::ParameterSetRegistry::find_(), main(), make(), fhicl::make_ParameterSet(), lar::standalone::ParseConfiguration(), testing::BasicTesterEnvironment< ConfigurationClass >::ParseParameters(), detinfo::DetectorPropertiesServiceStandard::postOpenFile(), detinfo::DetectorClocksServiceStandard::postOpenFile(), and art::run_art().

{
  ParameterSet result;
  for (auto const& [key, value] : tbl) {
    if (!value.in_prolog)
      result.put(key, value);
  }
  return result;
}

fhicl::ParameterSet fhicl::ParameterSet::make ( extended_value const &  xval )

static

Definition at line 81 of file ParameterSet.cc.

References fhicl::extended_value::is_a(), put(), fhicl::TABLE, fhicl::type_mismatch, and value.

{
  if (!xval.is_a(TABLE))
    throw fhicl::exception(type_mismatch, "extended value not a table");

  ParameterSet result;
  auto const& tbl = table_t(xval);
  for (auto const& [key, value] : tbl) {
    if (!value.in_prolog)
      result.put(key, value);
  }
  return result;
}

fhicl::ParameterSet fhicl::ParameterSet::make ( std::string const &  str )

static

Definition at line 98 of file ParameterSet.cc.

References make(), and fhicl::parse_document().

{
  auto const tbl = parse_document(str);
  return ParameterSet::make(tbl);
}

fhicl::ParameterSet fhicl::ParameterSet::make ( std::string const &  filename, cet::filepath_maker &  maker  )

static

Definition at line 107 of file ParameterSet.cc.

References make(), and fhicl::parse_document().

{
  auto const tbl = parse_document(filename, maker);
  return ParameterSet::make(tbl);
}

bool fhicl::ParameterSet::operator!= ( ParameterSet const &  other ) const

inline

Definition at line 355 of file ParameterSet.h.

References util::details::operator==().

{
  return !operator==(other);
}

bool fhicl::ParameterSet::operator== ( ParameterSet const &  other ) const

inline

Definition at line 349 of file ParameterSet.h.

References id().

{
  return id() == other.id();
}

void ParameterSet::put

(

std::string const &

key

)

Definition at line 266 of file ParameterSet.cc.

Referenced by lar_pandora::LArPandora::ConstructHitCollectionToolParameterSet(), fhicl::detail::encode(), art::EventProcessor::EventProcessor(), evgen::GENIEGen::GENIEGen(), reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation(), make(), art::PathManager::PathManager(), phot::PhotonVisibilityService::PhotonVisibilityService(), and PointIdAlgTools::PointIdAlgSonicTriton::PointIdAlgSonicTriton().

{
  put(key, nullptr);
}

template<class T >

void fhicl::ParameterSet::put	(	std::string const &	key,
		T const &	value
	)

Definition at line 229 of file ParameterSet.h.

References util::quantities::concepts::encode(), fhicl::detail::try_insert(), and value.

{
  auto insert = [this, &value](auto const& key) {
    using detail::encode;
    this->insert_(key, std::any(encode(value)));
  };
  detail::try_insert(insert, key);
}

void fhicl::ParameterSet::put	(	std::string const &	key,
		fhicl::extended_value const &	value
	)

Definition at line 409 of file ParameterSet.cc.

References fhicl::detail::encode(), fhicl::detail::try_insert(), and value.

  {
    auto insert = [this, &value](auto const& key) {
      using detail::encode;
      this->insert_(key, std::any(encode(value)));
      fill_src_info(value, key, srcMapping_);
    };
    detail::try_insert(insert, key);
  }

void ParameterSet::put_or_replace

(

std::string const &

key

)

Definition at line 272 of file ParameterSet.cc.

References fhicl::unimplemented.

Referenced by lar_cluster3d::DBScanAlg::configure(), and reco::shower::LArPandoraModularShowerCreation::LArPandoraModularShowerCreation().

{
  put_or_replace(key, nullptr); // Replace with nil is always OK.
}

template<class T >

void fhicl::ParameterSet::put_or_replace	(	std::string const &	key,
		T const &	value
	)

Definition at line 240 of file ParameterSet.h.

References util::quantities::concepts::encode(), fhicl::detail::try_insert(), and value.

{
  auto insert_or_replace = [this, &value](auto const& key) {
    using detail::encode;
    this->insert_or_replace_(key, std::any(encode(value)));
    srcMapping_.erase(key);
  };
  detail::try_insert(insert_or_replace, key);
}

template<class T >

void fhicl::ParameterSet::put_or_replace_compatible	(	std::string const &	key,
		T const &	value
	)

Definition at line 252 of file ParameterSet.h.

References util::quantities::concepts::encode(), fhicl::detail::try_insert(), and value.

{
  auto insert_or_replace_compatible = [this, &value](auto const& key) {
    using detail::encode;
    this->insert_or_replace_compatible_(key, std::any(encode(value)));
    srcMapping_.erase(key);
  };
  detail::try_insert(insert_or_replace_compatible, key);
}

string ParameterSet::stringify_ ( std::any const &  a, bool  compact = false  ) const

private

Definition at line 117 of file ParameterSet.cc.

References e, fhicl::ParameterSetRegistry::get(), fhicl::detail::is_sequence(), fhicl::detail::is_table(), and fhicl::ParameterSetID::max_str_size().

{
  string result;
  if (is_table(a)) {
    auto const& psid = any_cast<ParameterSetID>(a);
    result = '{' + ParameterSetRegistry::get(psid).to_string() + '}';
    if (compact && result.size() > (5 + ParameterSetID::max_str_size())) {
      // Replace with a reference to the ParameterSetID;
      result = std::string("@id::") + psid.to_string();
    }
  } else if (is_sequence(a)) {
    auto const& seq = any_cast<ps_sequence_t>(a);
    result = '[';
    if (!seq.empty()) {
      result.append(stringify_(*seq.begin(), compact));
      for (auto it = seq.cbegin(), e = seq.cend(); ++it != e;) {
        result.append(1, ',').append(stringify_(*it, compact));
      }
    }
    result.append(1, ']');
  } else { // is_atom(a)
    ps_atom_t const str = any_cast<ps_atom_t>(a);
    result = str == string(9, '\0') ? "@nil" : str;
  }
  return result;
} // stringify_()

std::string fhicl::ParameterSet::to_compact_string ( ) const

inline

Definition at line 202 of file ParameterSet.h.

Referenced by fhicl::decompose_parameterset().

{
  return to_string_(true);
}

string ParameterSet::to_indented_string

(

)

const

Definition at line 466 of file ParameterSet.cc.

Referenced by geo::Geometry::FillGeometryConfigurationInfo(), and testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility().

{
  return to_indented_string(0u);
}

string ParameterSet::to_indented_string

(

unsigned

initial_indent_level

)

const

Definition at line 472 of file ParameterSet.cc.

{
  return to_indented_string(initial_indent_level, false);
}

string ParameterSet::to_indented_string	(	unsigned	initial_indent_level,
		bool	annotate
	)		const

Definition at line 478 of file ParameterSet.cc.

References fhicl::detail::annotated, and fhicl::detail::raw.

{
  if (annotate) {
    return to_indented_string(initial_indent_level, print_mode::annotated);
  }
  return to_indented_string(initial_indent_level, print_mode::raw);
}

string ParameterSet::to_indented_string	(	unsigned	initial_indent_level,
		detail::print_mode	pm
	)		const

Definition at line 488 of file ParameterSet.cc.

References fhicl::detail::annotated, fhicl::detail::prefix_annotated, fhicl::detail::raw, and fhicl::detail::PrettifierPrefixAnnotated::result().

{
  std::string result;
  switch (pm) {
  case print_mode::raw: {
    Prettifier p{initial_indent_level};
    walk(p);
    result = p.result();
    break;
  }
  case print_mode::annotated: {
    PrettifierAnnotated p{initial_indent_level};
    walk(p);
    result = p.result();
    break;
  }
  case print_mode::prefix_annotated: {
    PrettifierPrefixAnnotated p;
    walk(p);
    result = p.result();
    break;
  }
  }
  return result;
}

std::string fhicl::ParameterSet::to_string ( ) const

inline

Definition at line 196 of file ParameterSet.h.

Referenced by fhicl::ParameterSetID::reset(), and evdb::ParameterSetEditRow::UnpackParameter().

{
  return to_string_();
}

string ParameterSet::to_string_ ( bool  compact = false ) const

private

Definition at line 162 of file ParameterSet.cc.

References e.

{
  string result;
  if (mapping_.empty()) {
    return result;
  }
  auto it = mapping_.begin();
  result.append(it->first).append(1, ':').append(
    stringify_(it->second, compact));
  for (auto const e = mapping_.end(); ++it != e;) {
    result.append(1, ' ').append(it->first).append(1, ':').append(
      stringify_(it->second, compact));
  }
  return result;
}

void ParameterSet::walk

(

ParameterSetWalker &

psw

)

const

Definition at line 423 of file ParameterSet.cc.

References fhicl::ParameterSetWalker::do_after_action(), fhicl::ParameterSetWalker::do_atom(), fhicl::ParameterSetWalker::do_before_action(), fhicl::ParameterSetWalker::do_enter_sequence(), fhicl::ParameterSetWalker::do_enter_table(), fhicl::ParameterSetWalker::do_exit_sequence(), fhicl::ParameterSetWalker::do_exit_table(), fhicl::detail::is_sequence(), fhicl::detail::is_table(), mapping_, util::to_string(), and value.

Referenced by evgen::MARLEYHelper::reconfigure().

{
  std::stack<ParameterSet const*> ps_stack;
  ps_stack.push(this);

  std::function<void(std::string const&, std::any const&)> act_on_element =
    [&psw, &ps_stack, &act_on_element](std::string const& key,
                                       std::any const& a) {
      auto const* ps = ps_stack.top();
      psw.do_before_action(key, a, ps);

      if (is_table(a)) {
        ParameterSet const* ps = &get_pset_via_any(a);
        ps_stack.push(ps);
        psw.do_enter_table(key, a);
        for (auto const& [nested_key, nested_a] : ps->mapping_) {
          act_on_element(nested_key, nested_a);
        }
        psw.do_exit_table(key, a);
        ps_stack.pop();
      } else if (is_sequence(a)) {
        psw.do_enter_sequence(key, a);
        std::size_t i{};
        for (auto const& elem : any_cast<ps_sequence_t>(a)) {
          std::string const new_key = key + "["s + std::to_string(i++) + "]";
          act_on_element(new_key, elem);
        }
        psw.do_exit_sequence(key, a);
      } else {
        psw.do_atom(key, a);
      }

      psw.do_after_action(key);
    };

  for (auto const& [key, value] : mapping_) {
    act_on_element(key, value);
  }
}

Member Data Documentation

ParameterSetID fhicl::ParameterSet::id_

mutableprivate

Definition at line 127 of file ParameterSet.h.

map_t fhicl::ParameterSet::mapping_

private

Definition at line 125 of file ParameterSet.h.

Referenced by walk().

annot_t fhicl::ParameterSet::srcMapping_

private

Definition at line 126 of file ParameterSet.h.

---

The documentation for this class was generated from the following files:

• fhiclcpp/ParameterSet.h
• fhiclcpp/ParameterSet.cc