Public Member Functions | Private Member Functions | Private Attributes | List of all members
fhicl::detail::PrintAllowedConfiguration Class Reference

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

Inheritance diagram for fhicl::detail::PrintAllowedConfiguration:
fhicl::detail::ParameterWalker< tt::const_flavor::require_const >

Public Member Functions

 PrintAllowedConfiguration (std::ostream &os, bool const showParents=false, std::string const &prefix=std::string(3, ' '), bool const stlf=false)
 
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)
 

Private Member Functions

bool before_action (ParameterBase const &) override
 
void after_action (ParameterBase const &) override
 
void enter_table (TableBase const &) override
 
void exit_table (TableBase const &) override
 
void enter_sequence (SequenceBase const &) override
 
void exit_sequence (SequenceBase const &) override
 
void atom (AtomBase const &) override
 
void delegated_parameter (DelegateBase const &) override
 
void cacheTopLevelParameter (ParameterBase const &p)
 
void maybeReleaseTopLevelParameter (ParameterBase const &p)
 
bool suppressFormat (ParameterBase const &p)
 

Private Attributes

std::ostream & buffer_
 
Indentation indent_
 
bool suppressTopLevelFormatting_
 
std::string cachedTopLevelParameter_ {}
 
std::stack< MaybeDisplayParentmps_ {}
 
std::unordered_set< std::stringkeysWithCommas_ {}
 
std::unordered_set< std::stringkeysWithEllipses_ {}
 
bool showParentsForFirstParam_
 

Detailed Description

Definition at line 18 of file PrintAllowedConfiguration.h.

Constructor & Destructor Documentation

fhicl::detail::PrintAllowedConfiguration::PrintAllowedConfiguration ( std::ostream &  os,
bool const  showParents = false,
std::string const &  prefix = std::string(3, ' '),
bool const  stlf = false 
)

Member Function Documentation

void fhicl::detail::PrintAllowedConfiguration::after_action ( ParameterBase const &  )
overrideprivate
void fhicl::detail::PrintAllowedConfiguration::atom ( AtomBase const &  )
overrideprivate
bool fhicl::detail::PrintAllowedConfiguration::before_action ( ParameterBase const &  )
overrideprivate
void fhicl::detail::PrintAllowedConfiguration::cacheTopLevelParameter ( ParameterBase const &  p)
inlineprivate

Definition at line 50 of file PrintAllowedConfiguration.h.

References cachedTopLevelParameter_, and fhicl::detail::ParameterBase::key().

51  {
52  if (cachedTopLevelParameter_ == "")
54  }
const char * p
Definition: xmltok.h:285
void fhicl::detail::PrintAllowedConfiguration::delegated_parameter ( DelegateBase const &  )
overrideprivate
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().

99  {
100  after_action(p);
101  }
const char * p
Definition: xmltok.h:285
virtual void after_action(tt::maybe_const_t< ParameterBase, C > &)
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().

127  {
128  atom(a);
129  }
const double a
virtual void atom(tt::maybe_const_t< AtomBase, C > &)=0
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().

94  {
95  return before_action(p);
96  }
const char * p
Definition: xmltok.h:285
virtual bool before_action(tt::maybe_const_t< ParameterBase, C > &)
void fhicl::detail::ParameterWalker< C >::do_delegated_parameter ( tt::maybe_const_t< DelegateBase, C > &  dp)
inlineinherited
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().

116  {
117  enter_sequence(s);
118  }
const XML_Char * s
Definition: expat.h:262
virtual void enter_sequence(tt::maybe_const_t< SequenceBase, C > &)=0
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().

105  {
106  enter_table(t);
107  }
virtual void enter_table(tt::maybe_const_t< TableBase, C > &)=0
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().

121  {
122  exit_sequence(s);
123  }
virtual void exit_sequence(tt::maybe_const_t< SequenceBase, C > &)
const XML_Char * s
Definition: expat.h:262
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().

110  {
111  exit_table(t);
112  }
virtual void exit_table(tt::maybe_const_t< TableBase, C > &)
void fhicl::detail::PrintAllowedConfiguration::enter_sequence ( SequenceBase const &  )
overrideprivate
void fhicl::detail::PrintAllowedConfiguration::enter_table ( TableBase const &  )
overrideprivate
void fhicl::detail::PrintAllowedConfiguration::exit_sequence ( SequenceBase const &  )
overrideprivate
void fhicl::detail::PrintAllowedConfiguration::exit_table ( TableBase const &  )
overrideprivate
void fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter ( ParameterBase const &  p)
inlineprivate

Definition at line 57 of file PrintAllowedConfiguration.h.

References cachedTopLevelParameter_, and fhicl::detail::ParameterBase::key().

58  {
59  if (p.key() == cachedTopLevelParameter_)
61  }
const char * p
Definition: xmltok.h:285
bool fhicl::detail::PrintAllowedConfiguration::suppressFormat ( ParameterBase const &  p)
inlineprivate

Definition at line 64 of file PrintAllowedConfiguration.h.

References cachedTopLevelParameter_, and fhicl::detail::ParameterBase::key().

65  {
66  return p.key() == cachedTopLevelParameter_;
67  }
const char * p
Definition: xmltok.h:285

Member Data Documentation

std::ostream& fhicl::detail::PrintAllowedConfiguration::buffer_
private

Definition at line 27 of file PrintAllowedConfiguration.h.

std::string fhicl::detail::PrintAllowedConfiguration::cachedTopLevelParameter_ {}
private
Indentation fhicl::detail::PrintAllowedConfiguration::indent_
private

Definition at line 28 of file PrintAllowedConfiguration.h.

std::unordered_set<std::string> fhicl::detail::PrintAllowedConfiguration::keysWithCommas_ {}
private

Definition at line 32 of file PrintAllowedConfiguration.h.

std::unordered_set<std::string> fhicl::detail::PrintAllowedConfiguration::keysWithEllipses_ {}
private

Definition at line 33 of file PrintAllowedConfiguration.h.

std::stack<MaybeDisplayParent> fhicl::detail::PrintAllowedConfiguration::mps_ {}
private

Definition at line 31 of file PrintAllowedConfiguration.h.

bool fhicl::detail::PrintAllowedConfiguration::showParentsForFirstParam_
private

Definition at line 34 of file PrintAllowedConfiguration.h.

bool fhicl::detail::PrintAllowedConfiguration::suppressTopLevelFormatting_
private

Definition at line 29 of file PrintAllowedConfiguration.h.


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