LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
fhicl::detail::AtomBase Class Referenceabstract

#include "AtomBase.h"

Inheritance diagram for fhicl::detail::AtomBase:
fhicl::detail::ParameterBase fhicl::Atom< art::InputTag > fhicl::Atom< art::ScheduleID::size_type > fhicl::Atom< bool > fhicl::Atom< double > fhicl::Atom< float > fhicl::Atom< geo::fhicl::Table::CryostatID_t > fhicl::Atom< geo::fhicl::Table::OpDetID_t > fhicl::Atom< geo::fhicl::Table::PlaneID_t > fhicl::Atom< geo::fhicl::Table::TPCID_t > fhicl::Atom< geo::fhicl::Table::WireID_t > fhicl::Atom< int > fhicl::Atom< int64_t > fhicl::Atom< Path_t::Depth_t > fhicl::Atom< Pedestal_t > fhicl::Atom< raw::ADC_Count_t > fhicl::Atom< raw::ChannelID_t > fhicl::Atom< readout::ROPID::ROPID_t > fhicl::Atom< readout::TPCsetID::TPCsetID_t > fhicl::Atom< seed_t > fhicl::Atom< size_t > fhicl::Atom< std::string > fhicl::Atom< string > fhicl::Atom< uint32_t > fhicl::Atom< unsigned > fhicl::Atom< unsigned int > fhicl::Atom< unsigned long long > fhicl::Atom< T > fhicl::OptionalAtom< T > fhicl::OptionalAtom< bool > fhicl::OptionalAtom< double > fhicl::OptionalAtom< EventNumber_t > fhicl::OptionalAtom< rndm::NuRandomService::seed_t > fhicl::OptionalAtom< RunNumber_t > fhicl::OptionalAtom< std::string > fhicl::OptionalAtom< SubRunNumber_t > fhicl::OptionalAtom< unsigned int >

Public Member Functions

 AtomBase (Name const &name, Comment const &comment, par_style const vt, std::function< bool()> maybeUse)
 
std::string stringified_value () const
 
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)
 

Private Member Functions

virtual std::string get_stringified_value () const =0
 

Detailed Description

Definition at line 8 of file AtomBase.h.

Constructor & Destructor Documentation

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

Definition at line 10 of file AtomBase.h.

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

14  : ParameterBase{name, comment, vt, par_type::ATOM, maybeUse}
15  {}
ParameterBase(Name const &name, Comment const &comment, par_style const vt, par_type const type, std::function< bool()> maybeUse=AlwaysUse())
std::string const & name() const
std::string const & comment() const

Member Function Documentation

bool fhicl::detail::ParameterBase::is_conditional ( ) const
inherited
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(), fhicl::detail::TableBase::maybe_select_pset(), fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::detail::TableBase::select_pset(), and fhicl::detail::PrintAllowedConfiguration::suppressFormat().

7  {
8  return mdata_.key();
9  }
ParameterMetadata mdata_
Definition: ParameterBase.h:63
std::string const & key() const
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().

64  {
65  return do_preset_value(ps);
66  }
virtual bool do_preset_value(fhicl::ParameterSet const &)
void fhicl::detail::ParameterBase::set_par_style ( par_style const  vt)
inherited
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().

59  {
60  do_set_value(ps);
61  }
virtual void do_set_value(fhicl::ParameterSet const &)=0
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().

42  {
43  return maybeUse_();
44  }
std::function< bool()> maybeUse_
Definition: ParameterBase.h:64
std::string fhicl::detail::AtomBase::stringified_value ( ) const
inline

Definition at line 18 of file AtomBase.h.

References get_stringified_value().

Referenced by fhicl::detail::PrintAllowedConfiguration::atom().

19  {
20  return get_stringified_value();
21  }
virtual std::string get_stringified_value() const =0

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