#include "OptionalSequence.h"

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

Public Types
using	ftype = std::vector< std::shared_ptr< tt::fhicl_type< T >>>

using	value_type = std::vector< tt::return_type< T >>

Public Member Functions
	OptionalSequence (Name &&name)

	OptionalSequence (Name &&name, Comment &&comment)

	OptionalSequence (Name &&name, Comment &&comment, std::function< bool()> maybeUse)

bool	operator() (value_type &t) const

bool	empty () const

std::size_t	size () const

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	key () const

std::string	name () const

std::string	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)

void	set_key (std::string const &key)

Private Member Functions
void	do_prepare_elements_for_validation (std::size_t const n) override

std::size_t	get_size () const 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

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

Private Attributes
ftype	value_

bool	has_value_ {false}

Detailed Description

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

Definition at line 102 of file OptionalSequence.h.

Member Typedef Documentation

template<typename T >

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

Definition at line 111 of file OptionalSequence.h.

template<typename T >

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

Definition at line 112 of file OptionalSequence.h.

Constructor & Destructor Documentation

template<typename T >

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

explicit

template<typename T >

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

explicit

template<typename T >

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

explicit

Member Function Documentation

std::string 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::detail::AtomBase::AtomBase(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::Tuple().

       {
         return mdata_.comment();
       }

template<typename T >

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 141 of file OptionalSequence.h.

References fhicl::NameStackRegistry::instance(), fhicl::detail::ParameterBase::key(), n, and fhicl::Name::sequence_element().

     {
       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.
         auto const& nsr = NameStackRegistry::instance();
         if (!nsr.empty()) {
           std::string const& current_stem = nsr.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_.emplace_back(
             new tt::fhicl_type<T>{Name::sequence_element(key_fragment, i)});
         }
       }
     }

template<typename T >

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

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

template<typename T >

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 175 of file OptionalSequence.h.

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

     {
       cet::for_all(value_, [&pw](auto& e) { pw.walk_over(*e); });
     }

template<typename T >

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 182 of file OptionalSequence.h.

References fhicl::OptionalSequence< T, N >::do_set_value(), e, and fhicl::detail::ParameterWalker< C >::walk_over().

     {
       cet::for_all(value_, [&pw](auto const& e) { pw.walk_over(*e); });
     }

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

inlineinherited

Definition at line 29 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::OptionalSequence< T,-1ull >::get_size ( ) const

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 169 of file OptionalSequence.h.

     {
       return value_.size();
     }

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::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), and fhicl::detail::PrintAllowedConfiguration::enter_sequence().

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), and fhicl::detail::PrintAllowedConfiguration::before_action().

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

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::before_action(), and evgen::MARLEYHelper::fhicl_parameter_to_json().

       {
         return mdata_.is_optional();
       }

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

inlineinherited

Definition at line 44 of file ParameterBase.h.

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::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >::do_prepare_elements_for_validation(), fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), do_prepare_elements_for_validation(), fhicl::detail::ValidateThenSet::enter_sequence(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), 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();
       }

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

inlineinherited

Definition at line 49 of file ParameterBase.h.

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

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::detail::ValidateThenSet::delegated_parameter(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::Tuple().

       {
         return mdata_.name();
       }

template<typename T >

bool fhicl::OptionalSequence< T,-1ull >::operator() ( value_type & t ) const

inline

Definition at line 121 of file OptionalSequence.h.

References e, fhicl::OptionalSequence< T, N >::has_value_, and fhicl::OptionalSequence< T, N >::value_.

     {
 
       if (!has_value_)
         return false;
 
       value_type result;
       cet::transform_all(value_, std::back_inserter(result), [](auto const& e) {
         return (*e)();
       });
 
       std::swap(result, t);
       return true;
     }

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::PrintAllowedConfiguration::after_action(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), 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 40 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);
       }

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

inlineinherited

Definition at line 106 of file ParameterBase.h.

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

       {
         mdata_.set_key(key);
       }

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

inlineinherited

Definition at line 101 of file ParameterBase.h.

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

Referenced by art::RootOutput::Config::Config().

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

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

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

Referenced by fhicl::detail::ValidateThenSet::before_action(), and evgen::MARLEYHelper::fhicl_parameter_to_json().

       {
         return maybeUse_();
       }

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

inlineinherited

Definition at line 34 of file SequenceBase.h.

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

Referenced by fhicl::detail::SequenceBase::empty(), and fhicl::detail::PrintAllowedConfiguration::enter_sequence().

       {
         return get_size();
       }

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

inlineinherited

Definition at line 45 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 50 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 >

bool fhicl::OptionalSequence< T,-1ull >::has_value_ {false}

private

Definition at line 138 of file OptionalSequence.h.

template<typename T >

ftype fhicl::OptionalSequence< T,-1ull >::value_

private

Definition at line 137 of file OptionalSequence.h.

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

fhiclcpp/types/OptionalSequence.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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