fhicl::Table< T, KeysToIgnore > Class Template Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/fhiclcpp/v4_11_01/source/fhiclcpp/type_traits.h"

Inheritance diagram for fhicl::Table< T, KeysToIgnore >:

Classes
struct	Impl

Public Types
using	default_type = T
using	value_type = T

Public Member Functions
template<typename... TCARGS>
	Table (Name &&name, TCARGS &&...tcargs)
template<typename... TCARGS>
	Table (Name &&name, Comment &&comment, TCARGS &&...tcargs)
template<typename... TCARGS>
	Table (Name &&name, Comment &&comment, MaybeUseFunction maybeUse, TCARGS &&...tcargs)
template<typename K = KeysToIgnore, typename = std::enable_if_t<tt::is_callable<K>::value>>
	Table (ParameterSet const &pset)
template<typename K = KeysToIgnore, typename = std::enable_if_t<!tt::is_callable<K>::value>>
	Table (ParameterSet const &pset, std::set< std::string > const &keysToIgnore={})
auto const &	operator() () const
ParameterSet const &	get_PSet () const
void	validate_ParameterSet (ParameterSet const &pset, std::set< std::string > const &keysToIgnore={})
void	print_allowed_configuration (std::ostream &os, std::string const &tab=std::string(3, ' ')) const
std::vector< cet::exempt_ptr< ParameterBase > > const &	members () 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 trimParents)
void	set_par_style (par_style const vt)

Private Types
using	members_t = std::vector< cet::exempt_ptr< ParameterBase >>

Private Member Functions
	Table (ParameterSet const &, std::set< std::string > const &, Impl)
void	maybe_implicitly_default ()
members_t const &	get_members () const override
void	do_set_value (fhicl::ParameterSet const &pset, bool const trimParents) override

Private Attributes
std::shared_ptr< T >	value_ {std::make_shared<T>()}
ParameterSet	pset_ {}
members_t	members_

Detailed Description

template<typename T, typename KeysToIgnore = void>
class fhicl::Table< T, KeysToIgnore >

Definition at line 30 of file type_traits.h.

Member Typedef Documentation

template<typename T, typename KeysToIgnore = void>

using fhicl::Table< T, KeysToIgnore >::default_type = T

Definition at line 82 of file Table.h.

template<typename T, typename KeysToIgnore = void>

using fhicl::Table< T, KeysToIgnore >::members_t = std::vector<cet::exempt_ptr<ParameterBase>>

private

Definition at line 86 of file Table.h.

template<typename T, typename KeysToIgnore = void>

using fhicl::Table< T, KeysToIgnore >::value_type = T

Definition at line 83 of file Table.h.

Constructor & Destructor Documentation

template<typename T , typename KeysToIgnore >

template<typename... TCARGS>

Table::Table ( Name &&  name, TCARGS &&...  tcargs  )

explicit

Definition at line 130 of file Table.h.

    : Table{std::move(name), Comment(""), std::forward<TCARGS>(tcargs)...}
  {}

template<typename T , typename KeysToIgnore >

template<typename... TCARGS>

Table::Table ( Name &&  name, Comment &&  comment, TCARGS &&...  tcargs  )

explicit

Definition at line 136 of file Table.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::Table< T, KeysToIgnore >::maybe_implicitly_default(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::REQUIRED, and fhicl::Table< T, KeysToIgnore >::value_.

    : TableBase{std::move(name),
                std::move(comment),
                par_style::REQUIRED,
                detail::AlwaysUse()}
    , RegisterIfTableMember{this}
    , value_{std::make_shared<T>(std::forward<TCARGS>(tcargs)...)}
  {
    maybe_implicitly_default();
    NameStackRegistry::end_of_ctor();
  }

template<typename T , typename KeysToIgnore >

template<typename... TCARGS>

Table::Table ( Name &&  name, Comment &&  comment, MaybeUseFunction  maybeUse, TCARGS &&...  tcargs  )

explicit

Definition at line 152 of file Table.h.

References fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::Table< T, KeysToIgnore >::maybe_implicitly_default(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::REQUIRED_CONDITIONAL, and fhicl::Table< T, KeysToIgnore >::value_.

    : TableBase{std::move(name),
                std::move(comment),
                par_style::REQUIRED_CONDITIONAL,
                maybeUse}
    , RegisterIfTableMember{this}
    , value_{std::make_shared<T>(std::forward<TCARGS>(tcargs)...)}
  {
    maybe_implicitly_default();
    NameStackRegistry::end_of_ctor();
  }

template<typename T , typename KeysToIgnore >

template<typename , typename >

Table::Table

(

ParameterSet const &

pset

)

Definition at line 169 of file Table.h.

    : Table{pset, KeysToIgnore{}(), Impl{}}
  {}

template<typename T , typename KeysToIgnore >

template<typename , typename >

Table::Table	(	ParameterSet const &	pset,
		std::set< std::string > const &	keysToIgnore = {}
	)

Definition at line 175 of file Table.h.

    : Table{pset, keysToIgnore, Impl{}}
  {}

template<typename T , typename KeysToIgnore >

Table::Table ( ParameterSet const &  pset, std::set< std::string > const &  keysToIgnore, Impl    )

private

Definition at line 181 of file Table.h.

References fhicl::detail::AlwaysUse(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::Table< T, KeysToIgnore >::maybe_implicitly_default(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::REQUIRED, and fhicl::Table< T, KeysToIgnore >::validate_ParameterSet().

    : TableBase{Name("<top_level>"),
                Comment(""),
                par_style::REQUIRED,
                detail::AlwaysUse()}
    , RegisterIfTableMember{this}
  {
    maybe_implicitly_default();
    validate_ParameterSet(pset, keysToIgnore);
    NameStackRegistry::end_of_ctor();
  }

Member Function Documentation

std::string const& 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::Atom< T >::Atom(), fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::OptionalAtom< T >::OptionalAtom(), 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(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::Table< T, KeysToIgnore >::Table(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< T >::Tuple().

      {
        return mdata_.comment();
      }

template<typename T , typename KeysToIgnore >

void Table::do_set_value ( fhicl::ParameterSet const &  pset, bool const  trimParents  )

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 227 of file Table.h.

References fhicl::ParameterSet::get(), fhicl::detail::ParameterBase::key(), fhicl::Table< T, KeysToIgnore >::pset_, string, and fhicl::detail::strip_first_containing_name().

Referenced by fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >::get_members().

  {
    // Kind of tricky: we do not have the name of the current
    // parameter set.  A placeholder is often used (e.g. "<top_level>").
    // Fortunately, since the pset is passed in, we can just assign to
    // it for a top-level ParameterSet.  However, for nested parameter
    // sets, we need to trim off the placeholder, and then the key we
    // send pset.get<fhicl::ParameterSet>(key) is the key relative to
    // the top-level pset.
    std::string const& rkey = key();
    std::string const& nkey = detail::strip_first_containing_name(rkey);
    pset_ = (nkey == rkey) ? pset : pset.get<fhicl::ParameterSet>(nkey);
  }

template<typename T, typename KeysToIgnore = void>

members_t const& fhicl::Table< T, KeysToIgnore >::get_members ( ) const

inlineoverrideprivatevirtual

Implements fhicl::detail::TableBase.

Definition at line 98 of file Table.h.

    {
      return members_;
    }

template<typename T, typename KeysToIgnore = void>

ParameterSet const& fhicl::Table< T, KeysToIgnore >::get_PSet ( ) const

inline

Definition at line 68 of file Table.h.

    {
      return pset_;
    }

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::Atom< T >::do_set_value(), and fhicl::Atom< T >::get_stringified_value().

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

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

      {
        return mdata_.is_optional();
      }

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

inlineinherited

Definition at line 44 of file ParameterBase.h.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::cacheTopLevelParameter(), fhicl::OptionalSequence< T, N >::do_prepare_elements_for_validation(), fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::Atom< T >::do_set_value(), fhicl::OptionalAtom< T >::do_set_value(), fhicl::OptionalTable< T >::do_set_value(), fhicl::Table< T, KeysToIgnore >::do_set_value(), 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();
      }

template<typename T , typename KeysToIgnore >

void Table::maybe_implicitly_default ( )

private

Definition at line 244 of file Table.h.

References fhicl::DEFAULT, fhicl::Table< T, KeysToIgnore >::members_, and fhicl::detail::ParameterBase::set_par_style().

Referenced by fhicl::Table< T, KeysToIgnore >::Table().

  {
    bool const implicitly_default =
      std::all_of(members_.begin(), members_.end(), [](auto p) {
        return p->has_default() || p->is_optional();
      });
    if (implicitly_default)
      set_par_style(par_style::DEFAULT);
  }

std::vector<cet::exempt_ptr<ParameterBase> > const& fhicl::detail::TableBase::members ( ) const

inlineinherited

Definition at line 24 of file TableBase.h.

References fhicl::detail::TableBase::get_members().

Referenced by fhicl::OptionalTable< T >::validate_ParameterSet(), and fhicl::Table< T, KeysToIgnore >::validate_ParameterSet().

      {
        return get_members();
      }

std::string const& fhicl::detail::ParameterBase::name ( ) const

inlineinherited

Definition at line 49 of file ParameterBase.h.

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

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), std_candles.StdCandlesPlotter::IsMC(), fhicl::detail::ParameterBase::ParameterBase(), run_unfold_ppfx_multiprocess.Consumer::run(), run_unfold_systs_multiprocess.Consumer::run(), run_unfold_genie_multiprocess.Consumer::run(), fhicl::detail::SequenceBase::SequenceBase(), and fhicl::detail::TableBase::TableBase().

      {
        return mdata_.name();
      }

template<typename T, typename KeysToIgnore = void>

auto const& fhicl::Table< T, KeysToIgnore >::operator() ( void  ) const

inline

Definition at line 62 of file Table.h.

    {
      return *value_;
    }

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

      {
        return mdata_.type();
      }

template<typename T , typename KeysToIgnore >

void Table::print_allowed_configuration	(	std::ostream &	os,
		std::string const &	tab = std::string(3, ' ')
	)		const

Definition at line 216 of file Table.h.

References fhicl::detail::optional_parameter_message(), and python.hepunit::pc.

Referenced by fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >::get_PSet().

  {
    os << '\n' << tab << detail::optional_parameter_message() << '\n';
    detail::PrintAllowedConfiguration pc{os, false, tab};
    pc.walk_over(*this);
  }

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

inlineinherited

Definition at line 101 of file ParameterBase.h.

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

Referenced by fhicl::Table< T, KeysToIgnore >::maybe_implicitly_default().

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

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

      {
        return maybeUse_();
      }

template<typename T , typename KeysToIgnore >

void Table::validate_ParameterSet	(	ParameterSet const &	pset,
		std::set< std::string > const &	keysToIgnore = {}
	)

Definition at line 197 of file Table.h.

References fhicl::NameStackRegistry::clear(), cet::for_all(), fhicl::NameStackRegistry::instance(), m, fhicl::detail::TableBase::members(), and fhicl::Table< T, KeysToIgnore >::pset_.

Referenced by fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >::get_PSet(), and fhicl::Table< T, KeysToIgnore >::Table().

  {
    pset_ = pset;
    detail::ValidateThenSet vs{pset_, keysToIgnore};
    cet::for_all(members(), [&vs](auto m) { vs.walk_over(*m); });

    try {
      vs.check_keys();
    }
    catch (fhicl::detail::validationException const&) {
      NameStackRegistry::instance().clear();
      throw;
    }
  }

Member Data Documentation

template<typename T, typename KeysToIgnore = void>

members_t fhicl::Table< T, KeysToIgnore >::members_

private

Initial value:

{
      detail::TableMemberRegistry::instance().release_members()}

Definition at line 90 of file Table.h.

Referenced by fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >::get_members(), and fhicl::Table< T, KeysToIgnore >::maybe_implicitly_default().

template<typename T, typename KeysToIgnore = void>

ParameterSet fhicl::Table< T, KeysToIgnore >::pset_ {}

private

Definition at line 89 of file Table.h.

Referenced by fhicl::Table< T, KeysToIgnore >::do_set_value(), fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >::get_PSet(), and fhicl::Table< T, KeysToIgnore >::validate_ParameterSet().

template<typename T, typename KeysToIgnore = void>

std::shared_ptr<T> fhicl::Table< T, KeysToIgnore >::value_ {std::make_shared<T>()}

private

Definition at line 88 of file Table.h.

Referenced by fhicl::Table< mf::service::ELdestination::MsgFormatSettings::mf::service::ELdestination::Config >::operator()(), and fhicl::Table< T, KeysToIgnore >::Table().

---

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

• fhiclcpp/type_traits.h
• fhiclcpp/types/Table.h