Public Member Functions | Private Member Functions | List of all members
fhicl::detail::AtomBase Class Referenceabstract

#include "/cvmfs/nova.opensciencegrid.org/externals/fhiclcpp/v4_06_10/source/fhiclcpp/types/detail/AtomBase.h"

Inheritance diagram for fhicl::detail::AtomBase:
fhicl::detail::ParameterBase fhicl::Atom< art::InputTag > fhicl::Atom< bool > fhicl::Atom< double > fhicl::Atom< EventNumber_t > fhicl::Atom< float > fhicl::Atom< int > fhicl::Atom< int64_t > fhicl::Atom< size_t > fhicl::Atom< std::int64_t > fhicl::Atom< std::string > fhicl::Atom< string > fhicl::Atom< uint32_t > fhicl::Atom< unsigned > fhicl::Atom< unsigned int > fhicl::Atom< unsigned long long > fhicl::Atom< T > fhicl::OptionalAtom< T > fhicl::OptionalAtom< bool > fhicl::OptionalAtom< EventNumber_t > fhicl::OptionalAtom< RunNumber_t > fhicl::OptionalAtom< std::string > fhicl::OptionalAtom< SubRunNumber_t >

Public Member Functions

 AtomBase (Name const &name, Comment const &comment, par_style const vt, std::function< bool()> maybeUse)
 
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

virtual std::string get_stringified_value () const =0
 

Detailed Description

Definition at line 14 of file AtomBase.h.

Constructor & Destructor Documentation

fhicl::detail::AtomBase::AtomBase ( Name const &  name,
Comment const &  comment,
par_style const  vt,
std::function< bool()>  maybeUse 
)
inline

Definition at line 16 of file AtomBase.h.

References fhicl::ATOM, fhicl::detail::ParameterBase::comment(), fhicl::detail::ParameterBase::name(), and string.

20  : ParameterBase{name, comment, vt, par_type::ATOM, maybeUse}
21  {}
ParameterBase(Name const &name, Comment const &comment, par_style const vt, par_type const type, std::function< bool()> maybeUse=AlwaysUse())
Definition: ParameterBase.h:84
std::string name() const
Definition: ParameterBase.h:49
std::string comment() const
Definition: ParameterBase.h:54

Member Function Documentation

std::string fhicl::detail::ParameterBase::comment ( ) const
inlineinherited
virtual std::string fhicl::detail::AtomBase::get_stringified_value ( ) const
privatepure virtual
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
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
inline

Definition at line 24 of file AtomBase.h.

References get_stringified_value(), and string.

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

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