#include "type_traits.h"

Inheritance diagram for fhicl::OptionalTuple< T >:

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

using	value_type = std::tuple< tt::return_type< T >... >

Public Member Functions
	OptionalTuple (Name &&name)

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

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

auto	operator() () const -> std::optional< value_type >

auto	operator() (value_type &) const -> bool

bool	hasValue () 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 Types
using	PW_non_const = detail::ParameterWalker< tt::const_flavor::require_non_const >

using	PW_const = detail::ParameterWalker< tt::const_flavor::require_const >

Private Member Functions
std::size_t	get_size () const noexcept override

template<std::size_t... I>
void	iterate_over_tuple (PW_non_const &pw, std::index_sequence< I... >)

void	do_prepare_elements_for_validation (std::size_t const n) override

void	do_walk_elements (PW_non_const &pw) override

template<std::size_t... I>
void	iterate_over_tuple (PW_const &pw, std::index_sequence< I... >) const

void	do_walk_elements (PW_const &pw) const override

template<std::size_t I>
void	finalize_element ()

template<std::size_t... I>
void	finalize_elements (std::index_sequence< I... >)

template<std::size_t... I>
value_type	get_rtype_result (std::index_sequence< I... >) const

void	do_set_value (fhicl::ParameterSet const &) override

Private Attributes
ftype	value_

bool	has_value_ {false}

Detailed Description

template<typename... T>
class fhicl::OptionalTuple< T >

Definition at line 40 of file type_traits.h.

Member Typedef Documentation

template<typename... T>

using fhicl::OptionalTuple< T >::ftype = std::tuple<std::shared_ptr<tt::fhicl_type<T>>...>

Definition at line 31 of file OptionalTuple.h.

template<typename... T>

using fhicl::OptionalTuple< T >::PW_const = detail::ParameterWalker<tt::const_flavor::require_const>

private

Definition at line 73 of file OptionalTuple.h.

template<typename... T>

using fhicl::OptionalTuple< T >::PW_non_const = detail::ParameterWalker<tt::const_flavor::require_non_const>

private

Definition at line 72 of file OptionalTuple.h.

template<typename... T>

using fhicl::OptionalTuple< T >::value_type = std::tuple<tt::return_type<T>...>

Definition at line 32 of file OptionalTuple.h.

Constructor & Destructor Documentation

template<typename... T>

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

explicit

Definition at line 150 of file OptionalTuple.h.

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

151 : OptionalTuple{std::move(name), Comment("")}

152 {}

fhicl::OptionalTuple::OptionalTuple

OptionalTuple(Name &&name)

Definition: OptionalTuple.h:150

fhicl::detail::ParameterBase::name

std::string const & name() const

Definition: ParameterBase.cc:11

template<typename... T>

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

explicit

Definition at line 155 of file OptionalTuple.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::OptionalTuple< T >::finalize_elements(), fhicl::detail::ParameterBase::name(), fhicl::OPTIONAL, fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::TUPLE.

     : SequenceBase{std::move(name),
                    std::move(comment),
                    par_style::OPTIONAL,
                    par_type::TUPLE,
                    detail::AlwaysUse()}
     , RegisterIfTableMember{this}
   {
     finalize_elements(std::index_sequence_for<T...>{});
     NameStackRegistry::end_of_ctor();
   }

template<typename... T>

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

explicit

Definition at line 168 of file OptionalTuple.h.

References fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::OptionalTuple< T >::finalize_elements(), fhicl::detail::ParameterBase::name(), fhicl::OPTIONAL_CONDITIONAL, fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::TUPLE.

     : SequenceBase{std::move(name),
                    std::move(comment),
                    par_style::OPTIONAL_CONDITIONAL,
                    par_type::TUPLE,
                    maybeUse}
     , RegisterIfTableMember{this}
   {
     finalize_elements(std::index_sequence_for<T...>{});
     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(), 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>

void fhicl::OptionalTuple< T >::do_prepare_elements_for_validation ( std::size_t const n )

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 83 of file OptionalTuple.h.

     {
       detail::check_nargs_for_bounded_sequences(key(), get_size(), n);
     }

template<typename... T>

void fhicl::OptionalTuple< T >::do_set_value ( fhicl::ParameterSet const & )

inlineoverrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 135 of file OptionalTuple.h.

     {
       // We do not explicitly set the sequence values here as the
       // individual elements are set one at a time.  However, this
       // function is reached in the ValidateThenSet algorithm if the
       // optional parameter is present.  Otherwise, this override is
       // skipped.
       has_value_ = true;
     }

template<typename... T>

void fhicl::OptionalTuple< T >::do_walk_elements ( PW_non_const & pw )

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 89 of file OptionalTuple.h.

     {
       iterate_over_tuple(pw, std::index_sequence_for<T...>{});
     }

template<typename... T>

void fhicl::OptionalTuple< T >::do_walk_elements ( PW_const & pw ) const

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 102 of file OptionalTuple.h.

     {
       iterate_over_tuple(pw, std::index_sequence_for<T...>{});
     }

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>

template<std::size_t I>

void fhicl::OptionalTuple< T >::finalize_element ( )

inlineprivate

Definition at line 111 of file OptionalTuple.h.

     {
       using elem_ftype = typename std::tuple_element_t<I, ftype>::element_type;
       std::get<I>(value_) =
         std::make_shared<elem_ftype>(Name::sequence_element(I));
     }

template<typename... T>

template<std::size_t... I>

void fhicl::OptionalTuple< T >::finalize_elements ( std::index_sequence< I... > )

inlineprivate

Definition at line 120 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< T >::OptionalTuple().

     {
       (finalize_element<I>(), ...);
     }

template<typename... T>

template<std::size_t... I>

value_type fhicl::OptionalTuple< T >::get_rtype_result ( std::index_sequence< I... > ) const

inlineprivate

Definition at line 129 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< T >::operator()().

     {
       return value_type{(*std::get<I>(value_))()...};
     }

template<typename... T>

std::size_t fhicl::OptionalTuple< T >::get_size ( ) const

inlineoverrideprivatevirtualnoexcept

Implements fhicl::detail::SequenceBase.

Definition at line 64 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation().

     {
       return std::tuple_size<ftype>();
     }

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

template<typename... T>

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

inline

Definition at line 54 of file OptionalTuple.h.

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

template<typename... T>

template<std::size_t... I>

void fhicl::OptionalTuple< T >::iterate_over_tuple	(	PW_non_const &	pw,
		std::index_sequence< I... >
	)

inlineprivate

Definition at line 77 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< ARGS... >::do_walk_elements().

     {
       (pw.walk_over(*std::get<I>(value_)), ...);
     }

template<typename... T>

template<std::size_t... I>

void fhicl::OptionalTuple< T >::iterate_over_tuple	(	PW_const &	pw,
		std::index_sequence< I... >
	)		const

inlineprivate

Definition at line 96 of file OptionalTuple.h.

     {
       (pw.walk_over(*std::get<I>(value_)), ...);
     }

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

auto fhicl::OptionalTuple< T >::operator() ( ) const -> std::optional<value_type>

Definition at line 184 of file OptionalTuple.h.

References fhicl::OptionalTuple< T >::get_rtype_result(), and fhicl::OptionalTuple< T >::has_value_.

Referenced by fhicl::OptionalTuple< T >::operator()().

   {
     if (!has_value_)
       return std::nullopt;
     return std::make_optional(
       get_rtype_result(std::index_sequence_for<T...>()));
   }

template<typename... T>

auto fhicl::OptionalTuple< T >::operator() ( value_type & r ) const -> bool

Definition at line 194 of file OptionalTuple.h.

References fhicl::OptionalTuple< T >::operator()(), and r.

   {
     auto result = operator()();
     if (result) {
       r = *result;
     }
     return result.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();
   }

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>

bool fhicl::OptionalTuple< T >::has_value_ {false}

private

Definition at line 61 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< ARGS... >::do_set_value(), fhicl::OptionalTuple< ARGS... >::hasValue(), and fhicl::OptionalTuple< T >::operator()().

template<typename... T>

ftype fhicl::OptionalTuple< T >::value_

private

Definition at line 60 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< ARGS... >::finalize_element(), and fhicl::OptionalTuple< ARGS... >::get_rtype_result().

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

fhiclcpp/type_traits.h
fhiclcpp/types/OptionalTuple.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<typename... T> class fhicl::OptionalTuple< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename... T>
class fhicl::OptionalTuple< T >