fhicl::detail::SequenceBase Class Reference

#include "SequenceBase.h"

Inheritance diagram for fhicl::detail::SequenceBase:

Public Member Functions
	SequenceBase (Name &&name, Comment &&comment, par_style const vt, par_type const type, std::function< bool()> maybeUse)
bool	empty () const noexcept
std::size_t	size () const noexcept
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 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::size_t	get_size () const noexcept=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 17 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 19 of file SequenceBase.h.

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

      : ParameterBase{name, comment, vt, type, maybeUse}
    {}

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(), SequenceBase(), fhicl::Table< T, KeysToIgnore >::Table(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< T >::Tuple().

  {
    return mdata_.comment();
  }

virtual void fhicl::detail::SequenceBase::do_prepare_elements_for_validation ( std::size_t  )

privatepure virtual

Implemented in fhicl::Sequence< T,-1ull >, fhicl::OptionalSequence< T,-1ull >, fhicl::Sequence< T, N >, fhicl::Sequence< double >, fhicl::Sequence< std::string >, fhicl::Sequence< float >, fhicl::Sequence< double, 5 >, fhicl::Sequence< int >, fhicl::Sequence< art::InputTag >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::Tuple< T >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< double >, fhicl::OptionalSequence< art::InputTag >, fhicl::OptionalTuple< T >, and fhicl::OptionalTuple< ARGS... >.

Referenced by prepare_elements_for_validation(), and walk_elements().

virtual void fhicl::detail::SequenceBase::do_walk_elements ( ParameterWalker< tt::const_flavor::require_non_const > &  )

privatepure virtual

Implemented in fhicl::Sequence< T,-1ull >, fhicl::OptionalSequence< T,-1ull >, fhicl::Sequence< T, N >, fhicl::Sequence< double >, fhicl::Sequence< std::string >, fhicl::Sequence< float >, fhicl::Sequence< double, 5 >, fhicl::Sequence< int >, fhicl::Sequence< art::InputTag >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::Tuple< T >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< double >, fhicl::OptionalSequence< art::InputTag >, fhicl::OptionalTuple< T >, and fhicl::OptionalTuple< ARGS... >.

Referenced by walk_elements().

virtual void fhicl::detail::SequenceBase::do_walk_elements ( ParameterWalker< tt::const_flavor::require_const > &  ) const

privatepure virtual

Implemented in fhicl::Sequence< T,-1ull >, fhicl::OptionalSequence< T,-1ull >, fhicl::Sequence< T, N >, fhicl::Sequence< double >, fhicl::Sequence< std::string >, fhicl::Sequence< float >, fhicl::Sequence< double, 5 >, fhicl::Sequence< int >, fhicl::Sequence< art::InputTag >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::Tuple< T >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< double >, fhicl::OptionalSequence< art::InputTag >, fhicl::OptionalTuple< T >, and fhicl::OptionalTuple< ARGS... >.

bool fhicl::detail::SequenceBase::empty ( ) const

inlinenoexcept

Definition at line 28 of file SequenceBase.h.

References size().

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

    {
      return size() == 0;
    }

virtual std::size_t fhicl::detail::SequenceBase::get_size ( ) const

privatepure virtualnoexcept

Implemented in fhicl::Sequence< T,-1ull >, fhicl::OptionalSequence< T,-1ull >, fhicl::Sequence< T, N >, fhicl::Sequence< double >, fhicl::Sequence< std::string >, fhicl::Sequence< float >, fhicl::Sequence< double, 5 >, fhicl::Sequence< int >, fhicl::Sequence< art::InputTag >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::Tuple< T >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< double >, fhicl::OptionalSequence< art::InputTag >, fhicl::OptionalTuple< T >, and fhicl::OptionalTuple< ARGS... >.

Referenced by size(), and walk_elements().

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

  {
    return mdata_.key();
  }

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(), SequenceBase(), fhicl::Table< T, KeysToIgnore >::Table(), fhicl::detail::TableBase::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();
  }

void fhicl::detail::SequenceBase::prepare_elements_for_validation ( std::size_t const  n )

inline

Definition at line 39 of file SequenceBase.h.

References do_prepare_elements_for_validation().

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

    {
      do_prepare_elements_for_validation(n);
    }

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::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 fhicl::detail::TableBase::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_();
  }

std::size_t fhicl::detail::SequenceBase::size ( void  ) const

inlinenoexcept

Definition at line 33 of file SequenceBase.h.

References get_size().

Referenced by empty(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::OptionalSequence< art::InputTag >::get_size(), fhicl::OptionalSequence< T,-1ull >::get_size(), geo::fhicl::readIDsequence(), and geo::fhicl::readOptionalIDsequence().

    {
      return get_size();
    }

void fhicl::detail::SequenceBase::walk_elements ( ParameterWalker< tt::const_flavor::require_non_const > &  pw )

inline

Definition at line 44 of file SequenceBase.h.

References do_walk_elements().

    {
      do_walk_elements(pw);
    }

void fhicl::detail::SequenceBase::walk_elements ( ParameterWalker< tt::const_flavor::require_const > &  pw ) const

inline

Definition at line 49 of file SequenceBase.h.

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

    {
      do_walk_elements(pw);
    }

---

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

• fhiclcpp/types/detail/SequenceBase.h