fhicl::OptionalTable< T > Class Template Reference

#include <type_traits.h>

Inheritance diagram for fhicl::OptionalTable< T >:

Public Types
using	value_type = T

Public Member Functions
	OptionalTable (Name &&name)
	OptionalTable (Name &&name, Comment &&comment)
	OptionalTable (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
	OptionalTable (ParameterSet const &pset, std::set< std::string > const &keysToIgnore)
std::optional< T >	operator() () const
bool	operator() (T &value) const
bool	hasValue () const
ParameterSet const &	get_PSet () const
void	print_allowed_configuration (std::ostream &os, std::string const &tab=std::string(3, ' ')) const
	OptionalTable ()
void	validate (ParameterSet const &pset, std::set< std::string > const &keysToIgnore={})
Public Member Functions inherited from fhicl::detail::TableBase
	TableBase (Name const &name, Comment const &comment, par_style const vt, std::function< bool()> maybeUse)
std::vector< cet::exempt_ptr< ParameterBase > > const &	members () 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 Types
using	members_t = std::vector< cet::exempt_ptr< ParameterBase >>

Private Member Functions
members_t const &	get_members () const override
void	do_set_value (fhicl::ParameterSet const &pset) override
Private Member Functions inherited from fhicl::detail::RegisterIfTableMember
	RegisterIfTableMember (ParameterBase *pb)

Private Attributes
std::shared_ptr< T >	value_ {std::make_shared<T>()}
bool	has_value_ {false}
ParameterSet	pset_ {}
members_t	members_ {detail::TableMemberRegistry::release_members()}

Detailed Description

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

Definition at line 32 of file type_traits.h.

Member Typedef Documentation

template<typename T>

using fhicl::OptionalTable< T >::members_t = std::vector<cet::exempt_ptr<ParameterBase>>

private

Definition at line 87 of file OptionalTable.h.

template<typename T>

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

Definition at line 79 of file OptionalTable.h.

Constructor & Destructor Documentation

template<typename T >

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

explicit

Definition at line 122 of file OptionalTable.h.

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

template<typename T >

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

explicit

Definition at line 127 of file OptionalTable.h.

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

template<typename T >

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

explicit

Definition at line 138 of file OptionalTable.h.

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

template<typename T >

fhicl::OptionalTable< T >::OptionalTable	(	ParameterSet const &	pset,
		std::set< std::string > const &	keysToIgnore
	)

Definition at line 151 of file OptionalTable.h.

    : TableBase{Name("<top_level>"),
                Comment(""),
                par_style::OPTIONAL,
                detail::AlwaysUse()}
    , RegisterIfTableMember{this}
  {
    NameStackRegistry::end_of_ctor();
    validate(pset, keysToIgnore);
  }

template<typename T>

fhicl::OptionalTable< T >::OptionalTable

(

)

Member Function Documentation

template<typename T >

void fhicl::OptionalTable< T >::do_set_value ( fhicl::ParameterSet const &  pset )

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Definition at line 186 of file OptionalTable.h.

  {
    // Kind of tricky: we do not have the name of the current
    // parameter set.  A placeholder is often used
    // (e.g. "<top_level>").  Fortunately, since the pset is passed
    // in, we can just assign to it for a top-level ParameterSet.
    // However, for nested parameter sets, we need to trim off the
    // placeholder, and then the key we send
    // pset.get<fhicl::ParameterSet>(key) is the key relative to the
    // top-level pset.
    std::string const& rkey = key();
    std::string const& nkey = detail::strip_first_containing_name(rkey);
    if (nkey == rkey) {
      pset_ = pset;
      has_value_ = true;
    } else {
      has_value_ = pset.get_if_present<fhicl::ParameterSet>(nkey, pset_);
    }
  }

template<typename T>

members_t const& fhicl::OptionalTable< T >::get_members ( ) const

inlineoverrideprivatevirtual

Implements fhicl::detail::TableBase.

Definition at line 95 of file OptionalTable.h.

    {
      return members_;
    }

template<typename T>

ParameterSet const& fhicl::OptionalTable< T >::get_PSet ( ) const

inline

Definition at line 68 of file OptionalTable.h.

    {
      return pset_;
    }

template<typename T>

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

inline

Definition at line 62 of file OptionalTable.h.

    {
      return has_value_;
    }

template<typename T>

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

inline

Definition at line 45 of file OptionalTable.h.

    {
      return value_ ? std::make_optional(*value_) : std::nullopt;
    }

template<typename T>

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

inline

Definition at line 52 of file OptionalTable.h.

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

template<typename T >

void fhicl::OptionalTable< T >::print_allowed_configuration	(	std::ostream &	os,
		std::string const &	tab = std::string(3, ' ')
	)		const

Definition at line 176 of file OptionalTable.h.

  {
    os << '\n' << tab << detail::optional_parameter_message() << '\n';
    detail::PrintAllowedConfiguration pc{os};
    pc.walk_over(*this);
  }

template<typename T >

void fhicl::OptionalTable< T >::validate	(	ParameterSet const &	pset,
		std::set< std::string > const &	keysToIgnore = {}
	)

Definition at line 165 of file OptionalTable.h.

  {
    pset_ = pset;
    detail::ValidateThenSet vs{pset_, keysToIgnore};
    cet::for_all(members(), [&vs](auto m) { vs(m.get()); });
    vs.check_keys();
  }

Member Data Documentation

template<typename T>

bool fhicl::OptionalTable< T >::has_value_ {false}

private

Definition at line 90 of file OptionalTable.h.

template<typename T>

members_t fhicl::OptionalTable< T >::members_ {detail::TableMemberRegistry::release_members()}

private

Definition at line 92 of file OptionalTable.h.

template<typename T>

ParameterSet fhicl::OptionalTable< T >::pset_ {}

private

Definition at line 91 of file OptionalTable.h.

template<typename T>

std::shared_ptr<T> fhicl::OptionalTable< T >::value_ {std::make_shared<T>()}

private

Definition at line 89 of file OptionalTable.h.

---

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

• fhiclcpp/fhiclcpp/type_traits.h
• fhiclcpp/fhiclcpp/types/OptionalTable.h