fhicl::OptionalAtom< T > Class Template Reference

#include "type_traits.h"

Inheritance diagram for fhicl::OptionalAtom< T >:

Public Types
using	value_type = T

Public Member Functions
	OptionalAtom (Name &&name)
	OptionalAtom (Name &&name, Comment &&comment)
	OptionalAtom (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
std::optional< T >	operator() () const
bool	operator() (T &value) const
bool	hasValue () const
	OptionalAtom ()
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 &) override

Private Attributes
std::optional< T >	value_ {}

Detailed Description

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

Definition at line 27 of file type_traits.h.

Member Typedef Documentation

template<typename T>

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

Definition at line 66 of file OptionalAtom.h.

Constructor & Destructor Documentation

template<typename T >

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

explicit

Definition at line 84 of file OptionalAtom.h.

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

    : OptionalAtom{std::move(name), Comment("")}
  {}

template<typename T >

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

explicit

Definition at line 89 of file OptionalAtom.h.

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

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

template<typename T >

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

explicit

Definition at line 100 of file OptionalAtom.h.

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

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

template<typename T>

fhicl::OptionalAtom< T >::OptionalAtom

(

)

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::OptionalAtom< T >::do_set_value ( fhicl::ParameterSet const &  pset )

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 129 of file OptionalAtom.h.

References fhicl::ParameterSet::get_if_present(), fhicl::detail::ParameterBase::key(), fhicl::detail::strip_first_containing_name(), value, and fhicl::OptionalAtom< T >::value_.

  {
    auto const trimmed_key = detail::strip_first_containing_name(key());
    if (auto value = pset.get_if_present<T>(trimmed_key)) {
      value_ = *value;
    }
  }

template<typename T >

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

overrideprivatevirtual

Implements fhicl::detail::AtomBase.

Definition at line 114 of file OptionalAtom.h.

References fhicl::OptionalAtom< T >::value_.

  {
    std::stringstream oss;
    if (value_) {
      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();
  }

template<typename T>

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

inline

Definition at line 60 of file OptionalAtom.h.

Referenced by fhicl::OptionalAtom< RunNumber_t >::operator()().

    {
      return value_.has_value();
    }

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>

std::optional<T> fhicl::OptionalAtom< T >::operator() ( ) const

inline

Definition at line 43 of file OptionalAtom.h.

    {
      return value_;
    }

template<typename T>

bool fhicl::OptionalAtom< T >::operator() ( T &  value ) const

inline

Definition at line 50 of file OptionalAtom.h.

    {
      if (hasValue()) {
        value = *value_;
        return true;
      }
      return false;
    }

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>

std::optional<T> fhicl::OptionalAtom< T >::value_ {}

private

Definition at line 71 of file OptionalAtom.h.

Referenced by fhicl::OptionalAtom< T >::do_set_value(), fhicl::OptionalAtom< T >::get_stringified_value(), fhicl::OptionalAtom< RunNumber_t >::hasValue(), and fhicl::OptionalAtom< RunNumber_t >::operator()().

---

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

• fhiclcpp/type_traits.h
• fhiclcpp/types/OptionalAtom.h