#include "type_traits.h"

Inheritance diagram for fhicl::Atom< T >:

Public Types
using	default_type = T

using	value_type = T

Public Member Functions
	Atom (Name &&name)

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

	Atom (Name &&name, Comment &&comment, std::function< bool()> useIf)

	Atom (Name &&name, T const &dflt_value)

	Atom (Name &&name, Comment &&comment, T const &dflt_value)

	Atom (Name &&name, Comment &&comment, std::function< bool()> useIf, T const &dflt_value)

auto const &	operator() () const

std::string	stringified_value () 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 Member Functions
std::string	get_stringified_value () const override

void	do_set_value (fhicl::ParameterSet const &pset) override

Private Attributes
value_type	value_ {}

Detailed Description

template<typename T>
class fhicl::Atom< T >

Definition at line 25 of file type_traits.h.

Member Typedef Documentation

template<typename T>

using fhicl::Atom< T >::default_type = T

Definition at line 55 of file Atom.h.

template<typename T>

using fhicl::Atom< T >::value_type = T

Definition at line 56 of file Atom.h.

Constructor & Destructor Documentation

template<typename T >

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

explicit

Definition at line 122 of file Atom.h.

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

122 : Atom{std::move(name), Comment("")}

123 {}

fhicl::Atom::Atom

Atom(Name &&name)

Definition: Atom.h:122

fhicl::detail::ParameterBase::name

std::string const & name() const

Definition: ParameterBase.cc:11

template<typename T >

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

explicit

Definition at line 73 of file Atom.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::REQUIRED.

     : AtomBase{std::move(name),
                std::move(comment),
                par_style::REQUIRED,
                detail::AlwaysUse()}
     , RegisterIfTableMember{this}
   {
     NameStackRegistry::end_of_ctor();
   }

template<typename T >

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

explicit

Definition at line 84 of file Atom.h.

References fhicl::detail::ParameterBase::comment(), fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::REQUIRED_CONDITIONAL.

     : AtomBase{std::move(name),
                std::move(comment),
                par_style::REQUIRED_CONDITIONAL,
                maybeUse}
     , RegisterIfTableMember{this}
   {
     NameStackRegistry::end_of_ctor();
   }

template<typename T>

fhicl::Atom< T >::Atom	(	Name &&	name,
		T const &	dflt_value
	)

explicit

Definition at line 126 of file Atom.h.

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

127 : Atom{std::move(name), Comment(""), dflt_value}

128 {}

fhicl::Atom::Atom

Atom(Name &&name)

Definition: Atom.h:122

fhicl::detail::ParameterBase::name

std::string const & name() const

Definition: ParameterBase.cc:11

template<typename T>

fhicl::Atom< T >::Atom	(	Name &&	name,
		Comment &&	comment,
		T const &	dflt_value
	)

explicit

Definition at line 95 of file Atom.h.

References fhicl::detail::AlwaysUse(), fhicl::detail::ParameterBase::comment(), fhicl::DEFAULT, fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::Atom< T >::value_.

     : AtomBase{std::move(name),
                std::move(comment),
                par_style::DEFAULT,
                detail::AlwaysUse()}
     , RegisterIfTableMember{this}
     , value_{dflt_value}
   {
     NameStackRegistry::end_of_ctor();
   }

template<typename T>

fhicl::Atom< T >::Atom	(	Name &&	name,
		Comment &&	comment,
		std::function< bool()>	useIf,
		T const &	dflt_value
	)

explicit

Definition at line 107 of file Atom.h.

References fhicl::detail::ParameterBase::comment(), fhicl::DEFAULT_CONDITIONAL, fhicl::NameStackRegistry::end_of_ctor(), fhicl::detail::ParameterBase::name(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::Atom< T >::value_.

     : AtomBase{std::move(name),
                std::move(comment),
                par_style::DEFAULT_CONDITIONAL,
                maybeUse}
     , RegisterIfTableMember{this}
     , value_{dflt_value}
   {
     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::Atom< T >::do_set_value ( fhicl::ParameterSet const & pset )

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 147 of file Atom.h.

References fhicl::ParameterSet::get(), fhicl::ParameterSet::get_if_present(), fhicl::detail::ParameterBase::has_default(), fhicl::detail::ParameterBase::key(), fhicl::detail::strip_first_containing_name(), and fhicl::Atom< T >::value_.

   {
     auto const trimmed_key = detail::strip_first_containing_name(key());
     if (has_default()) {
       // Override default value if the key is present
       pset.get_if_present<T>(trimmed_key, value_);
     } else
       value_ = pset.get<T>(trimmed_key);
   }

template<typename T >

std::string fhicl::Atom< T >::get_stringified_value ( ) const

overrideprivatevirtual

Implements fhicl::detail::AtomBase.

Definition at line 132 of file Atom.h.

References fhicl::detail::ParameterBase::has_default(), and fhicl::Atom< T >::value_.

   {
     std::stringstream oss;
     if (has_default()) {
       using namespace detail::yes_defaults;
       oss << maybe_quotes<T>(value_);
     } else {
       using namespace detail::no_defaults;
       oss << expected_types<T>();
     }
     return oss.str();
   }

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

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

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 const& fhicl::Atom< T >::operator() ( ) const

inline

Definition at line 49 of file Atom.h.

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

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::string fhicl::detail::AtomBase::stringified_value ( ) const

inlineinherited

Definition at line 18 of file AtomBase.h.

References fhicl::detail::AtomBase::get_stringified_value().

Referenced by fhicl::detail::PrintAllowedConfiguration::atom().

     {
       return get_stringified_value();
     }

Member Data Documentation

template<typename T>

value_type fhicl::Atom< T >::value_ {}

private

Definition at line 59 of file Atom.h.

Referenced by fhicl::Atom< T >::Atom(), fhicl::Atom< T >::do_set_value(), fhicl::Atom< T >::get_stringified_value(), and fhicl::Atom< raw::ChannelID_t >::operator()().

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

fhiclcpp/type_traits.h
fhiclcpp/types/Atom.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename T> class fhicl::Atom< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T>
class fhicl::Atom< T >