#include "type_traits.h"

Inheritance diagram for fhicl::OptionalTuple< TYPES >:

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

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

Public Member Functions
	OptionalTuple (Name &&name)

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

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

bool	operator() (value_type &) const

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

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

using	TUPLE = std::tuple< tt::fhicl_type< TYPES >... >

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

void	visit_element (PW_non_const &)

template<typename E , typename... T>
void	visit_element (PW_non_const &pw, E &elem, T &...others)

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

void	visit_element (PW_const &) const

template<typename E , typename... T>
void	visit_element (PW_const &pw, E const &elem, T const &...others) const

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

void	finalize_tuple_elements (std::size_t)

template<typename E , typename... T>
void	finalize_tuple_elements (std::size_t i, E &elem, T &...others)

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

template<size_t I, typename value_type >
std::enable_if_t<(I >=std::tuple_size< TUPLE >::value)>	fill_return_element (value_type &) const

template<size_t I, typename value_type >
std::enable_if_t<(I< std::tuple_size< TUPLE >::value)>	fill_return_element (value_type &result) const

void	assemble_rtype (value_type &result) const

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

Private Attributes
ftype	value_

bool	has_value_ {false}

Detailed Description

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

Definition at line 40 of file type_traits.h.

Member Typedef Documentation

template<typename... TYPES>

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

Definition at line 30 of file OptionalTuple.h.

template<typename... TYPES>

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

private

Definition at line 61 of file OptionalTuple.h.

template<typename... TYPES>

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

private

Definition at line 60 of file OptionalTuple.h.

template<typename... TYPES>

using fhicl::OptionalTuple< TYPES >::TUPLE = std::tuple<tt::fhicl_type<TYPES>...>

private

Definition at line 163 of file OptionalTuple.h.

template<typename... TYPES>

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

Definition at line 31 of file OptionalTuple.h.

Constructor & Destructor Documentation

template<typename... TYPES>

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

explicit

Definition at line 201 of file OptionalTuple.h.

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

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

203 {}

fhicl::OptionalTuple::OptionalTuple

OptionalTuple(Name &&name)

Definition: OptionalTuple.h:201

fhicl::detail::ParameterBase::name

std::string name() const

Definition: ParameterBase.h:49

template<typename... TYPES>

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

explicit

Definition at line 206 of file OptionalTuple.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::OptionalTuple< TYPES >::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<TYPES...>{});
     NameStackRegistry::end_of_ctor();
   }

template<typename... TYPES>

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

explicit

Definition at line 219 of file OptionalTuple.h.

References fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::OptionalTuple< TYPES >::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<TYPES...>{});
     NameStackRegistry::end_of_ctor();
   }

Member Function Documentation

template<typename... TYPES>

void fhicl::OptionalTuple< TYPES >::assemble_rtype ( value_type & result ) const

inlineprivate

Definition at line 179 of file OptionalTuple.h.

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

     {
       fill_return_element<0>(result);
     }

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... TYPES>

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 90 of file OptionalTuple.h.

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

template<typename... TYPES>

void fhicl::OptionalTuple< TYPES >::do_set_value	(	fhicl::ParameterSet const &	,
		bool	const
	)

inlineoverrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 185 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... TYPES>

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 96 of file OptionalTuple.h.

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

template<typename... TYPES>

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 128 of file OptionalTuple.h.

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

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... TYPES>

template<size_t I, typename value_type >

std::enable_if_t<(I >= std::tuple_size<TUPLE>::value)> fhicl::OptionalTuple< TYPES >::fill_return_element ( value_type & ) const

inlineprivate

Definition at line 167 of file OptionalTuple.h.

168 {}

template<typename... TYPES>

template<size_t I, typename value_type >

std::enable_if_t<(I < std::tuple_size<TUPLE>::value)> fhicl::OptionalTuple< TYPES >::fill_return_element ( value_type & result ) const

inlineprivate

Definition at line 172 of file OptionalTuple.h.

     {
       std::get<I>(result) = (*std::get<I>(value_))();
       fill_return_element<I + 1>(result);
     }

template<typename... TYPES>

template<std::size_t... I>

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

inlineprivate

Definition at line 155 of file OptionalTuple.h.

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

     {
       finalize_tuple_elements(0, std::get<I>(value_)...);
     }

template<typename... TYPES>

void fhicl::OptionalTuple< TYPES >::finalize_tuple_elements ( std::size_t )

inlineprivate

Definition at line 135 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< ARGS... >::finalize_elements(), and fhicl::OptionalTuple< ARGS... >::finalize_tuple_elements().

135 {}

template<typename... TYPES>

template<typename E , typename... T>

void fhicl::OptionalTuple< TYPES >::finalize_tuple_elements	(	std::size_t	i,
		E &	elem,
		T &...	others
	)

inlineprivate

Definition at line 140 of file OptionalTuple.h.

     {
       using elem_ftype = typename E::element_type;
       static_assert(!tt::is_table_fragment<elem_ftype>::value,
                     NO_NESTED_TABLE_FRAGMENTS);
       static_assert(!tt::is_optional_parameter<elem_ftype>::value,
                     NO_OPTIONAL_TYPES);
       static_assert(!tt::is_delegated_parameter<elem_ftype>::value,
                     NO_DELEGATED_PARAMETERS);
       elem = std::make_shared<elem_ftype>(Name::sequence_element(i));
       finalize_tuple_elements(++i, others...);
     }

template<typename... TYPES>

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 52 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

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

template<typename... TYPES>

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

inline

Definition at line 42 of file OptionalTuple.h.

     {
       return has_value_;
     }

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

template<typename... TYPES>

template<std::size_t... I>

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

inlineprivate

Definition at line 84 of file OptionalTuple.h.

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

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

template<typename... TYPES>

template<std::size_t... I>

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

inlineprivate

Definition at line 122 of file OptionalTuple.h.

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

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(), fhicl::OptionalSequence< T,-1ull >::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... TYPES>

bool fhicl::OptionalTuple< TYPES >::operator() ( value_type & r ) const

Definition at line 235 of file OptionalTuple.h.

References fhicl::OptionalTuple< TYPES >::assemble_rtype(), and fhicl::OptionalTuple< TYPES >::has_value_.

   {
     if (!has_value_)
       return false;
     value_type result;
     assemble_rtype(result);
     std::swap(result, r);
     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();
       }

template<typename... TYPES>

void fhicl::OptionalTuple< TYPES >::visit_element ( PW_non_const & )

inlineprivate

Definition at line 64 of file OptionalTuple.h.

Referenced by fhicl::OptionalTuple< ARGS... >::iterate_over_tuple(), and fhicl::OptionalTuple< ARGS... >::visit_element().

65 {}

template<typename... TYPES>

template<typename E , typename... T>

void fhicl::OptionalTuple< TYPES >::visit_element	(	PW_non_const &	pw,
		E &	elem,
		T &...	others
	)

inlineprivate

Definition at line 69 of file OptionalTuple.h.

     {
       using elem_ftype = typename E::element_type;
       static_assert(!tt::is_table_fragment<elem_ftype>::value,
                     NO_NESTED_TABLE_FRAGMENTS);
       static_assert(!tt::is_optional_parameter<elem_ftype>::value,
                     NO_OPTIONAL_TYPES);
       static_assert(!tt::is_delegated_parameter<elem_ftype>::value,
                     NO_DELEGATED_PARAMETERS);
       pw.walk_over(*elem);
       visit_element(pw, others...);
     }

template<typename... TYPES>

void fhicl::OptionalTuple< TYPES >::visit_element ( PW_const & ) const

inlineprivate

Definition at line 102 of file OptionalTuple.h.

103 {}

template<typename... TYPES>

template<typename E , typename... T>

void fhicl::OptionalTuple< TYPES >::visit_element	(	PW_const &	pw,
		E const &	elem,
		T const &...	others
	)		const

inlineprivate

Definition at line 107 of file OptionalTuple.h.

     {
       using elem_ftype = typename E::element_type;
       static_assert(!tt::is_table_fragment<elem_ftype>::value,
                     NO_NESTED_TABLE_FRAGMENTS);
       static_assert(!tt::is_optional_parameter<elem_ftype>::value,
                     NO_OPTIONAL_TYPES);
       static_assert(!tt::is_delegated_parameter<elem_ftype>::value,
                     NO_DELEGATED_PARAMETERS);
       pw.walk_over(*elem);
       visit_element(pw, others...);
     }

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... TYPES>

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

private

Definition at line 49 of file OptionalTuple.h.

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

template<typename... TYPES>

ftype fhicl::OptionalTuple< TYPES >::value_

private

Definition at line 48 of file OptionalTuple.h.

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... TYPES> class fhicl::OptionalTuple< TYPES >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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