fhicl::OptionalTupleAs< T(ARGS...)> Class Template Reference

#include "OptionalTupleAs.h"

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

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

Private Attributes
OptionalTuple< ARGS... >	tupleObj_

Detailed Description

template<typename T, typename... ARGS>
class fhicl::OptionalTupleAs< T(ARGS...)>

Definition at line 25 of file OptionalTupleAs.h.

Constructor & Destructor Documentation

template<typename T , typename... ARGS>

fhicl::OptionalTupleAs< T(ARGS...)>::OptionalTupleAs ( Name &&  name )

explicit

Definition at line 83 of file OptionalTupleAs.h.

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

template<typename T , typename... ARGS>

fhicl::OptionalTupleAs< T(ARGS...)>::OptionalTupleAs ( Name &&  name, Comment &&  comment  )

explicit

Definition at line 88 of file OptionalTupleAs.h.

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

template<typename T , typename... ARGS>

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

explicit

Definition at line 93 of file OptionalTupleAs.h.

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

Member Function Documentation

template<typename T , typename... ARGS>

Comment fhicl::OptionalTupleAs< T(ARGS...)>::conversion_comment ( Comment &&  comment ) const

inlineprivate

Definition at line 63 of file OptionalTupleAs.h.

References fhicl::Comment::value.

    {
      std::string const preface =
        "N.B. The following sequence 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... ARGS>

bool fhicl::OptionalTupleAs< T(ARGS...)>::hasValue ( ) const

inline

Definition at line 54 of file OptionalTupleAs.h.

    {
      return tupleObj_.hasValue();
    }

template<typename T , typename... ARGS>

std::optional<T> fhicl::OptionalTupleAs< T(ARGS...)>::operator() ( ) const

inline

Definition at line 34 of file OptionalTupleAs.h.

    {
      if (auto via = tupleObj_()) {
        return make_optional(std::make_from_tuple(*via));
      }
      return std::nullopt;
    }

template<typename T , typename... ARGS>

bool fhicl::OptionalTupleAs< T(ARGS...)>::operator() ( T &  result ) const

inline

Definition at line 44 of file OptionalTupleAs.h.

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

Member Data Documentation

template<typename T , typename... ARGS>

OptionalTuple<ARGS...> fhicl::OptionalTupleAs< T(ARGS...)>::tupleObj_

private

Definition at line 60 of file OptionalTupleAs.h.

---

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

• fhiclcpp/types/OptionalTupleAs.h