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

#include "TupleAs.h"

Public Types
using	default_type = T
using	via_type = typename OptionalTuple< ARGS... >::value_type
using	value_type = T
using	ftype = typename OptionalTuple< ARGS... >::ftype

Public Member Functions
	TupleAs (Name &&name)
	TupleAs (Name &&name, Comment &&comment)
	TupleAs (Name &&name, Comment &&comment, std::function< bool()> maybeUse)
	TupleAs (Name &&name, T const &t)
	TupleAs (Name &&name, Comment &&comment, T const &t)
	TupleAs (Name &&name, Comment &&comment, std::function< bool()> maybeUse, T const &t)
T	operator() () const
	operator detail::ParameterBase & ()

Private Member Functions
Comment	conversion_comment (Comment &&comment) const
Comment	conversion_comment (Comment &&comment, T const &t) const

Private Attributes
OptionalTuple< ARGS... >	tupleObj_
std::shared_ptr< T >	t_ {}

Detailed Description

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

Definition at line 27 of file TupleAs.h.

Member Typedef Documentation

template<typename T , typename... ARGS>

using fhicl::TupleAs< T(ARGS...)>::default_type = T

Definition at line 29 of file TupleAs.h.

template<typename T , typename... ARGS>

using fhicl::TupleAs< T(ARGS...)>::ftype = typename OptionalTuple<ARGS...>::ftype

Definition at line 32 of file TupleAs.h.

template<typename T , typename... ARGS>

using fhicl::TupleAs< T(ARGS...)>::value_type = T

Definition at line 31 of file TupleAs.h.

template<typename T , typename... ARGS>

using fhicl::TupleAs< T(ARGS...)>::via_type = typename OptionalTuple<ARGS...>::value_type

Definition at line 30 of file TupleAs.h.

Constructor & Destructor Documentation

template<typename T , typename... ARGS>

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

explicit

Definition at line 81 of file TupleAs.h.

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

template<typename T , typename... ARGS>

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

explicit

Definition at line 86 of file TupleAs.h.

References fhicl::REQUIRED.

    : tupleObj_{std::move(name), conversion_comment(std::move(comment))}
  {
    tupleObj_.set_par_style(par_style::REQUIRED);
  }

template<typename T , typename... ARGS>

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

explicit

Definition at line 93 of file TupleAs.h.

References fhicl::REQUIRED_CONDITIONAL.

    : tupleObj_{std::move(name),
                conversion_comment(std::move(comment)),
                maybeUse}
  {
    tupleObj_.set_par_style(par_style::REQUIRED_CONDITIONAL);
  }

template<typename T , typename... ARGS>

fhicl::TupleAs< T(ARGS...)>::TupleAs ( Name &&  name, T const &  t  )

explicit

Definition at line 105 of file TupleAs.h.

    : TupleAs{std::move(name), Comment(""), t}
  {}

template<typename T , typename... ARGS>

fhicl::TupleAs< T(ARGS...)>::TupleAs ( Name &&  name, Comment &&  comment, T const &  t  )

explicit

Definition at line 110 of file TupleAs.h.

References fhicl::DEFAULT.

    : tupleObj_{std::move(name), conversion_comment(std::move(comment), t)}
    , t_{std::make_shared<T>(t)}
  {
    tupleObj_.set_par_style(par_style::DEFAULT);
  }

template<typename T , typename... ARGS>

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

explicit

Definition at line 118 of file TupleAs.h.

References fhicl::DEFAULT_CONDITIONAL.

    : tupleObj_{std::move(name),
                conversion_comment(std::move(comment), t),
                maybeUse}
    , t_{std::make_shared<T>(t)}
  {
    tupleObj_.set_par_style(par_style::DEFAULT_CONDITIONAL);
  }

Member Function Documentation

template<typename T , typename... ARGS>

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

private

Definition at line 134 of file TupleAs.h.

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

Comment fhicl::TupleAs< T(ARGS...)>::conversion_comment ( Comment &&  comment, T const &  t  ) const

private

Definition at line 150 of file TupleAs.h.

References fhicl::detail::maybe_insert().

  {
    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 << '\n'
        << detail::maybe_insert(t) << user_comment;
    return Comment{oss.str().c_str()};
  }

template<typename T , typename... ARGS>

fhicl::TupleAs< T(ARGS...)>::operator detail::ParameterBase & ( )

inline

Definition at line 62 of file TupleAs.h.

    {
      return tupleObj_;
    } // Allows implicit conversion from

template<typename T , typename... ARGS>

T fhicl::TupleAs< T(ARGS...)>::operator() ( ) const

inline

Definition at line 49 of file TupleAs.h.

References fhicl::cant_find.

    {
      via_type via;
      return tupleObj_(via) ? std::make_from_tuple<T>(via) :
             tupleObj_.has_default() ?
                              *t_ :
                              throw fhicl::exception(
                                cant_find); // fix this exception category!
    }

Member Data Documentation

template<typename T , typename... ARGS>

std::shared_ptr<T> fhicl::TupleAs< T(ARGS...)>::t_ {}

private

Definition at line 71 of file TupleAs.h.

template<typename T , typename... ARGS>

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

private

Definition at line 69 of file TupleAs.h.

---

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

• fhiclcpp/types/TupleAs.h