fhicl::DelegatedParameter Class Reference

#include "DelegatedParameter.h"

Inheritance diagram for fhicl::DelegatedParameter:

Public Member Functions
	DelegatedParameter (Name &&name)
	DelegatedParameter (Name &&name, Comment &&comment)
	DelegatedParameter (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
template<typename T >
auto	get () const
std::string	key () const
std::string	name () const
std::string	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 trimParents)
void	set_par_style (par_style const vt)
void	set_key (std::string const &key)

Private Member Functions
void	do_set_value (fhicl::ParameterSet const &pset, bool const ) override

Private Attributes
fhicl::ParameterSet	pset_ {}

Detailed Description

Definition at line 17 of file DelegatedParameter.h.

Constructor & Destructor Documentation

fhicl::DelegatedParameter::DelegatedParameter ( Name &&  name )

explicit

Definition at line 8 of file DelegatedParameter.cc.

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

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

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

explicit

Definition at line 12 of file DelegatedParameter.cc.

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

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

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

explicit

Definition at line 22 of file DelegatedParameter.cc.

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

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

Member Function Documentation

std::string fhicl::detail::ParameterBase::comment ( ) const

inlineinherited

Definition at line 54 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::comment(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::DelegateBase::DelegateBase(), DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::Tuple().

      {
        return mdata_.comment();
      }

void fhicl::DelegatedParameter::do_set_value ( fhicl::ParameterSet const &  pset, bool  const  )

inlineoverrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 39 of file DelegatedParameter.h.

References pset_.

    {
      pset_ = pset;
    };

template<typename T >

auto fhicl::DelegatedParameter::get ( ) const

inline

Definition at line 30 of file DelegatedParameter.h.

References fhicl::ParameterSet::get(), fhicl::detail::ParameterBase::key(), pset_, and fhicl::detail::strip_first_containing_name().

    {
      std::string const& trimmed_key =
        detail::strip_first_containing_name(key());
      return pset_.get<T>(trimmed_key);
    }

bool fhicl::detail::ParameterBase::has_default ( ) const

inlineinherited

Definition at line 59 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::has_default(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), and fhicl::detail::PrintAllowedConfiguration::enter_sequence().

      {
        return mdata_.has_default();
      }

bool fhicl::detail::ParameterBase::is_conditional ( ) const

inlineinherited

Definition at line 69 of file ParameterBase.h.

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

inlineinherited

Definition at line 64 of file ParameterBase.h.

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 evgen::MARLEYHelper::fhicl_parameter_to_json().

      {
        return mdata_.is_optional();
      }

std::string fhicl::detail::ParameterBase::key ( ) const

inlineinherited

Definition at line 44 of file ParameterBase.h.

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::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >::do_prepare_elements_for_validation(), fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::detail::ValidateThenSet::enter_sequence(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), get(), fhicl::OptionalDelegatedParameter::get_if_present(), fhicl::OptionalDelegatedParameter::hasValue(), fhicl::detail::MaybeDisplayParent::is_sequence_element(), fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::detail::PrintAllowedConfiguration::suppressFormat().

      {
        return mdata_.key();
      }

std::string fhicl::detail::ParameterBase::name ( ) const

inlineinherited

Definition at line 49 of file ParameterBase.h.

References fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::name().

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::detail::ValidateThenSet::delegated_parameter(), DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::Tuple().

      {
        return mdata_.name();
      }

par_type fhicl::detail::ParameterBase::parameter_type ( ) const

inlineinherited

Definition at line 74 of file ParameterBase.h.

References fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::type().

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), and fhicl::detail::RegisterIfTableMember::RegisterIfTableMember().

      {
        return mdata_.type();
      }

void fhicl::detail::ParameterBase::set_key ( std::string const &  key )

inlineinherited

Definition at line 106 of file ParameterBase.h.

References fhicl::detail::ParameterBase::do_set_value(), fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::set_key().

      {
        mdata_.set_key(key);
      }

void fhicl::detail::ParameterBase::set_par_style ( par_style const  vt )

inlineinherited

Definition at line 101 of file ParameterBase.h.

References fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::set_par_style().

Referenced by art::RootOutput::Config::Config().

      {
        mdata_.set_par_style(vt);
      }

void fhicl::detail::ParameterBase::set_value ( fhicl::ParameterSet const &  ps, bool  trimParents  )

inlineinherited

Definition at line 96 of file ParameterBase.h.

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

Referenced by fhicl::detail::ValidateThenSet::after_action().

      {
        do_set_value(ps, trimParents);
      }

bool fhicl::detail::ParameterBase::should_use ( ) const

inlineinherited

Definition at line 79 of file ParameterBase.h.

References fhicl::detail::ParameterBase::maybeUse_.

Referenced by fhicl::detail::ValidateThenSet::before_action(), and evgen::MARLEYHelper::fhicl_parameter_to_json().

      {
        return maybeUse_();
      }

Member Data Documentation

fhicl::ParameterSet fhicl::DelegatedParameter::pset_ {}

private

Definition at line 45 of file DelegatedParameter.h.

Referenced by do_set_value(), and get().

---

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

• fhiclcpp/types/DelegatedParameter.h
• fhiclcpp/types/DelegatedParameter.cc