#include "TableBase.h"

Inheritance diagram for fhicl::detail::TableBase:

Public Member Functions
	TableBase (Name const &name, Comment const &comment, par_style vt, std::function< bool()> maybeUse)

	~TableBase ()

void	print_allowed_configuration (std::ostream &os, std::string const &tab=std::string(3, ' ')) const

std::vector< cet::exempt_ptr< ParameterBase > > const &	members () const

void	validate (ParameterSet const &pset, std::set< std::string > const &ignorable_keys={})

std::string const &	key () const

std::string const &	name () const

std::string const &	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	preset_value (fhicl::ParameterSet const &ps)

void	set_par_style (par_style const vt)

Protected Member Functions
void	finalize_members ()

void	maybe_implicitly_default ()

bool	has_value () const

ParameterSet const &	get_pset () const

ParameterSet const &	guarantee_pset () const

Private Member Functions
void	do_set_value (ParameterSet const &pset) final

std::optional< ParameterSet >	select_pset (ParameterSet const &pset) const

std::optional< ParameterSet >	maybe_select_pset (ParameterSet const &pset) const

Private Attributes
std::optional< ParameterSet >	pset_

std::vector< cet::exempt_ptr< ParameterBase > >	members_

Detailed Description

Definition at line 16 of file TableBase.h.

Constructor & Destructor Documentation

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

Definition at line 12 of file TableBase.cc.

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

16 : ParameterBase{name, comment, vt, par_type::TABLE, std::move(maybeUse)}

17 {}

fhicl::par_type::TABLE

fhicl::detail::ParameterBase::ParameterBase

ParameterBase(Name const &name, Comment const &comment, par_style const vt, par_type const type, std::function< bool()> maybeUse=AlwaysUse())

Definition: ParameterBase.cc:46

fhicl::detail::ParameterBase::name

std::string const & name() const

Definition: ParameterBase.cc:11

fhicl::detail::ParameterBase::comment

std::string const & comment() const

Definition: ParameterBase.cc:16

fhicl::detail::TableBase::~TableBase ( )

default

Referenced by TableBase().

Member Function Documentation

std::string const & fhicl::detail::ParameterBase::comment ( ) const

inherited

Definition at line 16 of file ParameterBase.cc.

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

Referenced by fhicl::Atom< T >::Atom(), fhicl::detail::AtomBase::AtomBase(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalAtom< T >::OptionalAtom(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalSequence< T, N >::OptionalSequence(), fhicl::OptionalSequence< T,-1ull >::OptionalSequence(), fhicl::OptionalTable< T >::OptionalTable(), fhicl::OptionalTuple< T >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::Sequence< T, N >::Sequence(), fhicl::Sequence< T,-1ull >::Sequence(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::Table< T, KeysToIgnore >::Table(), TableBase(), and fhicl::Tuple< T >::Tuple().

   {
     return mdata_.comment();
   }

void fhicl::detail::TableBase::do_set_value ( fhicl::ParameterSet const & pset )

finalprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 129 of file TableBase.cc.

References fhicl::detail::ParameterBase::is_optional(), maybe_select_pset(), pset_, and select_pset().

   {
     if (is_optional()) {
       pset_ = maybe_select_pset(pset);
     } else {
       pset_ = select_pset(pset);
     }
   }

void fhicl::detail::TableBase::finalize_members ( )

protected

Definition at line 37 of file TableBase.cc.

References members_, and fhicl::detail::TableMemberRegistry::release_members().

Referenced by fhicl::OptionalTable< T >::OptionalTable(), and fhicl::Table< T, KeysToIgnore >::Table().

   {
     // This must be called in a derived class **after** the table's
     // values has been set.
     members_ = TableMemberRegistry::release_members();
   }

ParameterSet const & fhicl::detail::TableBase::get_pset ( ) const

protected

Definition at line 79 of file TableBase.cc.

References pset_.

   {
     return pset_.value();
   }

ParameterSet const & fhicl::detail::TableBase::guarantee_pset ( ) const

protected

Definition at line 85 of file TableBase.cc.

References pset_.

   {
     static ParameterSet const empty_pset;
     return pset_.has_value() ? *pset_ : empty_pset;
   }

bool fhicl::detail::ParameterBase::has_default ( ) const

inherited

Definition at line 21 of file ParameterBase.cc.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::Atom< T >::do_set_value(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::Atom< T >::get_stringified_value(), and fhicl::TableAs< T, Config >::operator()().

   {
     return mdata_.has_default();
   }

bool fhicl::detail::TableBase::has_value ( ) const

protected

Definition at line 73 of file TableBase.cc.

References pset_.

   {
     return pset_.has_value();
   }

bool fhicl::detail::ParameterBase::is_conditional ( ) const

inherited

Definition at line 31 of file ParameterBase.cc.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), and fhicl::detail::PrintAllowedConfiguration::before_action().

   {
     return mdata_.is_conditional();
   }

bool fhicl::detail::ParameterBase::is_optional ( ) const

inherited

Definition at line 26 of file ParameterBase.cc.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::before_action(), and do_set_value().

   {
     return mdata_.is_optional();
   }

std::string const & fhicl::detail::ParameterBase::key ( ) const

inherited

Definition at line 6 of file ParameterBase.cc.

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::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< art::InputTag >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T, N >::do_preset_value(), fhicl::OptionalSequence< T,-1ull >::do_preset_value(), fhicl::Atom< T >::do_set_value(), fhicl::OptionalAtom< T >::do_set_value(), fhicl::detail::ValidateThenSet::enter_sequence(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), fhicl::DelegatedParameter::get(), fhicl::OptionalDelegatedParameter::get_if_present(), fhicl::OptionalDelegatedParameter::hasValue(), fhicl::detail::MaybeDisplayParent::is_sequence_element(), maybe_select_pset(), fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), select_pset(), and fhicl::detail::PrintAllowedConfiguration::suppressFormat().

   {
     return mdata_.key();
   }

void fhicl::detail::TableBase::maybe_implicitly_default ( )

protected

Definition at line 45 of file TableBase.cc.

References fhicl::DEFAULT, members_, and fhicl::detail::ParameterBase::set_par_style().

Referenced by fhicl::Table< T, KeysToIgnore >::Table().

   {
     bool const implicitly_default =
       std::all_of(members_.begin(), members_.end(), [](auto p) {
         return p->has_default() || p->is_optional();
       });
     if (implicitly_default)
       set_par_style(par_style::DEFAULT);
   }

std::optional< ParameterSet > fhicl::detail::TableBase::maybe_select_pset ( fhicl::ParameterSet const & pset ) const

private

Definition at line 110 of file TableBase.cc.

References fhicl::ParameterSet::get_if_present(), fhicl::detail::ParameterBase::key(), and fhicl::detail::strip_first_containing_name().

Referenced by do_set_value().

   {
     // Kind of tricky: we do not have the name of the current
     // parameter set.  A placeholder is often used
     // (e.g. "<top_level>").  Fortunately, since the pset is passed
     // in, we can just assign to it for a top-level ParameterSet.
     // However, for nested parameter sets, we need to trim off the
     // placeholder, and then the key we send
     // pset.get<fhicl::ParameterSet>(key) is the key relative to the
     // top-level pset.
     std::string const& rkey = key();
     std::string const& nkey = strip_first_containing_name(rkey);
     if (nkey == rkey) {
       return std::make_optional(pset);
     }
     return pset.get_if_present<ParameterSet>(nkey);
   }

std::vector< cet::exempt_ptr< ParameterBase > > const & fhicl::detail::TableBase::members ( ) const

Definition at line 31 of file TableBase.cc.

References members_.

   {
     return members_;
   }

std::string const & fhicl::detail::ParameterBase::name ( ) const

inherited

Definition at line 11 of file ParameterBase.cc.

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

Referenced by fhicl::Atom< T >::Atom(), fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::detail::ValidateThenSet::delegated_parameter(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalAtom< T >::OptionalAtom(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalSequence< T, N >::OptionalSequence(), fhicl::OptionalSequence< T,-1ull >::OptionalSequence(), fhicl::OptionalTable< T >::OptionalTable(), fhicl::OptionalTuple< T >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::Sequence< T, N >::Sequence(), fhicl::Sequence< T,-1ull >::Sequence(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::Table< T, KeysToIgnore >::Table(), TableBase(), and fhicl::Tuple< T >::Tuple().

   {
     return mdata_.name();
   }

par_type fhicl::detail::ParameterBase::parameter_type ( ) const

inherited

Definition at line 36 of file ParameterBase.cc.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), and fhicl::detail::RegisterIfTableMember::RegisterIfTableMember().

   {
     return mdata_.type();
   }

bool fhicl::detail::ParameterBase::preset_value ( fhicl::ParameterSet const & ps )

inherited

Definition at line 63 of file ParameterBase.cc.

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

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

   {
     return do_preset_value(ps);
   }

void fhicl::detail::TableBase::print_allowed_configuration	(	std::ostream &	os,
		std::string const &	tab = `std::string(3, ' ')`
	)		const

Definition at line 22 of file TableBase.cc.

References fhicl::detail::optional_parameter_message(), and fhicl::detail::ParameterWalker< C >::walk_over().

Referenced by art::operator<<(), and fhicl::detail::operator<<().

   {
     os << '\n' << tab << optional_parameter_message() << '\n';
     PrintAllowedConfiguration pc{os, false, tab};
     pc.walk_over(*this);
   }

std::optional< ParameterSet > fhicl::detail::TableBase::select_pset ( ParameterSet const & pset ) const

private

Definition at line 92 of file TableBase.cc.

References fhicl::ParameterSet::get(), fhicl::detail::ParameterBase::key(), and fhicl::detail::strip_first_containing_name().

Referenced by do_set_value().

   {
     // Kind of tricky: we do not have the name of the current
     // parameter set.  A placeholder is often used (e.g. "<top_level>").
     // Fortunately, since the pset is passed in, we can just assign to
     // it for a top-level ParameterSet.  However, for nested parameter
     // sets, we need to trim off the placeholder, and then the key we
     // send pset.get<fhicl::ParameterSet>(key) is the key relative to
     // the top-level pset.
     std::string const& rkey = key();
     std::string const& nkey = strip_first_containing_name(rkey);
     if (nkey == rkey) {
       return std::make_optional(pset);
     }
     return pset.get<ParameterSet>(nkey);
   }

void fhicl::detail::ParameterBase::set_par_style ( par_style const vt )

inherited

Definition at line 68 of file ParameterBase.cc.

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

Referenced by maybe_implicitly_default(), and fhicl::TableAs< T, Config >::TableAs().

   {
     mdata_.set_par_style(vt);
   }

void fhicl::detail::ParameterBase::set_value ( fhicl::ParameterSet const & ps )

inherited

Definition at line 58 of file ParameterBase.cc.

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

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

   {
     do_set_value(ps);
   }

bool fhicl::detail::ParameterBase::should_use ( ) const

inherited

Definition at line 41 of file ParameterBase.cc.

References fhicl::detail::ParameterBase::maybeUse_.

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

   {
     return maybeUse_();
   }

void fhicl::detail::TableBase::validate	(	ParameterSet const &	pset,
		std::set< std::string > const &	ignorable_keys = `{}`
	)

Definition at line 56 of file TableBase.cc.

References fhicl::NameStackRegistry::clear(), members_, and pset_.

Referenced by fhicl::OptionalTable< T >::OptionalTable(), and fhicl::Table< T, KeysToIgnore >::Table().

   {
     pset_ = std::make_optional(pset);
     ValidateThenSet vs{pset, ignorable_keys};
     cet::for_all(members_, [&vs](auto m) { vs.walk_over(*m); });
 
     try {
       vs.check_keys();
     }
     catch (detail::validationException const&) {
       NameStackRegistry::clear();
       throw;
     }
   }

Member Data Documentation

std::vector<cet::exempt_ptr<ParameterBase> > fhicl::detail::TableBase::members_

private

Definition at line 45 of file TableBase.h.

Referenced by finalize_members(), maybe_implicitly_default(), members(), and validate().

std::optional<ParameterSet> fhicl::detail::TableBase::pset_

private

Definition at line 44 of file TableBase.h.

Referenced by do_set_value(), get_pset(), guarantee_pset(), has_value(), and validate().

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

fhiclcpp/types/detail/TableBase.h
fhiclcpp/types/detail/TableBase.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation