#include "type_traits.h"

Inheritance diagram for fhicl::OptionalAtom< T >:

Public Types
using	value_type = T

Public Member Functions
	OptionalAtom (Name &&name)

	OptionalAtom (Name &&name, Comment &&comment)

	OptionalAtom (Name &&name, Comment &&comment, std::function< bool()> maybeUse)

bool	operator() (T &value) const

bool	hasValue () const

	OptionalAtom ()

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
T	value_ {}

bool	has_value_ {false}

Detailed Description

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

Definition at line 27 of file type_traits.h.

Member Typedef Documentation

template<typename T>

using fhicl::OptionalAtom< T >::value_type = T

Definition at line 59 of file OptionalAtom.h.

Constructor & Destructor Documentation

template<typename T>

fhicl::OptionalAtom< T >::OptionalAtom ( Name && name )

explicit

template<typename T>

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

explicit

template<typename T>

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

explicit

template<typename T>

fhicl::OptionalAtom< T >::OptionalAtom ( )

Member Function Documentation

std::string fhicl::detail::ParameterBase::comment ( ) const

inlineinherited

Definition at line 54 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::comment(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::Tuple().

       {
         return mdata_.comment();
       }

template<typename T>

void fhicl::OptionalAtom< T >::do_set_value	(	fhicl::ParameterSet const &	,
		bool	const
	)

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

template<typename T>

std::string fhicl::OptionalAtom< T >::get_stringified_value ( ) const

overrideprivatevirtual

Implements fhicl::detail::AtomBase.

bool fhicl::detail::ParameterBase::has_default ( ) const

inlineinherited

Definition at line 59 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::has_default(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), and fhicl::detail::PrintAllowedConfiguration::enter_sequence().

       {
         return mdata_.has_default();
       }

template<typename T>

bool fhicl::OptionalAtom< T >::hasValue ( ) const

inline

Definition at line 53 of file OptionalAtom.h.

     {
       return has_value_;
     }

bool fhicl::detail::ParameterBase::is_conditional ( ) const

inlineinherited

Definition at line 69 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::is_conditional(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), and fhicl::detail::PrintAllowedConfiguration::before_action().

       {
         return mdata_.is_conditional();
       }

bool fhicl::detail::ParameterBase::is_optional ( ) const

inlineinherited

Definition at line 64 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::is_optional(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::before_action(), and evgen::MARLEYHelper::fhicl_parameter_to_json().

       {
         return mdata_.is_optional();
       }

std::string fhicl::detail::ParameterBase::key ( ) const

inlineinherited

Definition at line 44 of file ParameterBase.h.

References fhicl::detail::ParameterMetadata::key(), and fhicl::detail::ParameterBase::mdata_.

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::ValidateThenSet::before_action(), fhicl::detail::PrintAllowedConfiguration::before_action(), fhicl::detail::SearchAllowedConfiguration::before_action(), fhicl::detail::PrintAllowedConfiguration::cacheTopLevelParameter(), detinfo::LArPropertiesStandard::Configure(), fhicl::OptionalSequence< Table< T >< art::RootInputFileSequence::Config::SecondaryFile > >::do_prepare_elements_for_validation(), fhicl::OptionalTuple< ARGS... >::do_prepare_elements_for_validation(), fhicl::OptionalSequence< T,-1ull >::do_prepare_elements_for_validation(), fhicl::detail::ValidateThenSet::enter_sequence(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), fhicl::DelegatedParameter::get(), fhicl::OptionalDelegatedParameter::get_if_present(), fhicl::OptionalDelegatedParameter::hasValue(), fhicl::detail::MaybeDisplayParent::is_sequence_element(), fhicl::detail::PrintAllowedConfiguration::maybeReleaseTopLevelParameter(), fhicl::detail::RegisterIfTableMember::RegisterIfTableMember(), and fhicl::detail::PrintAllowedConfiguration::suppressFormat().

       {
         return mdata_.key();
       }

std::string fhicl::detail::ParameterBase::name ( ) const

inlineinherited

Definition at line 49 of file ParameterBase.h.

References fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::name().

Referenced by fhicl::detail::AtomBase::AtomBase(), fhicl::detail::DelegateBase::DelegateBase(), fhicl::detail::ValidateThenSet::delegated_parameter(), fhicl::DelegatedParameter::DelegatedParameter(), fhicl::OptionalDelegatedParameter::OptionalDelegatedParameter(), fhicl::OptionalTuple< TYPES >::OptionalTuple(), fhicl::detail::ParameterBase::ParameterBase(), fhicl::detail::SequenceBase::SequenceBase(), fhicl::detail::TableBase::TableBase(), and fhicl::Tuple< TYPES >::Tuple().

       {
         return mdata_.name();
       }

template<typename T>

bool fhicl::OptionalAtom< T >::operator() ( T & value ) const

inline

Definition at line 43 of file OptionalAtom.h.

     {
       if (has_value_) {
         value = value_;
         return true;
       }
       return false;
     }

par_type fhicl::detail::ParameterBase::parameter_type ( ) const

inlineinherited

Definition at line 74 of file ParameterBase.h.

References fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::type().

Referenced by fhicl::detail::PrintAllowedConfiguration::after_action(), fhicl::detail::PrintAllowedConfiguration::enter_sequence(), evgen::MARLEYHelper::fhicl_parameter_to_json(), fhicl::detail::SearchAllowedConfiguration::form_absolute(), and fhicl::detail::RegisterIfTableMember::RegisterIfTableMember().

       {
         return mdata_.type();
       }

void fhicl::detail::ParameterBase::set_key ( std::string const & key )

inlineinherited

Definition at line 106 of file ParameterBase.h.

References fhicl::detail::ParameterBase::do_set_value(), fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::set_key().

       {
         mdata_.set_key(key);
       }

void fhicl::detail::ParameterBase::set_par_style ( par_style const vt )

inlineinherited

Definition at line 101 of file ParameterBase.h.

References fhicl::detail::ParameterBase::mdata_, and fhicl::detail::ParameterMetadata::set_par_style().

Referenced by art::RootOutput::Config::Config().

       {
         mdata_.set_par_style(vt);
       }

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().

Referenced by fhicl::detail::ValidateThenSet::after_action().

       {
         do_set_value(ps, trimParents);
       }

bool fhicl::detail::ParameterBase::should_use ( ) const

inlineinherited

Definition at line 79 of file ParameterBase.h.

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

Referenced by fhicl::detail::ValidateThenSet::before_action(), and evgen::MARLEYHelper::fhicl_parameter_to_json().

       {
         return 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().

Referenced by fhicl::detail::PrintAllowedConfiguration::atom().

       {
         return get_stringified_value();
       }

Member Data Documentation

template<typename T>

bool fhicl::OptionalAtom< T >::has_value_ {false}

private

Definition at line 65 of file OptionalAtom.h.

Referenced by fhicl::OptionalAtom< RunNumber_t >::hasValue(), and fhicl::OptionalAtom< RunNumber_t >::operator()().

template<typename T>

T fhicl::OptionalAtom< T >::value_ {}

private

Definition at line 64 of file OptionalAtom.h.

Referenced by fhicl::OptionalAtom< RunNumber_t >::operator()().

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

fhiclcpp/type_traits.h
fhiclcpp/types/OptionalAtom.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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