#include "type_traits.h"

Inheritance diagram for fhicl::OptionalTable< T >:

Public Types
using	value_type = T

Public Member Functions
	OptionalTable (Name &&name)

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

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

	OptionalTable (ParameterSet const &pset, std::set< std::string > const &keysToIgnore)

bool	operator() (T &value) const

bool	hasValue () const

ParameterSet const &	get_PSet () const

void	validate_ParameterSet (ParameterSet const &pset, std::set< std::string > const &keysToIgnore={})

void	print_allowed_configuration (std::ostream &os, std::string const &tab=std::string(3, ' ')) const

	OptionalTable ()

std::vector< cet::exempt_ptr< ParameterBase > > const &	members () 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 Types
using	members_t = std::vector< cet::exempt_ptr< ParameterBase >>

Private Member Functions
members_t const &	get_members () const override

void	do_set_value (fhicl::ParameterSet const &pset, bool const trimParents) override

Private Attributes
std::shared_ptr< T >	value_ {std::make_shared<T>()}

bool	has_value_ {false}

ParameterSet	pset_ {}

members_t	members_

Detailed Description

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

Definition at line 32 of file type_traits.h.

Member Typedef Documentation

template<typename T>

using fhicl::OptionalTable< T >::members_t = std::vector<cet::exempt_ptr<ParameterBase>>

private

Definition at line 81 of file OptionalTable.h.

template<typename T>

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

Definition at line 76 of file OptionalTable.h.

Constructor & Destructor Documentation

template<typename T>

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

explicit

template<typename T>

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

explicit

template<typename T>

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

explicit

template<typename T>

fhicl::OptionalTable< T >::OptionalTable	(	ParameterSet const &	pset,
		std::set< std::string > const &	keysToIgnore
	)

template<typename T>

fhicl::OptionalTable< T >::OptionalTable ( )

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::OptionalTable< T >::do_set_value	(	fhicl::ParameterSet const &	pset,
		bool const	trimParents
	)

overrideprivatevirtual

Implements fhicl::detail::ParameterBase.

Referenced by fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::get_members().

template<typename T>

members_t const& fhicl::OptionalTable< T >::get_members ( ) const

inlineoverrideprivatevirtual

Implements fhicl::detail::TableBase.

Definition at line 90 of file OptionalTable.h.

     {
       return members_;
     }

template<typename T>

ParameterSet const& fhicl::OptionalTable< T >::get_PSet ( ) const

inline

Definition at line 62 of file OptionalTable.h.

     {
       return pset_;
     }

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::OptionalTable< T >::hasValue ( ) const

inline

Definition at line 56 of file OptionalTable.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::vector<cet::exempt_ptr<ParameterBase> > const& fhicl::detail::TableBase::members ( ) const

inlineinherited

Definition at line 24 of file TableBase.h.

References fhicl::detail::TableBase::get_members().

       {
         return get_members();
       }

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::OptionalTable< T >::operator() ( T & value ) const

inline

Definition at line 46 of file OptionalTable.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();
       }

template<typename T>

void fhicl::OptionalTable< T >::print_allowed_configuration	(	std::ostream &	os,
		std::string const &	tab = `std::string(3, ' ')`
	)		const

Referenced by fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::get_PSet().

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_();
       }

template<typename T>

void fhicl::OptionalTable< T >::validate_ParameterSet	(	ParameterSet const &	pset,
		std::set< std::string > const &	keysToIgnore = `{}`
	)

Referenced by fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::get_PSet().

Member Data Documentation

template<typename T>

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

private

Definition at line 84 of file OptionalTable.h.

Referenced by fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::hasValue(), and fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::operator()().

template<typename T>

members_t fhicl::OptionalTable< T >::members_

private

Initial value:

{

detail::TableMemberRegistry::instance().release_members()}

Definition at line 86 of file OptionalTable.h.

Referenced by fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::get_members().

template<typename T>

ParameterSet fhicl::OptionalTable< T >::pset_ {}

private

Definition at line 85 of file OptionalTable.h.

Referenced by fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::get_PSet().

template<typename T>

std::shared_ptr<T> fhicl::OptionalTable< T >::value_ {std::make_shared<T>()}

private

Definition at line 83 of file OptionalTable.h.

Referenced by fhicl::OptionalTable< art::ClosingCriteria::art::TFileService::Config >::operator()().

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

fhiclcpp/type_traits.h
fhiclcpp/types/OptionalTable.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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