Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
fhicl::Atom< T > Class Template Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/fhiclcpp/v4_06_10/source/fhiclcpp/type_traits.h"

Inheritance diagram for fhicl::Atom< T >:
fhicl::detail::AtomBase fhicl::detail::RegisterIfTableMember fhicl::detail::ParameterBase

Public Types

using default_type = T
 
using value_type = T
 

Public Member Functions

 Atom (Name &&name)
 
 Atom (Name &&name, Comment &&comment)
 
 Atom (Name &&name, Comment &&comment, std::function< bool()> useIf)
 
 Atom (Name &&name, T const &dflt_value)
 
 Atom (Name &&name, Comment &&comment, T const &dflt_value)
 
 Atom (Name &&name, Comment &&comment, std::function< bool()> useIf, T const &dflt_value)
 
auto const & operator() () const
 
std::string stringified_value () const
 
std::string key () const
 
std::string name () const
 
std::string comment () const
 
bool has_default () const
 
bool is_optional () const
 
bool is_conditional () const
 
par_type parameter_type () const
 
bool should_use () const
 
void set_value (fhicl::ParameterSet const &ps, bool trimParents)
 
void set_par_style (par_style const vt)
 
void set_key (std::string const &key)
 

Private Member Functions

std::string get_stringified_value () const override
 
void do_set_value (fhicl::ParameterSet const &, bool const) override
 

Private Attributes

std::shared_ptr< Tvalue_
 

Detailed Description

template<typename T>
class fhicl::Atom< T >

Definition at line 25 of file type_traits.h.

Member Typedef Documentation

template<typename T>
using fhicl::Atom< T >::default_type = T

Definition at line 56 of file Atom.h.

template<typename T>
using fhicl::Atom< T >::value_type = T

Definition at line 57 of file Atom.h.

Constructor & Destructor Documentation

template<typename T>
fhicl::Atom< T >::Atom ( Name &&  name)
explicit
template<typename T>
fhicl::Atom< T >::Atom ( Name &&  name,
Comment &&  comment 
)
explicit
template<typename T>
fhicl::Atom< T >::Atom ( Name &&  name,
Comment &&  comment,
std::function< bool()>  useIf 
)
explicit
template<typename T>
fhicl::Atom< T >::Atom ( Name &&  name,
T const &  dflt_value 
)
explicit
template<typename T>
fhicl::Atom< T >::Atom ( Name &&  name,
Comment &&  comment,
T const &  dflt_value 
)
explicit
template<typename T>
fhicl::Atom< T >::Atom ( Name &&  name,
Comment &&  comment,
std::function< bool()>  useIf,
T const &  dflt_value 
)
explicit

Member Function Documentation

std::string fhicl::detail::ParameterBase::comment ( ) const
inlineinherited
template<typename T>
void fhicl::Atom< T >::do_set_value ( fhicl::ParameterSet const &  ,
bool  const 
)
overrideprivatevirtual
template<typename T>
std::string fhicl::Atom< T >::get_stringified_value ( ) const
overrideprivatevirtual
bool fhicl::detail::ParameterBase::has_default ( ) const
inlineinherited
bool fhicl::detail::ParameterBase::is_conditional ( ) const
inlineinherited
bool fhicl::detail::ParameterBase::is_optional ( ) const
inlineinherited
std::string fhicl::detail::ParameterBase::key ( ) const
inlineinherited
std::string fhicl::detail::ParameterBase::name ( ) const
inlineinherited
template<typename T>
auto const& fhicl::Atom< T >::operator() ( void  ) const
inline

Definition at line 50 of file Atom.h.

51  {
52  return *value_;
53  }
std::shared_ptr< T > value_
Definition: Atom.h:60
par_type fhicl::detail::ParameterBase::parameter_type ( ) const
inlineinherited
void fhicl::detail::ParameterBase::set_key ( std::string const &  key)
inlineinherited
void fhicl::detail::ParameterBase::set_par_style ( par_style const  vt)
inlineinherited
void fhicl::detail::ParameterBase::set_value ( fhicl::ParameterSet const &  ps,
bool  trimParents 
)
inlineinherited

Definition at line 96 of file ParameterBase.h.

References fhicl::detail::ParameterBase::do_set_value().

97  {
98  do_set_value(ps, trimParents);
99  }
virtual void do_set_value(fhicl::ParameterSet const &, bool trimParents)=0
bool fhicl::detail::ParameterBase::should_use ( ) const
inlineinherited

Definition at line 79 of file ParameterBase.h.

References fhicl::detail::ParameterBase::maybeUse_.

80  {
81  return maybeUse_();
82  }
std::function< bool()> maybeUse_
std::string fhicl::detail::AtomBase::stringified_value ( ) const
inlineinherited

Definition at line 24 of file AtomBase.h.

References fhicl::detail::AtomBase::get_stringified_value().

25  {
26  return get_stringified_value();
27  }
virtual std::string get_stringified_value() const =0

Member Data Documentation

template<typename T>
std::shared_ptr<T> fhicl::Atom< T >::value_
private

Definition at line 60 of file Atom.h.

Referenced by fhicl::Atom< std::int64_t >::operator()().


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