fhicl::detail::ParameterMetadata Class Reference

#include "ParameterMetadata.h"

Public Member Functions
	ParameterMetadata ()=default
	ParameterMetadata (Name const &name=Name(), Comment const &comment=Comment(""), par_style const parStyle=par_style::NTYPES, par_type const parType=par_type::NTYPES)
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	type () const
void	set_par_style (par_style const vt)

Private Attributes
std::string	key_ {}
std::string	name_ {}
std::string	comment_ {}
par_style	parStyle_ {par_style::NTYPES}
par_type	parType_ {par_type::NTYPES}

Detailed Description

Definition at line 16 of file ParameterMetadata.h.

Constructor & Destructor Documentation

fhicl::detail::ParameterMetadata::ParameterMetadata ( )

default

fhicl::detail::ParameterMetadata::ParameterMetadata ( Name const &  name = Name(), Comment const &  comment = Comment(""), par_style const  parStyle = par_style::NTYPES, par_type const  parType = par_type::NTYPES  )

inline

Definition at line 20 of file ParameterMetadata.h.

References comment(), comment_, fhicl::NameStackRegistry::full_key(), name(), name_, parStyle_, and parType_.

      : key_{NameStackRegistry::full_key(name.value)}
      , name_{name.value}
      , comment_{comment.value}
      , parStyle_{parStyle}
      , parType_{parType}
    {}

Member Function Documentation

std::string const& fhicl::detail::ParameterMetadata::comment ( ) const

inline

Definition at line 42 of file ParameterMetadata.h.

References comment_.

Referenced by fhicl::detail::ParameterBase::comment(), and ParameterMetadata().

    {
      return comment_;
    }

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

inline

Definition at line 48 of file ParameterMetadata.h.

References fhicl::DEFAULT, fhicl::DEFAULT_CONDITIONAL, and parStyle_.

Referenced by fhicl::detail::ParameterBase::has_default().

    {
      return parStyle_ == par_style::DEFAULT ||
             parStyle_ == par_style::DEFAULT_CONDITIONAL;
    }

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

inline

Definition at line 62 of file ParameterMetadata.h.

References fhicl::DEFAULT_CONDITIONAL, fhicl::OPTIONAL_CONDITIONAL, parStyle_, and fhicl::REQUIRED_CONDITIONAL.

Referenced by fhicl::detail::ParameterBase::is_conditional().

    {
      return parStyle_ == par_style::REQUIRED_CONDITIONAL ||
             parStyle_ == par_style::OPTIONAL_CONDITIONAL ||
             parStyle_ == par_style::DEFAULT_CONDITIONAL;
    }

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

inline

Definition at line 55 of file ParameterMetadata.h.

References fhicl::OPTIONAL, fhicl::OPTIONAL_CONDITIONAL, and parStyle_.

Referenced by fhicl::detail::ParameterBase::is_optional().

    {
      return parStyle_ == par_style::OPTIONAL ||
             parStyle_ == par_style::OPTIONAL_CONDITIONAL;
    }

std::string const& fhicl::detail::ParameterMetadata::key ( ) const

inline

Definition at line 32 of file ParameterMetadata.h.

References key_.

Referenced by fhicl::detail::ParameterBase::key().

    {
      return key_;
    }

std::string const& fhicl::detail::ParameterMetadata::name ( ) const

inline

Definition at line 37 of file ParameterMetadata.h.

References name_.

Referenced by fhicl::detail::ParameterBase::name(), and ParameterMetadata().

    {
      return name_;
    }

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

inline

Definition at line 76 of file ParameterMetadata.h.

References parStyle_.

Referenced by fhicl::detail::ParameterBase::set_par_style().

    {
      parStyle_ = vt;
    }

par_type fhicl::detail::ParameterMetadata::type ( ) const

inline

Definition at line 70 of file ParameterMetadata.h.

References parType_.

Referenced by fhicl::detail::ParameterBase::parameter_type().

    {
      return parType_;
    }

Member Data Documentation

std::string fhicl::detail::ParameterMetadata::comment_ {}

private

Definition at line 84 of file ParameterMetadata.h.

Referenced by comment(), and ParameterMetadata().

std::string fhicl::detail::ParameterMetadata::key_ {}

private

Definition at line 82 of file ParameterMetadata.h.

Referenced by key().

std::string fhicl::detail::ParameterMetadata::name_ {}

private

Definition at line 83 of file ParameterMetadata.h.

Referenced by name(), and ParameterMetadata().

par_style fhicl::detail::ParameterMetadata::parStyle_ {par_style::NTYPES}

private

Definition at line 85 of file ParameterMetadata.h.

Referenced by has_default(), is_conditional(), is_optional(), ParameterMetadata(), and set_par_style().

par_type fhicl::detail::ParameterMetadata::parType_ {par_type::NTYPES}

private

Definition at line 86 of file ParameterMetadata.h.

Referenced by ParameterMetadata(), and type().

---

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

• fhiclcpp/types/detail/ParameterMetadata.h