fhicl::detail::TableBase Class Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/fhiclcpp/v4_11_01/source/fhiclcpp/types/detail/TableBase.h"

Inheritance diagram for fhicl::detail::TableBase:

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 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 trimParents)
void	set_par_style (par_style const vt)

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.

        : ParameterBase{name, comment, vt, par_type::TABLE, maybeUse}
      {}

Member Function Documentation

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

inlineinherited

Definition at line 54 of file ParameterBase.h.

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

Referenced by fhicl::Atom< T >::Atom(), fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::OptionalAtom< T >::OptionalAtom(), 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();
      }

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< art::TimeTracker::Config::DBoutput >, fhicl::Table< calib::calib::ShapeTableParams >, fhicl::Table< T >, fhicl::Table< rsim::GainParams >, fhicl::Table< art::detail::Analyzer::Table::FullConfig< UserConfig >, KeysToIgnore_t >, fhicl::Table< T, fhicl::KeysToIgnore >, fhicl::Table< art::ToolConfigTable::FullConfig< UserConfig >, KeysToIgnore_t >, fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >, fhicl::OptionalTable< T >, and fhicl::OptionalTable< art::Scheduler::Config::DebugConfig >.

Referenced by members().

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

inlineinherited

Definition at line 59 of file ParameterBase.h.

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

Referenced by fhicl::Atom< T >::do_set_value(), and fhicl::Atom< T >::get_stringified_value().

      {
        return mdata_.has_default();
      }

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

inlineinherited

Definition at line 69 of file ParameterBase.h.

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

      {
        return mdata_.is_conditional();
      }

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

inlineinherited

Definition at line 64 of file ParameterBase.h.

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

      {
        return mdata_.is_optional();
      }

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

inlineinherited

Definition at line 44 of file ParameterBase.h.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::cacheTopLevelParameter(), fhicl::OptionalSequence< T, N >::do_prepare_elements_for_validation(), fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::Atom< T >::do_set_value(), fhicl::OptionalAtom< T >::do_set_value(), fhicl::OptionalTable< T >::do_set_value(), fhicl::Table< T, KeysToIgnore >::do_set_value(), 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().

      {
        return mdata_.key();
      }

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

inline

Definition at line 24 of file TableBase.h.

References get_members().

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

      {
        return get_members();
      }

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

inlineinherited

Definition at line 49 of file ParameterBase.h.

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

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), std_candles.StdCandlesPlotter::IsMC(), fhicl::detail::ParameterBase::ParameterBase(), run_unfold_ppfx_multiprocess.Consumer::run(), run_unfold_systs_multiprocess.Consumer::run(), run_unfold_genie_multiprocess.Consumer::run(), fhicl::detail::SequenceBase::SequenceBase(), and TableBase().

      {
        return mdata_.name();
      }

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

inlineinherited

Definition at line 74 of file ParameterBase.h.

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

Referenced by fhicl::detail::RegisterIfTableMember::RegisterIfTableMember().

      {
        return mdata_.type();
      }

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

inlineinherited

Definition at line 101 of file ParameterBase.h.

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

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

      {
        mdata_.set_par_style(vt);
      }

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

      {
        do_set_value(ps, trimParents);
      }

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

inlineinherited

Definition at line 79 of file ParameterBase.h.

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

      {
        return maybeUse_();
      }

---

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

• fhiclcpp/types/detail/TableBase.h