fhicl::Sequence< T,-1ull > Class Template Reference

#include "Sequence.h"

Inheritance diagram for fhicl::Sequence< T,-1ull >:

Public Types
using	default_type = std::vector< typename tt::fhicl_type< T >::default_type >
using	ftype = std::vector< std::shared_ptr< tt::fhicl_type< T >>>
using	value_type = std::vector< tt::return_type< T >>

Public Member Functions
	Sequence (Name &&name)
	Sequence (Name &&name, Comment &&comment)
	Sequence (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
	Sequence (Name &&name, default_type const &defaults)
	Sequence (Name &&name, Comment &&comment, default_type const &defaults)
	Sequence (Name &&name, Comment &&comment, std::function< bool()> maybeUse, default_type const &defaults)
auto	operator() () const
auto	operator() (std::size_t const i) const
bool	empty () const noexcept
std::size_t	size () const noexcept
void	prepare_elements_for_validation (std::size_t const n)
void	walk_elements (ParameterWalker< tt::const_flavor::require_non_const > &pw)
void	walk_elements (ParameterWalker< tt::const_flavor::require_const > &pw) 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	preset_value (fhicl::ParameterSet const &ps)
void	set_par_style (par_style const vt)

Private Member Functions
void	do_prepare_elements_for_validation (std::size_t const n) override
std::size_t	get_size () const noexcept override
void	do_walk_elements (detail::ParameterWalker< tt::const_flavor::require_non_const > &pw) override
void	do_walk_elements (detail::ParameterWalker< tt::const_flavor::require_const > &pw) const override
bool	do_preset_value (fhicl::ParameterSet const &ps) override
void	do_set_value (fhicl::ParameterSet const &) override

Private Attributes
std::variant< ftype, value_type >	value_

Detailed Description

template<typename T>
class fhicl::Sequence< T,-1ull >

Definition at line 181 of file Sequence.h.

Member Typedef Documentation

template<typename T >

using fhicl::Sequence< T,-1ull >::default_type = std::vector<typename tt::fhicl_type<T>::default_type>

Definition at line 188 of file Sequence.h.

template<typename T >

using fhicl::Sequence< T,-1ull >::ftype = std::vector<std::shared_ptr<tt::fhicl_type<T>>>

Definition at line 189 of file Sequence.h.

template<typename T >

using fhicl::Sequence< T,-1ull >::value_type = std::vector<tt::return_type<T>>

Definition at line 190 of file Sequence.h.

Constructor & Destructor Documentation

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence ( Name &&  name )

explicit

Definition at line 422 of file Sequence.h.

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

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

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence ( Name &&  name, Comment &&  comment  )

explicit

Definition at line 427 of file Sequence.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::REQUIRED, fhicl::SEQ_VECTOR, fhicl::Name::sequence_element(), and fhicl::Sequence< T, N >::value_.

    : SequenceBase{std::move(name),
                   std::move(comment),
                   par_style::REQUIRED,
                   par_type::SEQ_VECTOR,
                   detail::AlwaysUse()}
    , RegisterIfTableMember{this}
    , value_{
        ftype{std::make_shared<tt::fhicl_type<T>>(Name::sequence_element(0ul))}}
  {
    NameStackRegistry::end_of_ctor();
  }

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence ( Name &&  name, Comment &&  comment, std::function< bool()>  maybeUse  )

explicit

Definition at line 441 of file Sequence.h.

References fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::REQUIRED_CONDITIONAL, fhicl::SEQ_VECTOR, fhicl::Name::sequence_element(), and fhicl::Sequence< T, N >::value_.

    : SequenceBase{std::move(name),
                   std::move(comment),
                   par_style::REQUIRED_CONDITIONAL,
                   par_type::SEQ_VECTOR,
                   maybeUse}
    , RegisterIfTableMember{this}
    , value_{
        ftype{std::make_shared<tt::fhicl_type<T>>(Name::sequence_element(0ul))}}
  {
    NameStackRegistry::end_of_ctor();
  }

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence ( Name &&  name, default_type const &  defaults  )

explicit

Definition at line 458 of file Sequence.h.

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

    : Sequence{std::move(name), Comment{""}, defaults}
  {}

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence ( Name &&  name, Comment &&  comment, default_type const &  defaults  )

explicit

Definition at line 463 of file Sequence.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::DEFAULT, fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), NO_DEFAULTS_FOR_TABLE, fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::SEQ_VECTOR, fhicl::Name::sequence_element(), value, and fhicl::Sequence< T, N >::value_.

    : SequenceBase{std::move(name),
                   std::move(comment),
                   par_style::DEFAULT,
                   par_type::SEQ_VECTOR,
                   detail::AlwaysUse()}
    , RegisterIfTableMember{this}
  {
    static_assert(!tt::is_table_v<T>, NO_DEFAULTS_FOR_TABLE);
    std::size_t i{};
    auto& value = std::get<ftype>(value_);
    for (auto const& t : defaults) {
      value.push_back(
        std::make_shared<tt::fhicl_type<T>>(Name::sequence_element(i), t));
      ++i;
    }
    NameStackRegistry::end_of_ctor();
  }

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence ( Name &&  name, Comment &&  comment, std::function< bool()>  maybeUse, default_type const &  defaults  )

explicit

Definition at line 485 of file Sequence.h.

References fhicl::detail::ParameterBase::comment(), fhicl::DEFAULT_CONDITIONAL, fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), NO_DEFAULTS_FOR_TABLE, fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), fhicl::SEQ_VECTOR, fhicl::Name::sequence_element(), value, and fhicl::Sequence< T, N >::value_.

    : SequenceBase{std::move(name),
                   std::move(comment),
                   par_style::DEFAULT_CONDITIONAL,
                   par_type::SEQ_VECTOR,
                   maybeUse}
    , RegisterIfTableMember{this}
  {
    static_assert(!tt::is_table_v<T>, NO_DEFAULTS_FOR_TABLE);
    std::size_t i{};
    auto& value = std::get<ftype>(value_);
    for (auto const& t : defaults) {
      value.emplace_back(
        std::make_shared<tt::fhicl_type<T>>(Name::sequence_element(i), t));
      ++i;
    }
    NameStackRegistry::end_of_ctor();
  }

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(), 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 >

void fhicl::Sequence< T,-1ull >::do_prepare_elements_for_validation ( std::size_t const  n )

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 234 of file Sequence.h.

References fhicl::NameStackRegistry::current(), fhicl::NameStackRegistry::empty(), n, fhicl::Name::sequence_element(), and value.

    {
      // We only enter here if we do not have a preset value.
      auto& value = std::get<ftype>(value_);

      // For an unbounded sequence, we need to resize it so that any
      // nested parameters of the elements can be checked.
      if (n < value.size()) {
        value.resize(n);
      } else if (n > value.size()) {
        std::string key_fragment{key()};
        // When emplacing a new element, do not include in the key
        // argument the current name-stack stem--it will automatically
        // be prepended.
        if (!NameStackRegistry::empty()) {
          std::string const& current_stem = NameStackRegistry::current();
          std::size_t const pos =
            key_fragment.find(current_stem) != std::string::npos ?
              current_stem.size() + 1ul : // + 1ul to account for the '.'
              0ul;
          key_fragment.replace(0ul, pos, "");
        }

        for (auto i = value.size(); i != n; ++i) {
          value.push_back(std::make_shared<tt::fhicl_type<T>>(
            Name::sequence_element(key_fragment, i)));
        }
      }
    }

template<typename T >

bool fhicl::Sequence< T,-1ull >::do_preset_value ( fhicl::ParameterSet const &  ps )

inlineoverrideprivatevirtual

Reimplemented from fhicl::detail::ParameterBase.

Definition at line 292 of file Sequence.h.

References fhicl::ParameterSet::get(), and fhicl::detail::strip_first_containing_name().

    {
      if constexpr (std::is_same_v<tt::fhicl_type<T>, Atom<T>>) {
        auto const trimmed_key = detail::strip_first_containing_name(key());
        value_ = ps.get<value_type>(trimmed_key);
        return true;
      }
      return false;
    }

template<typename T >

void fhicl::Sequence< T,-1ull >::do_set_value ( fhicl::ParameterSet const &  )

inlineoverrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 303 of file Sequence.h.

    {}

template<typename T >

void fhicl::Sequence< T,-1ull >::do_walk_elements ( detail::ParameterWalker< tt::const_flavor::require_non_const > &  pw )

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 274 of file Sequence.h.

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

    {
      // We only enter here if we do not have a preset value.
      cet::for_all(std::get<ftype>(value_),
                   [&pw](auto& e) { pw.walk_over(*e); });
    }

template<typename T >

void fhicl::Sequence< T,-1ull >::do_walk_elements ( detail::ParameterWalker< tt::const_flavor::require_const > &  pw ) const

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 283 of file Sequence.h.

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

    {
      // We only enter here if we do not have a preset value.
      cet::for_all(std::get<ftype>(value_),
                   [&pw](auto const& e) { pw.walk_over(*e); });
    }

bool fhicl::detail::SequenceBase::empty ( ) const

inlinenoexceptinherited

Definition at line 28 of file SequenceBase.h.

References fhicl::detail::SequenceBase::size().

Referenced by fhicl::detail::PrintAllowedConfiguration::enter_sequence().

    {
      return size() == 0;
    }

template<typename T >

std::size_t fhicl::Sequence< T,-1ull >::get_size ( ) const

inlineoverrideprivatevirtualnoexcept

Implements fhicl::detail::SequenceBase.

Definition at line 265 of file Sequence.h.

References util::size(), and value.

    {
      if (auto value = std::get_if<value_type>(&value_)) {
        return value->size();
      }
      return std::get<ftype>(value_).size();
    }

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::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();
  }

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(), 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 >

auto fhicl::Sequence< T,-1ull >::operator() ( ) const

inline

Definition at line 209 of file Sequence.h.

References e, and value.

    {
      if (auto value = std::get_if<value_type>(&value_)) {
        return *value;
      }
      value_type result;
      cet::transform_all(std::get<ftype>(value_),
                         std::back_inserter(result),
                         [](auto const& e) { return (*e)(); });
      return result;
    }

template<typename T >

auto fhicl::Sequence< T,-1ull >::operator() ( std::size_t const  i ) const

inline

Definition at line 222 of file Sequence.h.

References value.

    {
      if (auto value = std::get_if<value_type>(&value_)) {
        return value->at(i);
      }
      return (*std::get<ftype>(value_).at(i))();
    }

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();
  }

void fhicl::detail::SequenceBase::prepare_elements_for_validation ( std::size_t const  n )

inlineinherited

Definition at line 39 of file SequenceBase.h.

References fhicl::detail::SequenceBase::do_prepare_elements_for_validation().

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

    {
      do_prepare_elements_for_validation(n);
    }

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::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_();
  }

std::size_t fhicl::detail::SequenceBase::size ( void  ) const

inlinenoexceptinherited

Definition at line 33 of file SequenceBase.h.

References fhicl::detail::SequenceBase::get_size().

Referenced by fhicl::detail::SequenceBase::empty(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), fhicl::OptionalSequence< art::InputTag >::get_size(), fhicl::OptionalSequence< T,-1ull >::get_size(), geo::fhicl::readIDsequence(), and geo::fhicl::readOptionalIDsequence().

    {
      return get_size();
    }

void fhicl::detail::SequenceBase::walk_elements ( ParameterWalker< tt::const_flavor::require_non_const > &  pw )

inlineinherited

Definition at line 44 of file SequenceBase.h.

References fhicl::detail::SequenceBase::do_walk_elements().

    {
      do_walk_elements(pw);
    }

void fhicl::detail::SequenceBase::walk_elements ( ParameterWalker< tt::const_flavor::require_const > &  pw ) const

inlineinherited

Definition at line 49 of file SequenceBase.h.

References fhicl::detail::SequenceBase::do_prepare_elements_for_validation(), fhicl::detail::SequenceBase::do_walk_elements(), and fhicl::detail::SequenceBase::get_size().

    {
      do_walk_elements(pw);
    }

Member Data Documentation

template<typename T >

std::variant<ftype, value_type> fhicl::Sequence< T,-1ull >::value_

private

Definition at line 231 of file Sequence.h.

---

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

• fhiclcpp/types/Sequence.h