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

#include "/cvmfs/nova.opensciencegrid.org/externals/fhiclcpp/v4_06_10/source/fhiclcpp/types/detail/SequenceBase.h"

Inheritance diagram for fhicl::detail::SequenceBase:
fhicl::detail::ParameterBase fhicl::OptionalSequence< T, N > fhicl::OptionalSequence< T,-1ull > fhicl::OptionalTuple< TYPES > fhicl::Sequence< T, N > fhicl::Sequence< T,-1ull > fhicl::Tuple< TYPES > fhicl::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > > fhicl::OptionalTuple< ARGS... > fhicl::Sequence< double > fhicl::Sequence< int > fhicl::Sequence< std::string > fhicl::Sequence< string >

Public Member Functions

 SequenceBase (Name &&name, Comment &&comment, par_style const vt, par_type const type, std::function< bool()> maybeUse)
 
bool empty () const
 
std::size_t size () const
 
void prepare_elements_for_validation (std::size_t const n)
 
void walk_elements (ParameterWalker< tt::const_flavor::require_non_const > &pw)
 
void walk_elements (ParameterWalker< tt::const_flavor::require_const > &pw) 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::size_t get_size () const =0
 
virtual void do_prepare_elements_for_validation (std::size_t)=0
 
virtual void do_walk_elements (ParameterWalker< tt::const_flavor::require_non_const > &)=0
 
virtual void do_walk_elements (ParameterWalker< tt::const_flavor::require_const > &) const =0
 

Detailed Description

Definition at line 18 of file SequenceBase.h.

Constructor & Destructor Documentation

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

Definition at line 20 of file SequenceBase.h.

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

25  : ParameterBase{name, comment, vt, type, maybeUse}
26  {}
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

std::string fhicl::detail::ParameterBase::comment ( ) const
inlineinherited
virtual void fhicl::detail::SequenceBase::do_prepare_elements_for_validation ( std::size_t  )
privatepure virtual
virtual void fhicl::detail::SequenceBase::do_walk_elements ( ParameterWalker< tt::const_flavor::require_non_const > &  )
privatepure virtual
virtual void fhicl::detail::SequenceBase::do_walk_elements ( ParameterWalker< tt::const_flavor::require_const > &  ) const
privatepure virtual
bool fhicl::detail::SequenceBase::empty ( ) const
inline

Definition at line 29 of file SequenceBase.h.

References size().

30  {
31  return size() == 0;
32  }
std::size_t size() const
Definition: SequenceBase.h:34
virtual std::size_t fhicl::detail::SequenceBase::get_size ( ) 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 fhicl::detail::ParameterBase::key ( ) const
inlineinherited
std::string fhicl::detail::ParameterBase::name ( ) const
inlineinherited
par_type fhicl::detail::ParameterBase::parameter_type ( ) const
inlineinherited
void fhicl::detail::SequenceBase::prepare_elements_for_validation ( std::size_t const  n)
inline

Definition at line 40 of file SequenceBase.h.

References do_prepare_elements_for_validation().

41  {
43  }
virtual void do_prepare_elements_for_validation(std::size_t)=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().

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_
std::size_t fhicl::detail::SequenceBase::size ( void  ) const
inline

Definition at line 34 of file SequenceBase.h.

References get_size().

Referenced by empty().

35  {
36  return get_size();
37  }
virtual std::size_t get_size() const =0
void fhicl::detail::SequenceBase::walk_elements ( ParameterWalker< tt::const_flavor::require_non_const > &  pw)
inline

Definition at line 45 of file SequenceBase.h.

References do_walk_elements().

46  {
47  do_walk_elements(pw);
48  }
virtual void do_walk_elements(ParameterWalker< tt::const_flavor::require_non_const > &)=0
void fhicl::detail::SequenceBase::walk_elements ( ParameterWalker< tt::const_flavor::require_const > &  pw) const
inline

Definition at line 50 of file SequenceBase.h.

References do_prepare_elements_for_validation(), do_walk_elements(), and get_size().

51  {
52  do_walk_elements(pw);
53  }
virtual void do_walk_elements(ParameterWalker< tt::const_flavor::require_non_const > &)=0

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