Public Member Functions | Private Member Functions | List of all members
fhicl::detail::TableBase Class Referenceabstract

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

Inheritance diagram for fhicl::detail::TableBase:
fhicl::detail::ParameterBase fhicl::OptionalTable< T > fhicl::Table< T, KeysToIgnore > fhicl::OptionalTable< art::Scheduler::Config::DebugConfig > fhicl::Table< art::detail::Analyzer::Table::FullConfig< UserConfig >, KeysToIgnore_t > fhicl::Table< art::ProducerTable::FullConfig< UserConfig, ImplicitConfig >, KeysToIgnore_t > fhicl::Table< art::TimeTracker::Config::DBoutput > fhicl::Table< art::ToolConfigTable::FullConfig< UserConfig >, KeysToIgnore_t > fhicl::Table< calib::calib::ShapeTableParams > fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config > fhicl::Table< rsim::GainParams > fhicl::Table< T > fhicl::Table< T, fhicl::KeysToIgnore >

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.

20  : ParameterBase{name, comment, vt, par_type::TABLE, maybeUse}
21  {}
std::string const & name() const
Definition: ParameterBase.h:49
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 const & comment() const
Definition: ParameterBase.h:54

Member Function Documentation

std::string const& fhicl::detail::ParameterBase::comment ( ) const
inlineinherited
virtual std::vector<cet::exempt_ptr<ParameterBase> > const& fhicl::detail::TableBase::get_members ( ) const
privatepure virtual
bool fhicl::detail::ParameterBase::has_default ( ) const
inlineinherited
bool fhicl::detail::ParameterBase::is_conditional ( ) const
inlineinherited
bool fhicl::detail::ParameterBase::is_optional ( ) const
inlineinherited
std::string const& fhicl::detail::ParameterBase::key ( ) const
inlineinherited
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().

25  {
26  return get_members();
27  }
virtual std::vector< cet::exempt_ptr< ParameterBase > > const & get_members() const =0
std::string const& fhicl::detail::ParameterBase::name ( ) const
inlineinherited
par_type fhicl::detail::ParameterBase::parameter_type ( ) const
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().

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

Definition at line 79 of file ParameterBase.h.

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

80  {
81  return maybeUse_();
82  }
std::function< bool()> maybeUse_

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