#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

Public Member Functions inherited from fhicl::detail::SequenceBase
	SequenceBase (Name &&name, Comment &&comment, par_style const vt, par_type const type, std::function< bool()> maybeUse)

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

Public Member Functions inherited from fhicl::detail::ParameterBase
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

	ParameterBase (Name const &name, Comment const &comment, par_style const vt, par_type const type, std::function< bool()> maybeUse=AlwaysUse())

virtual	~ParameterBase ()=default

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 Member Functions inherited from fhicl::detail::RegisterIfTableMember
	RegisterIfTableMember (ParameterBase *pb)

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.

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

152 {}

fhicl::detail::ParameterBase::name

std::string const & name() const

Definition: ParameterBase.h:43

fhicl::OptionalTuple::OptionalTuple

OptionalTuple(Name &&name)

Definition: OptionalTuple.h:150

wirecell.gen.depos.move

def move(depos, offset)

Definition: depos.py:107

Comment

#define Comment

Definition: commentscan.cpp:4062

template<typename... T>

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

explicit

Definition at line 155 of file OptionalTuple.h.

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

     : 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

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

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.

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

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

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

template<typename... T>

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

inline

Definition at line 54 of file OptionalTuple.h.

     {
       return has_value_;
     }

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.

     {
       (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_)), ...);
     }

template<typename... T>

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

Definition at line 184 of file OptionalTuple.h.

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

   {
     auto result = operator()();
     if (result) {
       r = *result;
     }
     return result.has_value();
   }

Member Data Documentation

template<typename... T>

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

private

Definition at line 61 of file OptionalTuple.h.

template<typename... T>

ftype fhicl::OptionalTuple< T >::value_

private

Definition at line 60 of file OptionalTuple.h.

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

fhiclcpp/fhiclcpp/type_traits.h
fhiclcpp/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 >