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

#include "type_traits.h"

Public Types
using	default_type = T
using	via_type = typename OptionalTable< Config >::value_type
using	value_type = T

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

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

Private Attributes
OptionalTable< Config >	tableObj_
std::shared_ptr< T >	t_ {}

Detailed Description

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

Definition at line 53 of file type_traits.h.

Member Typedef Documentation

template<typename T, typename Config>

using fhicl::TableAs< T, Config >::default_type = T

Definition at line 50 of file TableAs.h.

template<typename T, typename Config>

using fhicl::TableAs< T, Config >::value_type = T

Definition at line 52 of file TableAs.h.

template<typename T, typename Config>

using fhicl::TableAs< T, Config >::via_type = typename OptionalTable<Config>::value_type

Definition at line 51 of file TableAs.h.

Constructor & Destructor Documentation

template<typename T , typename Config >

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

explicit

Definition at line 104 of file TableAs.h.

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

template<typename T , typename Config >

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

explicit

Definition at line 109 of file TableAs.h.

References fhicl::TableAs< T, Config >::conversion_comment(), fhicl::REQUIRED, fhicl::detail::ParameterBase::set_par_style(), and fhicl::TableAs< T, Config >::tableObj_.

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

template<typename T , typename Config >

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

explicit

Definition at line 116 of file TableAs.h.

References fhicl::TableAs< T, Config >::conversion_comment(), fhicl::REQUIRED_CONDITIONAL, fhicl::detail::ParameterBase::set_par_style(), and fhicl::TableAs< T, Config >::tableObj_.

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

template<typename T , typename Config >

fhicl::TableAs< T, Config >::TableAs ( Name &&  name, T const &  t  )

explicit

Definition at line 128 of file TableAs.h.

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

template<typename T , typename Config >

fhicl::TableAs< T, Config >::TableAs ( Name &&  name, Comment &&  comment, T const &  t  )

explicit

Definition at line 133 of file TableAs.h.

References fhicl::TableAs< T, Config >::conversion_comment(), fhicl::DEFAULT, fhicl::detail::ParameterBase::set_par_style(), fhicl::TableAs< T, Config >::t_, and fhicl::TableAs< T, Config >::tableObj_.

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

template<typename T , typename Config >

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

explicit

Definition at line 141 of file TableAs.h.

References fhicl::TableAs< T, Config >::conversion_comment(), fhicl::DEFAULT_CONDITIONAL, fhicl::detail::ParameterBase::set_par_style(), fhicl::TableAs< T, Config >::t_, and fhicl::TableAs< T, Config >::tableObj_.

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

Member Function Documentation

template<typename T , typename Config >

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

private

Definition at line 157 of file TableAs.h.

References fhicl::Comment::value.

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

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

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

private

Definition at line 173 of file TableAs.h.

References fhicl::detail::maybe_insert(), and fhicl::Comment::value.

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

template<typename T, typename Config>

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

inlinenoexcept

Definition at line 89 of file TableAs.h.

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

{ return tableObj_; }

template<typename T, typename Config>

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

inlinenoexcept

Definition at line 81 of file TableAs.h.

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

{ return tableObj_; }

template<typename T, typename Config>

T fhicl::TableAs< T, Config >::operator() ( ) const

inline

Definition at line 69 of file TableAs.h.

References fhicl::cant_find, fhicl::detail::ParameterBase::has_default(), fhicl::TableAs< T, Config >::t_, and fhicl::TableAs< T, Config >::tableObj_.

    {
      via_type via;
      return tableObj_(via) ? convert(via) :
             tableObj_.has_default() ?
                              *t_ :
                              throw fhicl::exception(
                                cant_find); // fix this exception category!
    }

Member Data Documentation

template<typename T, typename Config>

std::shared_ptr<T> fhicl::TableAs< T, Config >::t_ {}

private

Definition at line 94 of file TableAs.h.

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

template<typename T, typename Config>

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

private

Definition at line 92 of file TableAs.h.

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

---

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

• fhiclcpp/type_traits.h
• fhiclcpp/types/TableAs.h