LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
fhicl::ParameterSetWalker Class Referenceabstract

#include "ParameterSetWalker.h"

Inheritance diagram for fhicl::ParameterSetWalker:
evgen::MarleyParameterSetWalker fhicl::detail::KeyAssembler fhicl::detail::Prettifier fhicl::detail::PrettifierAnnotated fhicl::detail::PrettifierPrefixAnnotated fhicl::detail::ValuePrinter

Public Types

using key_t = std::string
 
using any_t = std::any
 

Public Member Functions

virtual ~ParameterSetWalker () noexcept=default
 
void do_enter_table (key_t const &k, any_t const &a)
 
void do_enter_sequence (key_t const &k, any_t const &a)
 
void do_atom (key_t const &k, any_t const &a)
 
void do_before_action (key_t const &k, any_t const &a, ParameterSet const *ps)
 
void do_after_action (key_t const &k)
 
void do_exit_table (key_t const &k, any_t const &a)
 
void do_exit_sequence (key_t const &k, any_t const &a)
 

Private Member Functions

virtual void enter_table (key_t const &, any_t const &)=0
 
virtual void enter_sequence (key_t const &, any_t const &)=0
 
virtual void atom (key_t const &, any_t const &)=0
 
virtual void exit_table (key_t const &, any_t const &)
 
virtual void exit_sequence (key_t const &, any_t const &)
 
virtual void before_action (key_t const &, any_t const &, ParameterSet const *)
 
virtual void after_action (key_t const &)
 

Detailed Description

Definition at line 74 of file ParameterSetWalker.h.

Member Typedef Documentation

Definition at line 79 of file ParameterSetWalker.h.

using fhicl::ParameterSetWalker::key_t = std::string

Definition at line 78 of file ParameterSetWalker.h.

Constructor & Destructor Documentation

virtual fhicl::ParameterSetWalker::~ParameterSetWalker ( )
virtualdefaultnoexcept

Member Function Documentation

virtual void fhicl::ParameterSetWalker::after_action ( key_t const &  )
inlineprivatevirtual

Reimplemented in fhicl::detail::PrettifierAnnotated, and fhicl::detail::ValuePrinter.

Definition at line 136 of file ParameterSetWalker.h.

Referenced by do_after_action().

137  {}
virtual void fhicl::ParameterSetWalker::atom ( key_t const &  ,
any_t const &   
)
privatepure virtual
virtual void fhicl::ParameterSetWalker::before_action ( key_t const &  ,
any_t const &  ,
ParameterSet const *   
)
inlineprivatevirtual
void fhicl::ParameterSetWalker::do_after_action ( key_t const &  k)
inline

Definition at line 103 of file ParameterSetWalker.h.

References after_action().

Referenced by fhicl::ParameterSet::walk().

104  {
105  after_action(k);
106  }
virtual void after_action(key_t const &)
void fhicl::ParameterSetWalker::do_atom ( key_t const &  k,
any_t const &  a 
)
inline

Definition at line 92 of file ParameterSetWalker.h.

References atom().

Referenced by fhicl::ParameterSet::walk().

93  {
94  atom(k, a);
95  }
virtual void atom(key_t const &, any_t const &)=0
void fhicl::ParameterSetWalker::do_before_action ( key_t const &  k,
any_t const &  a,
ParameterSet const *  ps 
)
inline

Definition at line 98 of file ParameterSetWalker.h.

References before_action().

Referenced by fhicl::ParameterSet::walk().

99  {
100  before_action(k, a, ps);
101  }
virtual void before_action(key_t const &, any_t const &, ParameterSet const *)
void fhicl::ParameterSetWalker::do_enter_sequence ( key_t const &  k,
any_t const &  a 
)
inline

Definition at line 87 of file ParameterSetWalker.h.

References enter_sequence().

Referenced by fhicl::ParameterSet::walk().

88  {
89  enter_sequence(k, a);
90  }
virtual void enter_sequence(key_t const &, any_t const &)=0
void fhicl::ParameterSetWalker::do_enter_table ( key_t const &  k,
any_t const &  a 
)
inline

Definition at line 82 of file ParameterSetWalker.h.

References enter_table().

Referenced by fhicl::ParameterSet::walk().

83  {
84  enter_table(k, a);
85  }
virtual void enter_table(key_t const &, any_t const &)=0
void fhicl::ParameterSetWalker::do_exit_sequence ( key_t const &  k,
any_t const &  a 
)
inline

Definition at line 114 of file ParameterSetWalker.h.

References atom(), enter_sequence(), enter_table(), and exit_sequence().

Referenced by fhicl::ParameterSet::walk().

115  {
116  exit_sequence(k, a);
117  }
virtual void exit_sequence(key_t const &, any_t const &)
void fhicl::ParameterSetWalker::do_exit_table ( key_t const &  k,
any_t const &  a 
)
inline

Definition at line 109 of file ParameterSetWalker.h.

References exit_table().

Referenced by fhicl::ParameterSet::walk().

110  {
111  exit_table(k, a);
112  }
virtual void exit_table(key_t const &, any_t const &)
virtual void fhicl::ParameterSetWalker::enter_sequence ( key_t const &  ,
any_t const &   
)
privatepure virtual
virtual void fhicl::ParameterSetWalker::enter_table ( key_t const &  ,
any_t const &   
)
privatepure virtual
virtual void fhicl::ParameterSetWalker::exit_sequence ( key_t const &  ,
any_t const &   
)
inlineprivatevirtual
virtual void fhicl::ParameterSetWalker::exit_table ( key_t const &  ,
any_t const &   
)
inlineprivatevirtual

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