fhicl::detail::SearchAllowedConfiguration Class Reference

#include "SearchAllowedConfiguration.h"

Inheritance diagram for fhicl::detail::SearchAllowedConfiguration:

Public Member Functions
void	walk_over (tt::maybe_const_t< ParameterBase, C > &)
bool	do_before_action (tt::maybe_const_t< ParameterBase, C > &p)
void	do_after_action (tt::maybe_const_t< ParameterBase, C > &p)
void	do_enter_table (tt::maybe_const_t< TableBase, C > &t)
void	do_exit_table (tt::maybe_const_t< TableBase, C > &t)
void	do_enter_sequence (tt::maybe_const_t< SequenceBase, C > &s)
void	do_exit_sequence (tt::maybe_const_t< SequenceBase, C > &s)
void	do_atom (tt::maybe_const_t< AtomBase, C > &a)
void	do_delegated_parameter (tt::maybe_const_t< DelegateBase, C > &dp)

Static Public Member Functions
static bool	supports_key (ParameterBase const &pb, std::string const &searched_for_key)

Private Member Functions
	SearchAllowedConfiguration (ParameterBase const &pb, std::string const &searched_for_key)
bool	result () const
bool	before_action (ParameterBase const &pb) override
void	enter_table (TableBase const &) override
void	enter_sequence (SequenceBase const &) override
void	atom (AtomBase const &) override
void	delegated_parameter (DelegateBase const &) override

Static Private Member Functions
static std::string	form_absolute (ParameterBase const &pb, std::string const &searched_for_key)

Private Attributes
std::string	key_
bool	supportsKey_ {false}

Detailed Description

Definition at line 52 of file SearchAllowedConfiguration.h.

Constructor & Destructor Documentation

SearchAllowedConfiguration::SearchAllowedConfiguration ( ParameterBase const &  pb, std::string const &  searched_for_key  )

private

Definition at line 15 of file SearchAllowedConfiguration.cc.

References form_absolute().

  : key_{form_absolute(pb, searched_for_key)}
{}

Member Function Documentation

void fhicl::detail::SearchAllowedConfiguration::atom ( AtomBase const &  )

inlineoverrideprivate

Definition at line 79 of file SearchAllowedConfiguration.h.

      {}

bool SearchAllowedConfiguration::before_action ( ParameterBase const &  pb )

overrideprivate

Definition at line 22 of file SearchAllowedConfiguration.cc.

References fhicl::detail::ParameterBase::key(), key_, and supportsKey_.

Referenced by result().

{
  supportsKey_ = supportsKey_ || pb.key() == key_;
  // If supportsKey_ is true, then a match has been found, and no
  // extra tree-walking is required--so this function should
  // return false.  If supportsKey_ is false, then continue
  // looking through the tree to see if another parameter
  // matches--i.e. it should return true.
  return !supportsKey_;
}

void fhicl::detail::SearchAllowedConfiguration::delegated_parameter ( DelegateBase const &  )

inlineoverrideprivate

Definition at line 82 of file SearchAllowedConfiguration.h.

References form_absolute().

      {}

void fhicl::detail::ParameterWalker< C >::do_after_action ( tt::maybe_const_t< ParameterBase, C > &  p )

inlineinherited

Definition at line 98 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::after_action().

      {
        after_action(p);
      }

void fhicl::detail::ParameterWalker< C >::do_atom ( tt::maybe_const_t< AtomBase, C > &  a )

inlineinherited

Definition at line 126 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::atom().

      {
        atom(a);
      }

bool fhicl::detail::ParameterWalker< C >::do_before_action ( tt::maybe_const_t< ParameterBase, C > &  p )

inlineinherited

Definition at line 93 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::before_action().

      {
        return before_action(p);
      }

void fhicl::detail::ParameterWalker< C >::do_delegated_parameter ( tt::maybe_const_t< DelegateBase, C > &  dp )

inlineinherited

Definition at line 132 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::atom(), fhicl::detail::ParameterWalker< C >::delegated_parameter(), fhicl::detail::ParameterWalker< C >::enter_sequence(), and fhicl::detail::ParameterWalker< C >::enter_table().

      {
        delegated_parameter(dp);
      }

void fhicl::detail::ParameterWalker< C >::do_enter_sequence ( tt::maybe_const_t< SequenceBase, C > &  s )

inlineinherited

Definition at line 115 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::enter_sequence().

      {
        enter_sequence(s);
      }

void fhicl::detail::ParameterWalker< C >::do_enter_table ( tt::maybe_const_t< TableBase, C > &  t )

inlineinherited

Definition at line 104 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::enter_table().

      {
        enter_table(t);
      }

void fhicl::detail::ParameterWalker< C >::do_exit_sequence ( tt::maybe_const_t< SequenceBase, C > &  s )

inlineinherited

Definition at line 120 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::exit_sequence().

      {
        exit_sequence(s);
      }

void fhicl::detail::ParameterWalker< C >::do_exit_table ( tt::maybe_const_t< TableBase, C > &  t )

inlineinherited

Definition at line 109 of file ParameterWalker.h.

References fhicl::detail::ParameterWalker< C >::exit_table().

      {
        exit_table(t);
      }

void fhicl::detail::SearchAllowedConfiguration::enter_sequence ( SequenceBase const &  )

inlineoverrideprivate

Definition at line 76 of file SearchAllowedConfiguration.h.

      {}

void fhicl::detail::SearchAllowedConfiguration::enter_table ( TableBase const &  )

inlineoverrideprivate

Definition at line 73 of file SearchAllowedConfiguration.h.

      {}

std::string SearchAllowedConfiguration::form_absolute ( ParameterBase const &  pb, std::string const &  searched_for_key  )

staticprivate

Definition at line 34 of file SearchAllowedConfiguration.cc.

References fhicl::detail::is_sequence(), fhicl::detail::is_table(), fhicl::detail::ParameterBase::key(), fhicl::other, fhicl::detail::ParameterBase::parameter_type(), and pt.

Referenced by delegated_parameter(), and SearchAllowedConfiguration().

{
  if (searched_for_key.empty()) {
    throw exception{error::other, "SearchAllowedConfiguration::form_absolute"}
      << "The specified searched-for key is empty.\n";
  }

  auto const pt = pb.parameter_type();
  if (!is_table(pt) && !is_sequence(pt)) {
    throw exception{error::other, "SearchAllowedConfiguration::form_absolute"}
      << "Attempt to search for '" << searched_for_key
      << "' as supported by a\n"
      << "parameter that is not a table or sequence.\n";
  }

  // assume searched-for key is meant to be relative to the
  // top_level_key.
  std::string const appending_character{is_table(pt) ? "." : ""};
  std::string absolute_key{pb.key()};
  absolute_key += appending_character;
  absolute_key += searched_for_key;
  return absolute_key;
}

bool fhicl::detail::SearchAllowedConfiguration::result ( void  ) const

inlineprivate

Definition at line 66 of file SearchAllowedConfiguration.h.

References before_action(), and supportsKey_.

      {
        return supportsKey_;
      };

bool SearchAllowedConfiguration::supports_key ( ParameterBase const &  pb, std::string const &  searched_for_key  )

static

Definition at line 7 of file SearchAllowedConfiguration.cc.

Referenced by art::detail::supports_key().

{
  SearchAllowedConfiguration sac{pb, searched_for_key};
  sac.walk_over(pb);
  return sac.result();
}

void fhicl::detail::ParameterWalker< C >::walk_over ( tt::maybe_const_t< ParameterBase, C > &  )

inherited

Member Data Documentation

std::string fhicl::detail::SearchAllowedConfiguration::key_

private

Definition at line 59 of file SearchAllowedConfiguration.h.

Referenced by before_action().

bool fhicl::detail::SearchAllowedConfiguration::supportsKey_ {false}

private

Definition at line 60 of file SearchAllowedConfiguration.h.

Referenced by before_action(), and result().

---

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

• fhiclcpp/types/detail/SearchAllowedConfiguration.h
• fhiclcpp/types/detail/SearchAllowedConfiguration.cc