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

#include <AtomBase.h>

Inheritance diagram for fhicl::detail::AtomBase:
fhicl::detail::ParameterBase fhicl::Atom< art::InputTag > fhicl::Atom< art::ScheduleID::size_type > fhicl::Atom< bool > fhicl::Atom< double > fhicl::Atom< float > fhicl::Atom< geo::fhicl::Table::CryostatID_t > fhicl::Atom< geo::fhicl::Table::OpDetID_t > fhicl::Atom< geo::fhicl::Table::PlaneID_t > fhicl::Atom< geo::fhicl::Table::TPCID_t > fhicl::Atom< geo::fhicl::Table::WireID_t > fhicl::Atom< int > fhicl::Atom< int64_t > fhicl::Atom< Path_t::Depth_t > fhicl::Atom< Pedestal_t > fhicl::Atom< raw::ADC_Count_t > fhicl::Atom< raw::ChannelID_t > fhicl::Atom< readout::readout::ROPID::ROPID_t > fhicl::Atom< readout::TPCsetID::TPCsetID_t > fhicl::Atom< seed_t > fhicl::Atom< short > fhicl::Atom< size_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< art::InputTag > fhicl::OptionalAtom< bool > fhicl::OptionalAtom< double > fhicl::OptionalAtom< EventNumber_t > fhicl::OptionalAtom< int > fhicl::OptionalAtom< rndm::NuRandomService::seed_t > fhicl::OptionalAtom< RunNumber_t > fhicl::OptionalAtom< short > fhicl::OptionalAtom< size_t > fhicl::OptionalAtom< std::string > fhicl::OptionalAtom< SubRunNumber_t > fhicl::OptionalAtom< unsigned int >

Public Member Functions

 AtomBase (Name const &name, Comment const &comment, par_style const vt, std::function< bool()> maybeUse)
 
std::string stringified_value () const
 
- Public Member Functions inherited from fhicl::detail::ParameterBase
std::string const & key () const
 
std::string const & name () const
 
std::string const & comment () const
 
bool has_default () const
 
bool is_optional () const
 
bool is_conditional () const
 
par_type parameter_type () const
 
bool should_use () const
 
 ParameterBase (Name const &name, Comment const &comment, par_style const vt, par_type const type, std::function< bool()> maybeUse=AlwaysUse())
 
virtual ~ParameterBase ()=default
 
void set_value (fhicl::ParameterSet const &ps)
 
bool preset_value (fhicl::ParameterSet const &ps)
 
void set_par_style (par_style const vt)
 

Private Member Functions

virtual std::string get_stringified_value () const =0
 

Detailed Description

Definition at line 8 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 10 of file AtomBase.h.

14  : ParameterBase{name, comment, vt, par_type::ATOM, maybeUse}
15  {}
fhicl::detail::ParameterBase::name
std::string const & name() const
Definition: ParameterBase.h:43
fhicl::detail::ParameterBase::ParameterBase
ParameterBase(Name const &name, Comment const &comment, par_style const vt, par_type const type, std::function< bool()> maybeUse=AlwaysUse())
Definition: ParameterBase.h:78
fhicl::detail::ParameterBase::comment
std::string const & comment() const
Definition: ParameterBase.h:48

Member Function Documentation

virtual std::string fhicl::detail::AtomBase::get_stringified_value ( ) const
privatepure virtual

Implemented in fhicl::OptionalAtom< T >, fhicl::OptionalAtom< double >, fhicl::OptionalAtom< std::string >, fhicl::OptionalAtom< EventNumber_t >, fhicl::OptionalAtom< int >, fhicl::OptionalAtom< art::InputTag >, fhicl::OptionalAtom< unsigned int >, fhicl::OptionalAtom< rndm::NuRandomService::seed_t >, fhicl::OptionalAtom< short >, fhicl::OptionalAtom< size_t >, fhicl::OptionalAtom< bool >, fhicl::OptionalAtom< SubRunNumber_t >, fhicl::OptionalAtom< RunNumber_t >, fhicl::Atom< T >, fhicl::Atom< Path_t::Depth_t >, fhicl::Atom< int64_t >, fhicl::Atom< uint32_t >, fhicl::Atom< double >, fhicl::Atom< geo::fhicl::Table::PlaneID_t >, fhicl::Atom< unsigned long long >, fhicl::Atom< std::string >, fhicl::Atom< float >, fhicl::Atom< raw::ADC_Count_t >, fhicl::Atom< int >, fhicl::Atom< geo::fhicl::Table::TPCID_t >, fhicl::Atom< art::InputTag >, fhicl::Atom< unsigned int >, fhicl::Atom< geo::fhicl::Table::CryostatID_t >, fhicl::Atom< geo::fhicl::Table::WireID_t >, fhicl::Atom< geo::fhicl::Table::OpDetID_t >, fhicl::Atom< seed_t >, fhicl::Atom< string >, fhicl::Atom< short >, fhicl::Atom< size_t >, fhicl::Atom< Pedestal_t >, fhicl::Atom< unsigned >, fhicl::Atom< art::ScheduleID::size_type >, fhicl::Atom< bool >, fhicl::Atom< readout::TPCsetID::TPCsetID_t >, fhicl::Atom< readout::readout::ROPID::ROPID_t >, and fhicl::Atom< raw::ChannelID_t >.

std::string fhicl::detail::AtomBase::stringified_value ( ) const
inline

Definition at line 18 of file AtomBase.h.

19  {
20  return get_stringified_value();
21  }
fhicl::detail::AtomBase::get_stringified_value
virtual std::string get_stringified_value() const =0
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11