fhicl::Atom< T > Class Template Reference

#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
Public Member Functions inherited from fhicl::detail::AtomBase
	AtomBase (Name const &name, Comment const &comment, par_style const vt, std::function< bool()> maybeUse)
std::string	stringified_value () 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 Member Functions
std::string	get_stringified_value () const override
void	do_set_value (fhicl::ParameterSet const &pset) override
Private Member Functions inherited from fhicl::detail::RegisterIfTableMember
	RegisterIfTableMember (ParameterBase *pb)

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.

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

template<typename T >

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

explicit

Definition at line 73 of file Atom.h.

    : 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.

    : 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.

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

template<typename T>

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

explicit

Definition at line 95 of file Atom.h.

    : 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.

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

Member Function Documentation

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.

  {
    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.

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

template<typename T>

auto const& fhicl::Atom< T >::operator() ( ) const

inline

Definition at line 49 of file Atom.h.

    {
      return value_;
    }

Member Data Documentation

template<typename T>

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

private

Definition at line 59 of file Atom.h.

---

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

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