Public Member Functions | Private Attributes | List of all members
fhicl::detail::ParameterMetadata Class Reference

#include "/cvmfs/nova.opensciencegrid.org/externals/fhiclcpp/v4_06_10/source/fhiclcpp/types/detail/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 key () const
 
std::string name () const
 
std::string comment () const
 
bool has_default () const
 
bool is_optional () const
 
bool is_conditional () const
 
par_type type () const
 
void set_key (std::string const &key)
 
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 17 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 21 of file ParameterMetadata.h.

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

26  , name_{name.value}
27  , comment_{comment.value}
28  , parStyle_{parStyle}
29  , parType_{parType}
30  {}
const XML_Char * name
Definition: expat.h:151
static NameStackRegistry & instance()
std::string full_key(std::string const &key)

Member Function Documentation

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

Definition at line 43 of file ParameterMetadata.h.

References comment_.

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

44  {
45  return comment_;
46  }
bool fhicl::detail::ParameterMetadata::has_default ( ) const
inline
bool fhicl::detail::ParameterMetadata::is_conditional ( ) const
inline
bool fhicl::detail::ParameterMetadata::is_optional ( ) const
inline
std::string fhicl::detail::ParameterMetadata::key ( ) const
inline

Definition at line 33 of file ParameterMetadata.h.

References key_, and string.

Referenced by fhicl::detail::ParameterBase::key(), and set_key().

34  {
35  return key_;
36  }
std::string fhicl::detail::ParameterMetadata::name ( ) const
inline
void fhicl::detail::ParameterMetadata::set_key ( std::string const &  key)
inline

Definition at line 77 of file ParameterMetadata.h.

References key(), key_, name_, and fhicl::detail::strip_all_containing_names().

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

78  {
79  key_ = key;
81  }
std::string strip_all_containing_names(std::string const &key)
void fhicl::detail::ParameterMetadata::set_par_style ( par_style const  vt)
inline

Definition at line 84 of file ParameterMetadata.h.

References parStyle_.

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

85  {
86  parStyle_ = vt;
87  }
par_type fhicl::detail::ParameterMetadata::type ( ) const
inline

Definition at line 71 of file ParameterMetadata.h.

References parType_.

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

72  {
73  return parType_;
74  }

Member Data Documentation

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

Definition at line 92 of file ParameterMetadata.h.

Referenced by comment(), and ParameterMetadata().

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

Definition at line 90 of file ParameterMetadata.h.

Referenced by key(), and set_key().

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

Definition at line 91 of file ParameterMetadata.h.

Referenced by name(), ParameterMetadata(), and set_key().

par_style fhicl::detail::ParameterMetadata::parStyle_ {par_style::NTYPES}
private
par_type fhicl::detail::ParameterMetadata::parType_ {par_type::NTYPES}
private

Definition at line 94 of file ParameterMetadata.h.

Referenced by ParameterMetadata(), and type().


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