LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
fhicl::detail::TableBase Class Referenceabstract

#include "TableBase.h"

Inheritance diagram for fhicl::detail::TableBase:
fhicl::detail::ParameterBase fhicl::OptionalTable< T > fhicl::Table< T, KeysToIgnore > fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config > fhicl::Table< art::ClosingCriteria::art::RootOutput::Config > fhicl::Table< art::EDAnalyzer::Table::FullConfig< UserConfig >, KeysToIgnore_t > fhicl::Table< art::MemoryTracker::Config::DBoutput > fhicl::Table< art::ProducerTable::FullConfig< Config, ImplicitConfig >, KeysToIgnore_t > fhicl::Table< art::ProducerTable::FullConfig< UserConfig, ImplicitConfig >, KeysToIgnore_t > fhicl::Table< art::TimeTracker::Config::DBoutput > fhicl::Table< art::ToolConfigTable::FullConfig< Config >, KeysToIgnore_t > fhicl::Table< art::ToolConfigTable::FullConfig< UserConfig >, KeysToIgnore_t > fhicl::Table< calo::CalorimetryAlg::img::DataProviderAlg::Config > fhicl::Table< calo::LinearEnergyAlg::RecombinationConfig > fhicl::Table< cheat::BackTracker::cheat::BackTrackerService::fhiclConfig > fhicl::Table< cheat::ParticleInventory::ParticleInventoryConfig > fhicl::Table< cheat::PhotonBackTracker::cheat::PhotonBackTrackerService::fhiclConfig > fhicl::Table< evgen::evgen::ActiveVolumeVertexSampler::evgen::MarleyGen::Config > fhicl::Table< evgen::evgen::ActiveVolumeVertexSampler::evgen::MarleyTimeGen::Config > fhicl::Table< evgen::evgen::MARLEYHelper::evgen::MarleyGen::Config > fhicl::Table< evgen::evgen::MARLEYHelper::evgen::MarleyTimeGen::Config > fhicl::Table< evgen::MARLEYHelper::Source_Config > fhicl::Table< img::DataProviderAlg::pma::PMAlgTracker::Config > fhicl::Table< lar::example::lar::example::TotallyCheatTrackingAlg::lar::example::TotallyCheatTracker::Config > fhicl::Table< lar::example::SpacePointIsolationAlg::lar::example::RemoveIsolatedSpacePoints::Config > fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config > fhicl::Table< pma::PMAlgCosmicTagger::trkf::PMAlgTrackMaker::Config > fhicl::Table< pma::PMAlgFitter::trkf::PMAlgTrajFitter::Config > fhicl::Table< pma::PMAlgStitching::trkf::PMAlgTrackMaker::Config > fhicl::Table< pma::PMAlgTracker::trkf::PMAlgTrackMaker::Config > fhicl::Table< pma::PMAlgVertexing::trkf::PMAlgTrackMaker::Config > fhicl::Table< pma::PMAlgVertexing::trkf::PMAlgTrajFitter::Config > fhicl::Table< pma::ProjectionMatchingAlg::trkf::PMAlgTrackMaker::Config > fhicl::Table< pma::ProjectionMatchingAlg::trkf::PMAlgTrajFitter::Config > fhicl::Table< T > fhicl::Table< T, fhicl::KeysToIgnore > fhicl::Table< trkf::Geometric3DVertexFitter::trkf::VertexFitter::Config > fhicl::Table< trkf::KalmanFilterFinalTrackFitter::trkf::KalmanFilterFinalTrackFitter::Inputs > fhicl::Table< trkf::KalmanFilterFinalTrackFitter::trkf::KalmanFilterFinalTrackFitter::Options > fhicl::Table< trkf::KalmanFilterTrajectoryFitter::trkf::KalmanFilterTrajectoryFitter::Inputs > fhicl::Table< trkf::KalmanFilterTrajectoryFitter::trkf::KalmanFilterTrajectoryFitter::Options > fhicl::Table< trkf::MCSFitProducer::trkf::MCSFitProducer::Inputs > fhicl::Table< trkf::TrackKalmanFitter::trkf::KalmanFilterFinalTrackFitter::Config > fhicl::Table< trkf::TrackKalmanFitter::trkf::KalmanFilterTrajectoryFitter::Config > fhicl::Table< trkf::TrackKalmanFitter::trkmkr::KalmanFilterFitTrackMaker::Config > fhicl::Table< trkf::TrackStatePropagator::trkf::KalmanFilterFinalTrackFitter::Config > fhicl::Table< trkf::TrackStatePropagator::trkf::KalmanFilterTrajectoryFitter::Config > fhicl::Table< trkf::TrackStatePropagator::trkf::VertexFitter::Config > fhicl::Table< trkf::TrackStatePropagator::trkmkr::KalmanFilterFitTrackMaker::Config > fhicl::Table< trkf::TrajectoryMCSFitter::trkf::MCSFitProducer::Config > fhicl::Table< trkf::TrajectoryMCSFitter::trkmkr::KalmanFilterFitTrackMaker::Config > fhicl::Table< trkf::VertexFitter::trkf::VertexFitter::Inputs > fhicl::Table< trkmkr::KalmanFilterFitTrackMaker::trkmkr::KalmanFilterFitTrackMaker::Options >

Public Member Functions

 TableBase (Name const &name, Comment const &comment, par_style const vt, std::function< bool()> maybeUse)
 
std::vector< cet::exempt_ptr< ParameterBase > > const & members () const
 
std::string key () const
 
std::string name () const
 
std::string comment () const
 
bool has_default () const
 
bool is_optional () const
 
bool is_conditional () const
 
par_type parameter_type () const
 
bool should_use () const
 
void set_value (fhicl::ParameterSet const &ps, bool trimParents)
 
void set_par_style (par_style const vt)
 
void set_key (std::string const &key)
 

Private Member Functions

virtual std::vector< cet::exempt_ptr< ParameterBase > > const & get_members () const =0
 

Detailed Description

Definition at line 14 of file TableBase.h.

Constructor & Destructor Documentation

fhicl::detail::TableBase::TableBase ( Name const &  name,
Comment const &  comment,
par_style const  vt,
std::function< bool()>  maybeUse 
)
inline

Definition at line 16 of file TableBase.h.

References fhicl::detail::ParameterBase::comment(), fhicl::detail::ParameterBase::name(), and fhicl::TABLE.

20  : ParameterBase{name, comment, vt, par_type::TABLE, maybeUse}
21  {}
ParameterBase(Name const &name, Comment const &comment, par_style const vt, par_type const type, std::function< bool()> maybeUse=AlwaysUse())
Definition: ParameterBase.h:84
std::string name() const
Definition: ParameterBase.h:49
std::string comment() const
Definition: ParameterBase.h:54

Member Function Documentation

virtual std::vector<cet::exempt_ptr<ParameterBase> > const& fhicl::detail::TableBase::get_members ( ) const
privatepure virtual

Implemented in fhicl::Table< T, KeysToIgnore >, fhicl::Table< art::ProducerTable::FullConfig< UserConfig, ImplicitConfig >, KeysToIgnore_t >, fhicl::Table< trkf::MCSFitProducer::trkf::MCSFitProducer::Inputs >, fhicl::Table< evgen::evgen::MARLEYHelper::evgen::MarleyTimeGen::Config >, fhicl::Table< art::TimeTracker::Config::DBoutput >, fhicl::Table< trkf::TrajectoryMCSFitter::trkf::MCSFitProducer::Config >, fhicl::Table< trkf::Geometric3DVertexFitter::trkf::VertexFitter::Config >, fhicl::Table< pma::PMAlgVertexing::trkf::PMAlgTrajFitter::Config >, fhicl::Table< img::DataProviderAlg::pma::PMAlgTracker::Config >, fhicl::Table< art::EDAnalyzer::Table::FullConfig< UserConfig >, KeysToIgnore_t >, fhicl::Table< cheat::PhotonBackTracker::cheat::PhotonBackTrackerService::fhiclConfig >, fhicl::Table< evgen::MARLEYHelper::Source_Config >, fhicl::Table< pma::PMAlgVertexing::trkf::PMAlgTrackMaker::Config >, fhicl::Table< trkf::TrackStatePropagator::trkf::VertexFitter::Config >, fhicl::Table< pma::PMAlgCosmicTagger::trkf::PMAlgTrackMaker::Config >, fhicl::Table< trkf::TrackKalmanFitter::trkf::KalmanFilterTrajectoryFitter::Config >, fhicl::Table< evgen::evgen::ActiveVolumeVertexSampler::evgen::MarleyGen::Config >, fhicl::Table< pma::PMAlgStitching::trkf::PMAlgTrackMaker::Config >, fhicl::Table< calo::LinearEnergyAlg::RecombinationConfig >, fhicl::Table< trkf::VertexFitter::trkf::VertexFitter::Inputs >, fhicl::Table< art::MemoryTracker::Config::DBoutput >, fhicl::Table< trkf::TrackStatePropagator::trkf::KalmanFilterTrajectoryFitter::Config >, fhicl::Table< T >, fhicl::Table< trkf::KalmanFilterTrajectoryFitter::trkf::KalmanFilterTrajectoryFitter::Options >, fhicl::Table< pma::PMAlgFitter::trkf::PMAlgTrajFitter::Config >, fhicl::Table< trkf::TrackStatePropagator::trkf::KalmanFilterFinalTrackFitter::Config >, fhicl::Table< trkf::KalmanFilterFinalTrackFitter::trkf::KalmanFilterFinalTrackFitter::Inputs >, fhicl::Table< trkf::TrajectoryMCSFitter::trkmkr::KalmanFilterFitTrackMaker::Config >, fhicl::Table< lar::example::SpacePointIsolationAlg::lar::example::RemoveIsolatedSpacePoints::Config >, fhicl::Table< cheat::BackTracker::cheat::BackTrackerService::fhiclConfig >, fhicl::Table< T, fhicl::KeysToIgnore >, fhicl::Table< art::ProducerTable::FullConfig< Config, ImplicitConfig >, KeysToIgnore_t >, fhicl::Table< calo::CalorimetryAlg::img::DataProviderAlg::Config >, fhicl::Table< pma::ProjectionMatchingAlg::trkf::PMAlgTrackMaker::Config >, fhicl::Table< trkmkr::KalmanFilterFitTrackMaker::trkmkr::KalmanFilterFitTrackMaker::Options >, fhicl::Table< lar::example::lar::example::TotallyCheatTrackingAlg::lar::example::TotallyCheatTracker::Config >, fhicl::Table< trkf::TrackKalmanFitter::trkf::KalmanFilterFinalTrackFitter::Config >, fhicl::Table< art::ToolConfigTable::FullConfig< Config >, KeysToIgnore_t >, fhicl::Table< art::ToolConfigTable::FullConfig< UserConfig >, KeysToIgnore_t >, fhicl::Table< evgen::evgen::ActiveVolumeVertexSampler::evgen::MarleyTimeGen::Config >, fhicl::Table< trkf::TrackKalmanFitter::trkmkr::KalmanFilterFitTrackMaker::Config >, fhicl::Table< pma::ProjectionMatchingAlg::trkf::PMAlgTrajFitter::Config >, fhicl::Table< trkf::KalmanFilterTrajectoryFitter::trkf::KalmanFilterTrajectoryFitter::Inputs >, fhicl::Table< evgen::evgen::MARLEYHelper::evgen::MarleyGen::Config >, fhicl::Table< trkf::KalmanFilterFinalTrackFitter::trkf::KalmanFilterFinalTrackFitter::Options >, fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >, fhicl::Table< art::ClosingCriteria::art::RootOutput::Config >, fhicl::Table< pma::PMAlgTracker::trkf::PMAlgTrackMaker::Config >, fhicl::Table< cheat::ParticleInventory::ParticleInventoryConfig >, fhicl::Table< trkf::TrackStatePropagator::trkmkr::KalmanFilterFitTrackMaker::Config >, fhicl::OptionalTable< T >, and fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >.

Referenced by members().

bool fhicl::detail::ParameterBase::is_conditional ( ) const
inlineinherited
std::string fhicl::detail::ParameterBase::key ( ) const
inlineinherited

Definition at line 44 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::key(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::SearchAllowedConfiguration::before_action(), fhicl::detail::PrintAllowedConfiguration::cacheTopLevelParameter(), detinfo::LArPropertiesStandard::Configure(), fhicl::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >::do_prepare_elements_for_validation(), fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::detail::ValidateThenSet::enter_sequence(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), fhicl::DelegatedParameter::get(), fhicl::OptionalDelegatedParameter::get_if_present(), fhicl::OptionalDelegatedParameter::hasValue(), fhicl::detail::MaybeDisplayParent::is_sequence_element(), fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::detail::PrintAllowedConfiguration::suppressFormat().

45  {
46  return mdata_.key();
47  }
std::vector<cet::exempt_ptr<ParameterBase> > const& fhicl::detail::TableBase::members ( ) const
inline

Definition at line 24 of file TableBase.h.

References get_members().

25  {
26  return get_members();
27  }
virtual std::vector< cet::exempt_ptr< ParameterBase > > const & get_members() const =0
void fhicl::detail::ParameterBase::set_key ( std::string const &  key)
inlineinherited
void fhicl::detail::ParameterBase::set_par_style ( par_style const  vt)
inlineinherited
void fhicl::detail::ParameterBase::set_value ( fhicl::ParameterSet const &  ps,
bool  trimParents 
)
inlineinherited

Definition at line 96 of file ParameterBase.h.

References fhicl::detail::ParameterBase::do_set_value().

Referenced by fhicl::detail::ValidateThenSet::after_action().

97  {
98  do_set_value(ps, trimParents);
99  }
virtual void do_set_value(fhicl::ParameterSet const &, bool trimParents)=0
bool fhicl::detail::ParameterBase::should_use ( ) const
inlineinherited

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