fhicl::OptionalTable< T > Class Template Reference

#include "type_traits.h"

Inheritance diagram for fhicl::OptionalTable< T >:

Public Types
using	value_type = T

Public Member Functions
	OptionalTable (Name &&name)
	OptionalTable (Name &&name, Comment &&comment)
	OptionalTable (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
	OptionalTable (ParameterSet const &pset, std::set< std::string > const &keysToIgnore)
std::optional< T >	operator() () const
bool	operator() (T &value) const
bool	hasValue () const
ParameterSet const &	get_PSet () const
	OptionalTable ()
void	print_allowed_configuration (std::ostream &os, std::string const &tab=std::string(3, ' ')) const
std::vector< cet::exempt_ptr< ParameterBase > > const &	members () const
void	validate (ParameterSet const &pset, std::set< std::string > const &ignorable_keys={})
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	preset_value (fhicl::ParameterSet const &ps)
void	set_par_style (par_style const vt)

Protected Member Functions
void	finalize_members ()
void	maybe_implicitly_default ()
bool	has_value () const
ParameterSet const &	get_pset () const
ParameterSet const &	guarantee_pset () const

Private Attributes
std::shared_ptr< T >	value_ {std::make_shared<T>()}

Detailed Description

template<typename T>
class fhicl::OptionalTable< T >

Definition at line 32 of file type_traits.h.

Member Typedef Documentation

template<typename T>

using fhicl::OptionalTable< T >::value_type = T

Definition at line 75 of file OptionalTable.h.

Constructor & Destructor Documentation

template<typename T >

fhicl::OptionalTable< T >::OptionalTable ( Name &&  name )

explicit

Definition at line 87 of file OptionalTable.h.

References fhicl::detail::ParameterBase::name().

    : OptionalTable{std::move(name), Comment("")}
  {}

template<typename T >

fhicl::OptionalTable< T >::OptionalTable ( Name &&  name, Comment &&  comment  )

explicit

Definition at line 92 of file OptionalTable.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::TableBase::finalize_members(), fhicl::detail::ParameterBase::name(), fhicl::OPTIONAL, and fhicl::detail::RegisterIfTableMember::RegisterIfTableMember().

    : TableBase{std::move(name),
                std::move(comment),
                par_style::OPTIONAL,
                detail::AlwaysUse()}
    , RegisterIfTableMember{this}
  {
    finalize_members();
    NameStackRegistry::end_of_ctor();
  }

template<typename T >

fhicl::OptionalTable< T >::OptionalTable ( Name &&  name, Comment &&  comment, std::function< bool()>  maybeUse  )

explicit

Definition at line 104 of file OptionalTable.h.

References fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::TableBase::finalize_members(), fhicl::detail::ParameterBase::name(), fhicl::OPTIONAL_CONDITIONAL, and fhicl::detail::RegisterIfTableMember::RegisterIfTableMember().

    : TableBase{std::move(name),
                std::move(comment),
                par_style::OPTIONAL_CONDITIONAL,
                maybeUse}
    , RegisterIfTableMember{this}
  {
    finalize_members();
    NameStackRegistry::end_of_ctor();
  }

template<typename T >

fhicl::OptionalTable< T >::OptionalTable	(	ParameterSet const &	pset,
		std::set< std::string > const &	keysToIgnore
	)

Definition at line 118 of file OptionalTable.h.

References fhicl::detail::AlwaysUse(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::TableBase::finalize_members(), fhicl::OPTIONAL, fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::detail::TableBase::validate().

    : TableBase{Name("<top_level>"),
                Comment(""),
                par_style::OPTIONAL,
                detail::AlwaysUse()}
    , RegisterIfTableMember{this}
  {
    finalize_members();
    NameStackRegistry::end_of_ctor();
    validate(pset, keysToIgnore);
  }

template<typename T>

fhicl::OptionalTable< T >::OptionalTable

(

)

Member Function Documentation

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

inherited

Definition at line 16 of file ParameterBase.cc.

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

Referenced by fhicl::Atom< T >::Atom(), fhicl::detail::AtomBase::AtomBase(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalAtom< T >::OptionalAtom(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), 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();
  }

void fhicl::detail::TableBase::finalize_members ( )

protectedinherited

Definition at line 37 of file TableBase.cc.

References fhicl::detail::TableBase::members_, and fhicl::detail::TableMemberRegistry::release_members().

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

  {
    // This must be called in a derived class **after** the table's
    // values has been set.
    members_ = TableMemberRegistry::release_members();
  }

ParameterSet const & fhicl::detail::TableBase::get_pset ( ) const

protectedinherited

Definition at line 79 of file TableBase.cc.

References fhicl::detail::TableBase::pset_.

  {
    return pset_.value();
  }

template<typename T>

ParameterSet const& fhicl::OptionalTable< T >::get_PSet ( ) const

inline

Definition at line 68 of file OptionalTable.h.

    {
      return TableBase::guarantee_pset();
    }

ParameterSet const & fhicl::detail::TableBase::guarantee_pset ( ) const

protectedinherited

Definition at line 85 of file TableBase.cc.

References fhicl::detail::TableBase::pset_.

  {
    static ParameterSet const empty_pset;
    return pset_.has_value() ? *pset_ : empty_pset;
  }

bool fhicl::detail::ParameterBase::has_default ( ) const

inherited

Definition at line 21 of file ParameterBase.cc.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::Atom< T >::do_set_value(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::Atom< T >::get_stringified_value(), and fhicl::TableAs< T, Config >::operator()().

  {
    return mdata_.has_default();
  }

bool fhicl::detail::TableBase::has_value ( ) const

protectedinherited

Definition at line 73 of file TableBase.cc.

References fhicl::detail::TableBase::pset_.

  {
    return pset_.has_value();
  }

template<typename T>

bool fhicl::OptionalTable< T >::hasValue ( ) const

inline

Definition at line 62 of file OptionalTable.h.

Referenced by fhicl::OptionalTableAs< T, Config >::hasValue(), and fhicl::OptionalTable< art::Scheduler::Config::DebugConfig >::operator()().

    {
      return TableBase::has_value();
    }

bool fhicl::detail::ParameterBase::is_conditional ( ) const

inherited

Definition at line 31 of file ParameterBase.cc.

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

inherited

Definition at line 26 of file ParameterBase.cc.

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 fhicl::detail::TableBase::do_set_value().

  {
    return mdata_.is_optional();
  }

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

inherited

Definition at line 6 of file ParameterBase.cc.

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::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< art::InputTag >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T, N >::do_preset_value(), fhicl::OptionalSequence< T,-1ull >::do_preset_value(), fhicl::Atom< T >::do_set_value(), fhicl::OptionalAtom< T >::do_set_value(), fhicl::detail::ValidateThenSet::enter_sequence(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), fhicl::DelegatedParameter::get(), fhicl::OptionalDelegatedParameter::get_if_present(), fhicl::OptionalDelegatedParameter::hasValue(), fhicl::detail::MaybeDisplayParent::is_sequence_element(), fhicl::detail::TableBase::maybe_select_pset(), fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::detail::TableBase::select_pset(), and fhicl::detail::PrintAllowedConfiguration::suppressFormat().

  {
    return mdata_.key();
  }

void fhicl::detail::TableBase::maybe_implicitly_default ( )

protectedinherited

Definition at line 45 of file TableBase.cc.

References fhicl::DEFAULT, fhicl::detail::TableBase::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

inherited

Definition at line 31 of file TableBase.cc.

References fhicl::detail::TableBase::members_.

  {
    return members_;
  }

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

inherited

Definition at line 11 of file ParameterBase.cc.

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

Referenced by fhicl::Atom< T >::Atom(), fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::detail::ValidateThenSet::delegated_parameter(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalAtom< T >::OptionalAtom(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), 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_.name();
  }

template<typename T>

std::optional<T> fhicl::OptionalTable< T >::operator() ( ) const

inline

Definition at line 45 of file OptionalTable.h.

Referenced by fhicl::OptionalTable< art::Scheduler::Config::DebugConfig >::operator()().

    {
      return hasValue() ? std::make_optional(*value_) : std::nullopt;
    }

template<typename T>

bool fhicl::OptionalTable< T >::operator() ( T &  value ) const

inline

Definition at line 52 of file OptionalTable.h.

    {
      auto opt = operator()();
      if (opt) {
        value = *value_;
      }
      return opt.has_value();
    }

par_type fhicl::detail::ParameterBase::parameter_type ( ) const

inherited

Definition at line 36 of file ParameterBase.cc.

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), and fhicl::detail::RegisterIfTableMember::RegisterIfTableMember().

  {
    return mdata_.type();
  }

bool fhicl::detail::ParameterBase::preset_value ( fhicl::ParameterSet const &  ps )

inherited

Definition at line 63 of file ParameterBase.cc.

References fhicl::detail::ParameterBase::do_preset_value().

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

  {
    return do_preset_value(ps);
  }

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

inherited

Definition at line 22 of file TableBase.cc.

References fhicl::detail::optional_parameter_message(), and fhicl::detail::ParameterWalker< C >::walk_over().

Referenced by art::operator<<(), and fhicl::detail::operator<<().

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

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

inherited

Definition at line 68 of file ParameterBase.cc.

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

Referenced by fhicl::detail::TableBase::maybe_implicitly_default(), and fhicl::TableAs< T, Config >::TableAs().

  {
    mdata_.set_par_style(vt);
  }

void fhicl::detail::ParameterBase::set_value ( fhicl::ParameterSet const &  ps )

inherited

Definition at line 58 of file ParameterBase.cc.

References fhicl::detail::ParameterBase::do_set_value().

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

  {
    do_set_value(ps);
  }

bool fhicl::detail::ParameterBase::should_use ( ) const

inherited

Definition at line 41 of file ParameterBase.cc.

References fhicl::detail::ParameterBase::maybeUse_.

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

  {
    return maybeUse_();
  }

void fhicl::detail::TableBase::validate ( ParameterSet const &  pset, std::set< std::string > const &  ignorable_keys = {}  )

inherited

Definition at line 56 of file TableBase.cc.

References fhicl::NameStackRegistry::clear(), fhicl::detail::TableBase::members_, and fhicl::detail::TableBase::pset_.

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

  {
    pset_ = std::make_optional(pset);
    ValidateThenSet vs{pset, ignorable_keys};
    cet::for_all(members_, [&vs](auto m) { vs.walk_over(*m); });

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

Member Data Documentation

template<typename T>

std::shared_ptr<T> fhicl::OptionalTable< T >::value_ {std::make_shared<T>()}

private

Definition at line 80 of file OptionalTable.h.

Referenced by fhicl::OptionalTable< art::Scheduler::Config::DebugConfig >::operator()().

---

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

• fhiclcpp/type_traits.h
• fhiclcpp/types/OptionalTable.h