#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)

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

bool	operator() (value_type &t) const

bool	hasValue () const noexcept

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 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 &) override

void	do_set_value (fhicl::ParameterSet const &) override

Private Member Functions inherited from fhicl::detail::RegisterIfTableMember
	RegisterIfTableMember (ParameterBase *pb)

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

bool	has_value_ {false}

Detailed Description

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

Definition at line 124 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 132 of file OptionalSequence.h.

template<typename T >

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

Definition at line 133 of file OptionalSequence.h.

Constructor & Destructor Documentation

template<typename T >

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

explicit

Definition at line 321 of file OptionalSequence.h.

322 : OptionalSequence{std::move(name), Comment("")}

323 {}

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

OptionalSequence(Name &&name)

Definition: OptionalSequence.h:321

fhicl::detail::ParameterBase::name

std::string const & name() const

Definition: ParameterBase.h:43

wirecell.gen.depos.move

def move(depos, offset)

Definition: depos.py:107

Comment

#define Comment

Definition: commentscan.cpp:4062

template<typename T >

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

explicit

Definition at line 326 of file OptionalSequence.h.

     : SequenceBase{std::move(name),
                    std::move(comment),
                    par_style::OPTIONAL,
                    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::OptionalSequence< T,-1ull >::OptionalSequence	(	Name &&	name,
		Comment &&	comment,
		std::function< bool()>	maybeUse
	)

explicit

Definition at line 340 of file OptionalSequence.h.

     : SequenceBase{std::move(name),
                    std::move(comment),
                    par_style::OPTIONAL_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();
   }

Member Function Documentation

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 180 of file OptionalSequence.h.

     {
       // We only enter here if we do not have a preset value.
       auto& value = std::get<ftype>(value_);
 
       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.emplace_back(
             new tt::fhicl_type<T>{Name::sequence_element(key_fragment, i)});
         }
       }
     }

template<typename T >

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

overrideprivatevirtual

Reimplemented from fhicl::detail::ParameterBase.

Definition at line 357 of file OptionalSequence.h.

   {
     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);
       has_value_ = true;
       return true;
     }
     return false;
   }

template<typename T >

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

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 370 of file OptionalSequence.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::OptionalSequence< T,-1ull >::do_walk_elements ( detail::ParameterWalker< tt::const_flavor::require_non_const > & pw )

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 219 of file OptionalSequence.h.

     {
       // 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::OptionalSequence< T,-1ull >::do_walk_elements ( detail::ParameterWalker< tt::const_flavor::require_const > & pw ) const

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 228 of file OptionalSequence.h.

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

template<typename T >

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

inlineoverrideprivatevirtualnoexcept

Implements fhicl::detail::SequenceBase.

Definition at line 210 of file OptionalSequence.h.

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

template<typename T >

bool fhicl::OptionalSequence< T,-1ull >::hasValue ( ) const

inlinenoexcept

Definition at line 170 of file OptionalSequence.h.

     {
       return has_value_;
     }

template<typename T >

std::optional<value_type> fhicl::OptionalSequence< T,-1ull >::operator() ( ) const

inline

Definition at line 142 of file OptionalSequence.h.

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

template<typename T >

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

inline

Definition at line 160 of file OptionalSequence.h.

     {
       if (auto result = operator()()) {
         t = *result;
         return true;
       }
       return false;
     }

Member Data Documentation

template<typename T >

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

private

Definition at line 177 of file OptionalSequence.h.

template<typename T >

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

private

Definition at line 176 of file OptionalSequence.h.

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

fhiclcpp/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 >