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

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

Member Function Documentation

std::string 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::detail::AtomBase::AtomBase(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::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::Tuple< TYPES >, fhicl::Sequence< T, N >, fhicl::Sequence< double >, fhicl::Sequence< std::string >, fhicl::Sequence< float >, fhicl::Sequence< int >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::OptionalTuple< TYPES >, fhicl::OptionalTuple< ARGS... >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< art::InputTag >, and fhicl::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >.

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::Tuple< TYPES >, fhicl::Sequence< T, N >, fhicl::Sequence< double >, fhicl::Sequence< std::string >, fhicl::Sequence< float >, fhicl::Sequence< int >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::OptionalTuple< TYPES >, fhicl::OptionalTuple< ARGS... >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< art::InputTag >, and fhicl::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >.

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::Tuple< TYPES >, fhicl::Sequence< T, N >, fhicl::Sequence< double >, fhicl::Sequence< std::string >, fhicl::Sequence< float >, fhicl::Sequence< int >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::OptionalTuple< TYPES >, fhicl::OptionalTuple< ARGS... >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< art::InputTag >, and fhicl::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >.

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

inline

Definition at line 29 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 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< int >, fhicl::Sequence< double, 3 >, fhicl::Sequence< string >, fhicl::Sequence< fhicl::Sequence< double > >, fhicl::Sequence< float, 3u >, fhicl::Tuple< TYPES >, fhicl::OptionalSequence< T, N >, fhicl::OptionalSequence< art::InputTag >, fhicl::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >, fhicl::OptionalTuple< TYPES >, and fhicl::OptionalTuple< ARGS... >.

Referenced by size(), and walk_elements().

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::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), and fhicl::detail::PrintAllowedConfiguration::enter_sequence().

      {
        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_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), and fhicl::detail::PrintAllowedConfiguration::before_action().

      {
        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_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::before_action(), and evgen::MARLEYHelper::fhicl_parameter_to_json().

      {
        return mdata_.is_optional();
      }

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

inlineinherited

Definition at line 44 of file ParameterBase.h.

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::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >::do_prepare_elements_for_validation(), fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::detail::ValidateThenSet::enter_sequence(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), 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::string fhicl::detail::ParameterBase::name ( ) const

inlineinherited

Definition at line 49 of file ParameterBase.h.

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

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::detail::ValidateThenSet::delegated_parameter(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::Tuple().

      {
        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::PrintAllowedConfiguration::after_action(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), 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 40 of file SequenceBase.h.

References do_prepare_elements_for_validation().

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

      {
        do_prepare_elements_for_validation(n);
      }

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

inlineinherited

Definition at line 106 of file ParameterBase.h.

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

      {
        mdata_.set_key(key);
      }

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

inlineinherited

Definition at line 101 of file ParameterBase.h.

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

Referenced by art::RootOutput::Config::Config().

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

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

      {
        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_.

Referenced by fhicl::detail::ValidateThenSet::before_action(), and evgen::MARLEYHelper::fhicl_parameter_to_json().

      {
        return 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(), and fhicl::detail::PrintAllowedConfiguration::enter_sequence().

      {
        return get_size();
      }

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

      {
        do_walk_elements(pw);
      }

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

      {
        do_walk_elements(pw);
      }

---

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

• fhiclcpp/types/detail/SequenceBase.h