#include <Sequence.h>

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

Public Types
using	default_type = std::vector< typename tt::fhicl_type< T >::default_type >

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

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

Public Member Functions
	Sequence (Name &&name)

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

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

	Sequence (Name &&name, default_type const &defaults)

	Sequence (Name &&name, Comment &&comment, default_type const &defaults)

	Sequence (Name &&name, Comment &&comment, std::function< bool()> maybeUse, default_type const &defaults)

auto	operator() () const

auto	operator() (std::size_t const i) 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 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 &ps) 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_

Detailed Description

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

Definition at line 181 of file Sequence.h.

Member Typedef Documentation

template<typename T >

using fhicl::Sequence< T,-1ull >::default_type = std::vector<typename tt::fhicl_type<T>::default_type>

Definition at line 188 of file Sequence.h.

template<typename T >

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

Definition at line 189 of file Sequence.h.

template<typename T >

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

Definition at line 190 of file Sequence.h.

Constructor & Destructor Documentation

template<typename T >

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

explicit

Definition at line 422 of file Sequence.h.

423 : Sequence{std::move(name), Comment{""}}

424 {}

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

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

Sequence(Name &&name)

Definition: Sequence.h:422

template<typename T >

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

explicit

Definition at line 427 of file Sequence.h.

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

explicit

Definition at line 441 of file Sequence.h.

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

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence	(	Name &&	name,
		default_type const &	defaults
	)

explicit

Definition at line 458 of file Sequence.h.

459 : Sequence{std::move(name), Comment{""}, defaults}

460 {}

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

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

Sequence(Name &&name)

Definition: Sequence.h:422

template<typename T >

fhicl::Sequence< T,-1ull >::Sequence	(	Name &&	name,
		Comment &&	comment,
		default_type const &	defaults
	)

explicit

Definition at line 463 of file Sequence.h.

     : SequenceBase{std::move(name),
                    std::move(comment),
                    par_style::DEFAULT,
                    par_type::SEQ_VECTOR,
                    detail::AlwaysUse()}
     , RegisterIfTableMember{this}
   {
     static_assert(!tt::is_table_v<T>, NO_DEFAULTS_FOR_TABLE);
     std::size_t i{};
     auto& value = std::get<ftype>(value_);
     for (auto const& t : defaults) {
       value.push_back(
         std::make_shared<tt::fhicl_type<T>>(Name::sequence_element(i), t));
       ++i;
     }
     NameStackRegistry::end_of_ctor();
   }

template<typename T >

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

explicit

Definition at line 485 of file Sequence.h.

     : SequenceBase{std::move(name),
                    std::move(comment),
                    par_style::DEFAULT_CONDITIONAL,
                    par_type::SEQ_VECTOR,
                    maybeUse}
     , RegisterIfTableMember{this}
   {
     static_assert(!tt::is_table_v<T>, NO_DEFAULTS_FOR_TABLE);
     std::size_t i{};
     auto& value = std::get<ftype>(value_);
     for (auto const& t : defaults) {
       value.emplace_back(
         std::make_shared<tt::fhicl_type<T>>(Name::sequence_element(i), t));
       ++i;
     }
     NameStackRegistry::end_of_ctor();
   }

Member Function Documentation

template<typename T >

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 234 of file Sequence.h.

     {
       // We only enter here if we do not have a preset value.
       auto& value = std::get<ftype>(value_);
 
       // For an unbounded sequence, we need to resize it so that any
       // nested parameters of the elements can be checked.
       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.push_back(std::make_shared<tt::fhicl_type<T>>(
             Name::sequence_element(key_fragment, i)));
         }
       }
     }

template<typename T >

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

inlineoverrideprivatevirtual

Reimplemented from fhicl::detail::ParameterBase.

Definition at line 292 of file Sequence.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);
         return true;
       }
       return false;
     }

template<typename T >

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

inlineoverrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 303 of file Sequence.h.

304 {}

template<typename T >

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

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

inlineoverrideprivatevirtual

Implements fhicl::detail::SequenceBase.

Definition at line 283 of file Sequence.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::Sequence< T,-1ull >::get_size ( ) const

inlineoverrideprivatevirtualnoexcept

Implements fhicl::detail::SequenceBase.

Definition at line 265 of file Sequence.h.

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

template<typename T >

auto fhicl::Sequence< T,-1ull >::operator() ( ) const

inline

Definition at line 209 of file Sequence.h.

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

template<typename T >

auto fhicl::Sequence< T,-1ull >::operator() ( std::size_t const i ) const

inline

Definition at line 222 of file Sequence.h.

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

Member Data Documentation

template<typename T >

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

private

Definition at line 231 of file Sequence.h.

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

fhiclcpp/fhiclcpp/types/Sequence.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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