fhicl::OptionalDelegatedParameter Class Reference

#include <OptionalDelegatedParameter.h>

Inheritance diagram for fhicl::OptionalDelegatedParameter:

Public Member Functions
	OptionalDelegatedParameter (Name &&name)
	OptionalDelegatedParameter (Name &&name, Comment &&comment)
	OptionalDelegatedParameter (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
bool	hasValue () const
template<typename T >
std::optional< T >	get_if_present () const
template<typename T >
bool	get_if_present (T &t) const
Public Member Functions inherited from fhicl::detail::DelegateBase
	DelegateBase (Name const &name, Comment const &comment, par_style const vt, std::function< bool()> maybeUse)
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_set_value (fhicl::ParameterSet const &pset) override
Private Member Functions inherited from fhicl::detail::RegisterIfTableMember
	RegisterIfTableMember (ParameterBase *pb)

Private Attributes
std::optional< ParameterSet >	pset_ {std::nullopt}

Detailed Description

Definition at line 18 of file OptionalDelegatedParameter.h.

Constructor & Destructor Documentation

fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter ( Name &&  name )

explicit

Definition at line 7 of file OptionalDelegatedParameter.cc.

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

fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter ( Name &&  name, Comment &&  comment  )

explicit

Definition at line 11 of file OptionalDelegatedParameter.cc.

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

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

explicit

Definition at line 22 of file OptionalDelegatedParameter.cc.

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

Member Function Documentation

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

inlineoverrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 60 of file OptionalDelegatedParameter.h.

    {
      pset_ = std::make_optional(pset);
    };

template<typename T >

std::optional<T> fhicl::OptionalDelegatedParameter::get_if_present ( ) const

inline

Definition at line 36 of file OptionalDelegatedParameter.h.

    {
      if (not pset_) {
        return std::nullopt;
      }

      auto const trimmed_key = detail::strip_first_containing_name(key());
      return pset_->get_if_present<T>(trimmed_key);
    }

template<typename T >

bool fhicl::OptionalDelegatedParameter::get_if_present ( T &  t ) const

inline

Definition at line 49 of file OptionalDelegatedParameter.h.

    {
      if (auto result = get_if_present<T>()) {
        t = *result;
        return true;
      }
      return false;
    }

bool fhicl::OptionalDelegatedParameter::hasValue ( ) const

inline

Definition at line 28 of file OptionalDelegatedParameter.h.

    {
      return pset_ &&
             pset_->has_key(detail::strip_first_containing_name(key()));
    }

Member Data Documentation

std::optional<ParameterSet> fhicl::OptionalDelegatedParameter::pset_ {std::nullopt}

private

Definition at line 65 of file OptionalDelegatedParameter.h.

---

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

• fhiclcpp/fhiclcpp/types/OptionalDelegatedParameter.h
• fhiclcpp/fhiclcpp/types/OptionalDelegatedParameter.cc