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 >
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)

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

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

Private Attributes
map_t	mapping_
annot_t	srcMapping_
ParameterSetID	id_

Detailed Description

Definition at line 34 of file ParameterSet.h.

Member Typedef Documentation

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

Definition at line 38 of file ParameterSet.h.

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

private

Definition at line 108 of file ParameterSet.h.

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

private

Definition at line 107 of file ParameterSet.h.

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

Definition at line 36 of file ParameterSet.h.

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

Definition at line 37 of file ParameterSet.h.

Member Function Documentation

bool ParameterSet::descend_ ( std::vector< std::string > const &  names, ParameterSet &  ps  ) const

private

Definition at line 173 of file ParameterSet.cc.

References tmp.

Referenced by get_if_present().

{
  ParameterSet const* p{this};
  ParameterSet tmp;
  for (auto const& table : names) {
    if (!p->get_one_(table, tmp)) {
      return false;
    }
    p = &tmp;
  }
  ps = *p; // Can't be 'tmp'.  Sometimes 'names' is empty.
  return true;
}

bool ParameterSet::erase

(

std::string const &

key

)

Definition at line 282 of file ParameterSet.cc.

Referenced by art::EventProcessor::initServices_(), and strip_pset().

{
  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 159 of file ParameterSet.cc.

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

Referenced by has_key().

{
  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 231 of file ParameterSet.h.

References fhicl::cant_find, and get_if_present().

Referenced by art::ActionTable::ActionTable(), pmtana::AlgoCFD::AlgoCFD(), pmtana::AlgoFixedWindow::AlgoFixedWindow(), pmtana::AlgoSiPM::AlgoSiPM(), pmtana::AlgoSlidingWindow::AlgoSlidingWindow(), pmtana::AlgoThreshold::AlgoThreshold(), geo::AuxDetGeometry::AuxDetGeometry(), fhicl::detail::Prettifier::before_action(), opdet::BoDataFrameInput::BoDataFrameInput(), cluster::ClusterMatchAlg::ClusterMatchAlg(), altns::ExampleAction::Config(), mf::service::ELdestination::Category::Config::Config(), trigger::TriggerAlgoBase::Config(), reco_tool::PeakFitterGaussElimination::configure(), evwgh::GenieWeightCalc::Configure(), reco_tool::CandHitStandard::configure(), reco_tool::PeakFitterGaussian::configure(), reco_tool::CandHitDerivative::configure(), reco_tool::CandHitMorphological::configure(), spacecharge::SpaceChargeStandard::Configure(), evd_tool::ICARUSDrawer::configure(), evd_tool::MicroBooNEDrawer::configure(), lar_cluster3d::ClusterParamsBuilder::configure(), evd_tool::StandardDrawer::configure(), lar_cluster3d::kdTree::configure(), lar_cluster3d::DBScanAlg::configure(), lar_cluster3d::ClusterMergeAlg::configure(), lar_cluster3d::SpacePointHit3DBuilder::configure(), lar_cluster3d::MinSpanTreeAlg::configure(), lar_cluster3d::ClusterPathFinder::configure(), lar_cluster3d::VoronoiPathFinder::configure(), evwgh::WeightManager::Configure(), trk::TrackContainmentAlg::Configure(), lar_cluster3d::StandardHit3DBuilder::configure(), rndm::details::PerEventPolicy< SEED >::configure(), detinfo::LArPropertiesStandard::Configure(), detinfo::DetectorClocksStandard::Configure(), evgen::CosmicsGen::CosmicsGen(), rndm::details::AutoIncrementPolicy< SEED >::createSeed(), rndm::details::LinearMappingPolicy< SEED >::createSeed(), rndm::details::PredefinedOffsetPolicy< SEED >::createSeed(), evgb::CRYHelper::CRYHelper(), fhicl::decompose_parameterset(), opdet::MicrobooneOpDetResponse::doReconfigure(), shower::EMShowerAlg::EMShowerAlg(), art::EventProcessor::EventProcessor(), art::EventSelector::EventSelector(), evwgh::EventWeight::EventWeight(), art::TrivialFileDelivery::extractFileListFromPset(), opdet::FIFOHistogramAna::FIFOHistogramAna(), art::PathManager::fillAllModules_(), opdet::SimPhotonCounterAlg::FillRanges(), opdet::FlashPurityCheckAna::FlashPurityCheckAna(), cluster::FuzzyClusterMerger::FuzzyClusterMerger(), evgen::GENIEGen::GENIEGen(), geo::Geometry::Geometry(), evd::DrawingPad::GeometryDraw(), fhicl::DelegatedParameter::get(), art::detail::get_failureToPut_flag(), art::EngineCreator::get_seed_value(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), rndm::details::PerInstancePolicy< SEED >::getInstanceSeed(), art::TriggerNamesService::getTrigPaths(), art::EventProcessor::initSchedules_(), art::EventProcessor::initServices_(), art::ActionTable::install_(), detinfo::DetectorPropertiesServiceStandard::isDetectorPropertiesServiceStandard(), lar_pandora::LArPandora::LArPandora(), detinfo::LArPropertiesStandard::LArPropertiesStandard(), opdet::LEDCalibrationAna::LEDCalibrationAna(), evgen::LightSource::LightSource(), art::InputSourceFactory::make(), art::make_tool(), art::detail::ServiceCacheEntry::makeAndCacheService(), art::EmptyEvent::makePlugin_(), art::RPManager::makeRPs_(), art::detail::ModuleFactory::makeWorker(), art::PathsInfo::makeWorker_(), hit::MCHitAnaExample::MCHitAnaExample(), hit::MCHitFinder::MCHitFinder(), MCReco::MCReco(), sim::MCRecoEdep::MCRecoEdep(), sim::MCRecoPart::MCRecoPart(), sim::MCShowerRecoPart::MCShowerRecoPart(), sim::MCTrackRecoAlg::MCTrackRecoAlg(), mvapid::MVAAlg::MVAAlg(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), evgen::NueAr40CCGenerator::NueAr40CCGenerator(), opdet::OpDigiAna::OpDigiAna(), opdet::OpFlashAna::OpFlashAna(), opdet::OpFlashMCTruthAna::OpFlashMCTruthAna(), opdet::OpHitAna::OpHitAna(), opdet::OpHitFinder::OpHitFinder(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), opreco::OpticalRecoAna::OpticalRecoAna(), testing::BasicTesterEnvironment< ConfigurationClass >::ParseEnvironmentOptions(), cheat::ParticleInventoryService::ParticleInventoryService(), pmtana::PedAlgoEdges::PedAlgoEdges(), pmtana::PedAlgoRmsSlider::PedAlgoRmsSlider(), pmtana::PedAlgoRollingMean::PedAlgoRollingMean(), pmtana::PedAlgoUB::PedAlgoUB(), pmtana::PMTAna::PMTAna(), detinfo::DetectorPropertiesServiceStandard::postOpenFile(), detinfo::DetectorClocksServiceStandard::postOpenFile(), util::DetectorPropertiesServiceArgoNeuT::postOpenFile(), art::PathManager::processPathConfigs_(), art::ProvenanceDumper< DETAIL, Enable >::ProvenanceDumper(), evd::AnalysisDrawingOptions::reconfigure(), wcls::WireCellToolkit::reconfigure(), hit::HitFilterAlg::reconfigure(), evd::ColorDrawingOptions::reconfigure(), event::EventMaker::reconfigure(), evdb::Colors::reconfigure(), evd::EvdLayoutOptions::reconfigure(), evd::SimulationDrawingOptions::reconfigure(), evd::RecoDrawingOptions::reconfigure(), evdb::EventDisplay::reconfigure(), phot::PhotonVisibilityService::reconfigure(), tss::Segmentation2D::reconfigure(), filt::LArG4ParticleFilter::reconfigure(), nutools::dbi::DBIService::reconfigure(), cluster::ClusterMatchTQ::reconfigure(), trkf::CosmicTrackerAlg::reconfigure(), cluster::fuzzyClusterAlg::reconfigure(), sim::LArG4Parameters::reconfigure(), opdet::OpDigiProperties::reconfigure(), cluster::EndPointAlg::reconfigure(), pid::Chi2PIDAlg::reconfigure(), trkf::StitchAlg::reconfigure(), opdet::FlashClusterMatch::reconfigure(), hit::HitFinder::reconfigure(), corner::CornerFinderAlg::reconfigure(), trkf::SeedFinderAlgorithm::reconfigure(), trkf::SeedFinderModule::reconfigure(), lar_pandora::PFParticleTrackAna::reconfigure(), hit::DisambigCheater::reconfigure(), sppt::SpacePointAlg_TimeSort::reconfigure(), lar_pandora::PFParticleValidation::reconfigure(), calo::TrackCalorimetryAlg::reconfigure(), pid::PIDAAnalyzer::reconfigure(), cluster::DBScanAlg::reconfigure(), filter::EventFilter::reconfigure(), lar_pandora::PFParticleCosmicAna::reconfigure(), cheat::CheckBackTracking::reconfigure(), opdet::OpFlashSimpleAna::reconfigure(), vertex::CornerFinder::reconfigure(), lar_pandora::PFParticleAnalysis::reconfigure(), lar_pandora::PFParticleMonitoring::reconfigure(), lar_pandora::PFParticleHitDumper::reconfigure(), phot::PhotonLibraryAnalyzer::reconfigure(), sim::LArVoxelCalculator::reconfigure(), trkf::TCTrack::reconfigure(), calo::PrintCalorimetry::reconfigure(), hit::TTHitFinder::reconfigure(), vertex::VertexCheater::reconfigure(), lar_pandora::ConsolidatedPFParticleAnalysisTemplate::reconfigure(), filt::FinalStateParticleFilter::reconfigure(), trkf::SpacePointCheater::reconfigure(), trkf::SpacePointFinder::reconfigure(), trk::TrackContainmentTagger::reconfigure(), tss::TrackShowerHits::reconfigure(), cosmic::BeamFlashTrackMatchTaggerAlg::reconfigure(), evd::RawDrawingOptions::reconfigure(), lariov::DatabaseRetrievalAlg::Reconfigure(), lariov::SIOVPmtGainProvider::Reconfigure(), filter::ADCFilter::reconfigure(), cluster::SmallClusterFilter::reconfigure(), trk::TrackContainmentAnalyzer::reconfigure(), cluster::LineCluster::reconfigure(), util::DetectorPropertiesServiceArgoNeuT::reconfigure(), apa::DisambigAlg::reconfigure(), trkf::BezierTrackerModule::reconfigure(), opdet::OpticalRawDigitReformatter::reconfigure(), opdet::TrackTimeAssoc::reconfigure(), event::EventCheater::reconfigure(), shwf::ShowerCheater::reconfigure(), filt::FinalStateSelectFilter::reconfigure(), cheat::RecoCheckAna::reconfigure(), pid::PIDAAlg::reconfigure(), opdet::BeamFlashCompatabilityCheck::reconfigure(), evd::InfoTransfer::reconfigure(), pid::Chi2ParticleID::reconfigure(), apa::APAHitFinder::reconfigure(), lariov::SIOVElectronicsCalibProvider::Reconfigure(), calo::BezierCalorimetry::reconfigure(), cluster::TrajCluster::reconfigure(), opdet::OpFlashFinder::reconfigure(), lar_cluster3d::HoughSeedFinderAlg::reconfigure(), noisefilteralg::WireCellNoiseFilter::reconfigure(), lar_cluster3d::SkeletonAlg::reconfigure(), t0::IndirectHitParticleAssns::reconfigure(), cosmic::BeamFlashTrackMatchTagger::reconfigure(), mag::MagneticField::reconfigure(), sppt::TTSpacePointFinder::reconfigure(), trkf::FeatureTracker::reconfigure(), calo::GeneralCalorimetry::reconfigure(), filt::EmptyFilter::reconfigure(), hit::HitCheater::reconfigure(), t0::DirectHitParticleAssns::reconfigure(), larg4::ISCalculationAna::reconfigure(), trkf::TrackCheater::reconfigure(), CRHitRemoval::reconfigure(), lar_cluster3d::PCASeedFinderAlg::reconfigure(), cluster::ClusterCheater::reconfigure(), cluster::SmallClusterFinderAlg::reconfigure(), hit::HitAnaModule::reconfigure(), lar_cluster3d::ParallelHitsSeedFinderAlg::reconfigure(), hit::FFTHitFinder::reconfigure(), calo::TrackCalorimetry::reconfigure(), util::DatabaseUtil::reconfigure(), lar_cluster3d::PrincipalComponentsAlg::reconfigure(), simfilter::FilterPrimaryPDG::reconfigure(), caldata::CalWire::reconfigure(), cluster::DBcluster::reconfigure(), DUNE::NeutrinoShowerEff::reconfigure(), cluster::ClusterCrawler::reconfigure(), cosmic::TrackPFParticleMatch::reconfigure(), tca::TrajClusterAlg::reconfigure(), caldata::CalWireT962::reconfigure(), t0::MCParticleHitMatching::reconfigure(), trkf::SpacePts::reconfigure(), cluster::BlurredClustering::reconfigure(), rwgt::ReweightAna::reconfigure(), opdet::OpHitFinder::reconfigure(), cluster::fuzzyCluster::reconfigure(), phot::PhotonLibraryPropagation::reconfigure(), detsim::SimWireAna::reconfigure(), trkf::TrackKalmanCheater::reconfigure(), trkf::Track3Dreco::reconfigure(), filter::MuonFilter::reconfigure(), larg4::LArG4Ana::reconfigure(), util::LArPropertiesServiceArgoNeuT::reconfigure(), shower::EMShower::reconfigure(), shwf::ShowerFinder::reconfigure(), cosmic::CosmicPFParticleTagger::reconfigure(), evgen::NUANCEGen::reconfigure(), lariov::DetPedestalRetrievalAlg::Reconfigure(), larg::LArSimChannelAna::reconfigure(), trkf::KalmanFilterAlg::reconfigure(), cosmic::CosmicTrackTagger::reconfigure(), vertex::PrimaryVertexFinder::reconfigure(), cosmic::CosmicPCAxisTagger::reconfigure(), trkf::CCTrackMaker::reconfigure(), cosmic::CosmicClusterTagger::reconfigure(), trkf::Track3DKalmanHitAlg::reconfigure(), t0::MCParticleShowerMatching::reconfigure(), cluster::SmallClusterFinder::reconfigure(), hit::RawHitFinder::reconfigure(), cluster::MergeClusterAlg::reconfigure(), t0::MCParticleTrackMatching::reconfigure(), DUNE::NeutrinoTrackingEff::reconfigure(), hit::MagDriftAna::reconfigure(), evgen::NDKGen::reconfigure(), cluster::EndPointModule::reconfigure(), DUNE::MuonTrackingEff::reconfigure(), cluster::BlurredClusteringAlg::reconfigure(), hit::GausHitFinderAna::reconfigure(), trkf::Track3DKalmanHit::reconfigure(), hit::HitFinderAna::reconfigure(), hit::GausHitFinder::reconfigure(), cluster::HoughLineFinder::reconfigure(), CRHitRemovalByPCA::reconfigure(), trkf::TrackStitcher::reconfigure(), ems::EMShower3D::reconfigure(), trkf::BezierTrackerAlgorithm::reconfigure(), vertex::VertexFinder2D::reconfigure(), evgen::GaisserParam::reconfigure(), wc::CellTree::reconfigure(), evgen::TextFileGen::reconfigure(), hit::DPRawHitFinder::reconfigure(), detsim::SimWire::reconfigure(), shwf::ShowerReco::reconfigure(), detsim::SimWireT962::reconfigure(), vertex::FeatureVertexFinderAna::reconfigure(), hit::CCHitFinderAlg::reconfigure(), trkf::Track3DKalman::reconfigure(), trkf::SpacePointAlg::reconfigure(), lbne::PhotonCounterT0Matching::reconfigure(), util::FileCatalogMetadataExtras::reconfigure(), evgen::RadioGen::reconfigure(), detsim::SimDriftElectrons::reconfigure(), trkf::Track3DKalmanSPS::reconfigure(), cluster::ClusterCrawlerAlg::reconfigure(), t0::MCTruthT0Matching::reconfigure(), vertex::FeatureVertexFinder::reconfigure(), lar_cluster3d::Cluster3D::reconfigure(), shower::TrackShowerSeparationAlg::reconfigure(), trkf::CosmicTracker::reconfigure(), evgen::MUSUN::reconfigure(), ems::MultiEMShowers::reconfigure(), ems::MergeEMShower3D::reconfigure(), ClusteringValidation::ClusteringValidation::reconfigure(), cluster::HoughBaseAlg::reconfigure(), evdb::ServiceTable::RegisterService(), hit::RFFHitFinderAlg::RFFHitFinderAlg(), art::RPManager::RPManager(), art::run_art_common_(), evdb::ScanOptions::ScanOptions(), rndm::SeedMaster< SEED >::SeedMaster(), testing::BasicTesterEnvironment< ConfigurationClass >::ServiceParameters(), lar::standalone::SetupGeometry(), lar::standalone::SetupGeometryWithChannelMapping(), lar::standalone::SetupMessageFacility(), shower::ShowerEnergyAlg::ShowerEnergyAlg(), ShowerQuality::ShowerQuality(), ShowerReco3D::ShowerReco3D(), opdet::SimPhotonCounterAlg::SimPhotonCounterAlg(), lariov::SimpleChannelStatus::SimpleChannelStatus(), cluster::SimpleClusterMerger::SimpleClusterMerger(), detsim::SimWire::SimWire(), detsim::SimWireT962::SimWireT962(), lariov::SIOVChannelStatusProvider::SIOVChannelStatusProvider(), rndm::details::AutoIncrementPolicy< SEED >::static_configure(), rndm::details::LinearMappingPolicy< SEED >::static_configure(), rndm::details::PredefinedOffsetPolicy< SEED >::static_configure(), testing::BasicTesterEnvironment< ConfigurationClass >::TesterParameters(), ToyOneShowerGen::ToyOneShowerGen(), TrackProducerFromPFParticle::TrackProducerFromPFParticle(), TrackProducerFromTrack::TrackProducerFromTrack(), TrackProducerFromTrackTrajectory::TrackProducerFromTrackTrajectory(), opdet::TrackTimeAssocAna::TrackTimeAssocAna(), evdb::Colors::UnpackColorScale(), evdb::ParameterSetEditRow::UnpackParameter(), and cheat::PhotonBackTracker::~PhotonBackTracker().

{
  T result;
  return get_if_present(key, 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 240 of file ParameterSet.h.

References fhicl::cant_find, and get_if_present().

{
  T result;
  return get_if_present(key, result, convert) ?
           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 250 of file ParameterSet.h.

References get_if_present().

{
  T result;
  return get_if_present(key, 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 258 of file ParameterSet.h.

References get_if_present().

{
  T result;
  return get_if_present(key, result, convert) ? result : default_value;
}

vector< string > ParameterSet::get_all_keys

(

)

const

Definition at line 151 of file ParameterSet.cc.

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

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

template<class T >

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

Definition at line 208 of file ParameterSet.h.

References descend_(), fhicl::detail::get_names(), get_one_(), and fhicl::detail::atom::value().

Referenced by rndm::details::RangeCheckHelper< SEED >::configure(), rndm::details::RandomPolicy< SEED >::configure(), rndm::details::RandomPolicy< SEED >::createSeed(), rndm::details::LinearMappingPolicy< SEED >::createSeed(), mf::service::ELdestination::ELdestination(), evgen::GENIEGen::GENIEGen(), get(), fhicl::OptionalDelegatedParameter::get_if_present(), get_if_present(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), rndm::details::PerInstancePolicy< SEED >::getInstanceSeed(), util::DetectorPropertiesServiceArgoNeuT::isDetectorPropertiesServiceArgoNeuT(), detinfo::DetectorPropertiesServiceStandard::isDetectorPropertiesServiceStandard(), art::Consumer::prepareForJob(), rndm::NuRandomService::readSeedParameter(), util::DetectorPropertiesServiceArgoNeuT::reconfigure(), tca::TrajClusterAlg::reconfigure(), trkf::Track3DKalmanSPS::reconfigure(), testing::ProviderSetupClass< detinfo::DetectorClocksStandard >::setup(), testing::ProviderSetupClass< detinfo::LArPropertiesStandard >::setup(), testing::ProviderSetupClass< detinfo::DetectorPropertiesStandard >::setup(), testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility(), rndm::details::LinearMappingPolicy< SEED >::static_configure(), and want_pset().

{
  auto keys = detail::get_names(key);
  ParameterSet ps;
  return descend_(keys.tables(), ps) ? ps.get_one_(keys.last(), value) : 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 217 of file ParameterSet.h.

References get_if_present().

{
  Via go_between;
  if (!get_if_present(key, go_between)) {
    return false;
  }
  result = convert(go_between);
  return true;
} // get_if_present<>()

vector< string > ParameterSet::get_names

(

)

const

Definition at line 129 of file ParameterSet.cc.

Referenced by fhicl::decompose_parameterset(), rndm::details::PerInstancePolicy< SEED >::getInstanceParameter(), evdb::ParameterSetEditFrame::ParameterSetEditFrame(), and art::PathManager::processPathConfigs_().

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

template<class T >

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

private

Definition at line 284 of file ParameterSet.h.

References fhicl::cant_find, art::decode(), fhicl::detail::decode(), e, fhicl::detail::find_an_any(), fhicl::detail::get_sequence_indices(), put(), and fhicl::type_mismatch.

Referenced by get_if_present().

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

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

  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 true;
}
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 139 of file ParameterSet.cc.

References fhicl::detail::is_table().

{
  vector<string> keys;
  for (auto const& pr : mapping_) {
    if (is_table(pr.second)) {
      keys.push_back(pr.first);
    }
  }
  return keys;
}

std::string ParameterSet::get_src_info

(

std::string const &

key

)

const

Definition at line 199 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 189 of file ParameterSet.cc.

References find_one_(), and fhicl::detail::get_names().

Referenced by fhicl::detail::ValidateThenSet::before_action(), spacecharge::SpaceChargeStandard::Configure(), rndm::details::PerInstancePolicy< SEED >::getInstanceSeed(), fhicl::OptionalDelegatedParameter::hasValue(), tca::TrajClusterAlg::reconfigure(), hit::CCHitFinderAlg::reconfigure(), cluster::ClusterCrawlerAlg::reconfigure(), and art::run_art_common_().

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

ParameterSetID ParameterSet::id

(

)

const

Definition at line 103 of file ParameterSet.cc.

References fhicl::ParameterSetID::reset().

Referenced by fhicl::decompose_parameterset(), art::EventObserverBase::EventObserverBase(), art::Schedule::makeTriggerResultsInserter_(), art::PathsInfo::makeWorker_(), operator==(), and art::RPManager::RPManager().

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

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

private

Definition at line 234 of file ParameterSet.cc.

References fhicl::cant_insert.

Referenced by put().

{
  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, boost::any const &  value  )

private

Definition at line 244 of file ParameterSet.cc.

References fhicl::detail::atom::value().

Referenced by put_or_replace().

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

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

private

Definition at line 252 of file ParameterSet.cc.

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

Referenced by put_or_replace_compatible().

{
  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 97 of file ParameterSet.cc.

{
  return mapping_.empty();
}

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

inline

Definition at line 161 of file ParameterSet.h.

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

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

{
  return key_is_type_(key, [](boost::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 155 of file ParameterSet.h.

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

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 149 of file ParameterSet.h.

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

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

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

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

private

Definition at line 290 of file ParameterSet.cc.

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

Referenced by is_key_to_atom(), is_key_to_sequence(), and is_key_to_table().

{
  auto split_keys = detail::get_names(key);
  ParameterSet ps;
  if (!descend_(split_keys.tables(), 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);
}

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

inline

Definition at line 275 of file ParameterSet.h.

References operator==().

{
  return !operator==(other);
}

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

inline

Definition at line 269 of file ParameterSet.h.

References id().

Referenced by operator!=().

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

void ParameterSet::put

(

std::string const &

key

)

Definition at line 208 of file ParameterSet.cc.

References fhicl::detail::atom::value().

Referenced by fhicl::detail::encode(), evgen::GENIEGen::GENIEGen(), get_one_(), fhicl::make_ParameterSet(), and art::TriggerNamesService::TriggerNamesService().

{
  void* const value{nullptr};
  put(key, value);
}

template<class T >

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

Definition at line 170 of file ParameterSet.h.

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

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

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

Definition at line 353 of file ParameterSet.cc.

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

  {
    auto insert = [this, &value](auto const& key) {
      using detail::encode;
      this->insert_(key, boost::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 215 of file ParameterSet.cc.

References fhicl::unimplemented, and fhicl::detail::atom::value().

{
  void* const value{nullptr};
  put_or_replace(key, value); // 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 181 of file ParameterSet.h.

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

{
  auto insert_or_replace = [this, &value](auto const& key) {
    using detail::encode;
    this->insert_or_replace_(key, boost::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 193 of file ParameterSet.h.

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

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

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

private

Definition at line 67 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 143 of file ParameterSet.h.

References to_string_().

Referenced by fhicl::decompose_parameterset().

{
  return to_string_(true);
}

string ParameterSet::to_indented_string

(

)

const

Definition at line 410 of file ParameterSet.cc.

Referenced by main(), print_pset_from_file(), and testing::BasicTesterEnvironment< ConfigurationClass >::SetupMessageFacility().

{
  return to_indented_string(0u);
}

string ParameterSet::to_indented_string

(

unsigned

initial_indent_level

)

const

Definition at line 416 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 422 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 432 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 137 of file ParameterSet.h.

References to_string_().

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

{
  return to_string_();
}

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

private

Definition at line 112 of file ParameterSet.cc.

References e.

Referenced by to_compact_string(), and to_string().

{
  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 367 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_, s, and util::flags::to_string().

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

  std::function<void(std::string const&, boost::any const&)> act_on_element =
    [&psw, &ps_stack, &act_on_element](std::string const& key,
                                       boost::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& elem : ps->mapping_) {
          act_on_element(elem.first, elem.second);
        }
        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();
    };

  for (const auto& entry : mapping_) {
    act_on_element(entry.first, entry.second);
  }
}

Member Data Documentation

ParameterSetID fhicl::ParameterSet::id_

mutableprivate

Definition at line 112 of file ParameterSet.h.

map_t fhicl::ParameterSet::mapping_

private

Definition at line 110 of file ParameterSet.h.

Referenced by key_is_type_(), and walk().

annot_t fhicl::ParameterSet::srcMapping_

private

Definition at line 111 of file ParameterSet.h.

---

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

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