fhicl::OptionalTableAs< T, Config > Class Template Reference

#include "type_traits.h"

Public Member Functions
	OptionalTableAs (Name &&name)
	OptionalTableAs (Name &&name, Comment &&comment)
	OptionalTableAs (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
std::optional< T >	operator() () const
bool	operator() (T &result) const
bool	hasValue () const
	operator detail::ParameterBase const & () const noexcept

Private Member Functions
Comment	conversion_comment (Comment &&comment) const

Private Attributes
OptionalTable< Config >	tableObj_

Detailed Description

template<typename T, typename Config>
class fhicl::OptionalTableAs< T, Config >

Definition at line 55 of file type_traits.h.

Constructor & Destructor Documentation

template<typename T , typename Config >

fhicl::OptionalTableAs< T, Config >::OptionalTableAs ( Name &&  name )

explicit

Definition at line 82 of file OptionalTableAs.h.

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

template<typename T , typename Config >

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

explicit

Definition at line 87 of file OptionalTableAs.h.

References fhicl::OptionalTableAs< T, Config >::conversion_comment().

    : tableObj_{std::move(name), conversion_comment(std::move(comment))}
  {}

template<typename T , typename Config >

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

explicit

Definition at line 92 of file OptionalTableAs.h.

References fhicl::OptionalTableAs< T, Config >::conversion_comment().

    : tableObj_{std::move(name),
                conversion_comment(std::move(comment)),
                maybeUse}
  {}

Member Function Documentation

template<typename T , typename Config >

Comment fhicl::OptionalTableAs< T, Config >::conversion_comment ( Comment &&  comment ) const

inlineprivate

Definition at line 62 of file OptionalTableAs.h.

References fhicl::Comment::value.

Referenced by fhicl::OptionalTableAs< T, Config >::OptionalTableAs().

    {
      std::string const preface =
        "N.B. The following table is converted to type:";
      std::string const name =
        "        '" + cet::demangle_symbol(typeid(T).name()) + "'";
      std::string const user_comment =
        comment.value.empty() ? "" : "\n\n" + comment.value;

      std::ostringstream oss;
      oss << preface << '\n' << name << user_comment;

      return Comment{oss.str().c_str()};
    }

template<typename T , typename Config >

bool fhicl::OptionalTableAs< T, Config >::hasValue ( ) const

inline

Definition at line 49 of file OptionalTableAs.h.

References fhicl::OptionalTable< T >::hasValue(), and fhicl::OptionalTableAs< T, Config >::tableObj_.

    {
      return tableObj_.hasValue();
    }

template<typename T , typename Config >

fhicl::OptionalTableAs< T, Config >::operator detail::ParameterBase const & ( ) const

inlinenoexcept

Definition at line 56 of file OptionalTableAs.h.

References fhicl::OptionalTableAs< T, Config >::tableObj_.

{ return tableObj_; }

template<typename T , typename Config >

std::optional<T> fhicl::OptionalTableAs< T, Config >::operator() ( ) const

inline

Definition at line 29 of file OptionalTableAs.h.

References fhicl::OptionalTableAs< T, Config >::tableObj_.

Referenced by fhicl::OptionalTableAs< T, Config >::operator()().

    {
      if (auto via = tableObj_()) {
        return std::make_optional(convert(*via));
      }
      return std::nullopt;
    }

template<typename T , typename Config >

bool fhicl::OptionalTableAs< T, Config >::operator() ( T &  result ) const

inline

Definition at line 39 of file OptionalTableAs.h.

References fhicl::OptionalTableAs< T, Config >::operator()().

    {
      auto t = operator()();
      if (t) {
        result = *t;
      }
      return t.has_value();
    }

Member Data Documentation

template<typename T , typename Config >

OptionalTable<Config> fhicl::OptionalTableAs< T, Config >::tableObj_

private

Definition at line 59 of file OptionalTableAs.h.

Referenced by fhicl::OptionalTableAs< T, Config >::hasValue(), fhicl::OptionalTableAs< T, Config >::operator detail::ParameterBase const &(), and fhicl::OptionalTableAs< T, Config >::operator()().

---

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

• fhiclcpp/type_traits.h
• fhiclcpp/types/OptionalTableAs.h