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 ()
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 &) override
Private Member Functions inherited from fhicl::detail::RegisterIfTableMember
	RegisterIfTableMember (ParameterBase *pb)

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.

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

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

    : 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

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.

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

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

template<typename T>

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

inline

Definition at line 60 of file OptionalAtom.h.

    {
      return value_.has_value();
    }

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;
    }

Member Data Documentation

template<typename T>

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

private

Definition at line 71 of file OptionalAtom.h.

---

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

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