Empirical
Public Member Functions | Protected Attributes | List of all members
emp::Config::tConfigEntry< VAR_TYPE > Class Template Reference

Type-specific versions of ConfigEntry class to manage settings. More...

#include <config.h>

Inheritance diagram for emp::Config::tConfigEntry< VAR_TYPE >:
emp::ConfigEntry

Public Member Functions

 tConfigEntry (const std::string _name, const std::string _type, const std::string _d_val, const std::string _desc, VAR_TYPE &_ref)
 
 ~tConfigEntry ()
 
std::string GetValue () const
 Retrieve the value of this setting as a string. More...
 
std::string GetLiteralValue () const
 Conver the value of this setting into a literal that C++ would recognize as its current value. More...
 
ConfigEntrySetValue (const std::string &in_val, std::stringstream &)
 Use a string to set the value of this setting. More...
 
bool IsConst () const
 Identify if this setting is fixed at compile time. More...
 
const std::string & GetName () const
 
const std::string & GetType () const
 
const std::string & GetDefault () const
 
const std::string & GetDescription () const
 
ConfigEntrySetName (const std::string &_in)
 
ConfigEntrySetType (const std::string &_in)
 
ConfigEntrySetDefault (const std::string &_in)
 
ConfigEntrySetDescription (const std::string &_in)
 
ConfigEntryAddAlias (const std::string &_in)
 Alert this setting that it is aliased to alternate possible names. More...
 
bool HasAlias (const std::string &_in)
 Are there any alternate names for this setting? More...
 
bool IsMatch (const std::string &_in)
 Will the provided name match this setting? More...
 
const std::unordered_set< std::string > & GetAliases ()
 Retrieve the full set of aliases. More...
 

Protected Attributes

VAR_TYPE & entry_ref
 
std::string name
 
std::string type
 
std::string default_val
 
std::string desc
 
std::unordered_set< std::string > alias_set
 

Detailed Description

template<class VAR_TYPE>
class emp::Config::tConfigEntry< VAR_TYPE >

Type-specific versions of ConfigEntry class to manage settings.

Constructor & Destructor Documentation

template<class VAR_TYPE >
emp::Config::tConfigEntry< VAR_TYPE >::tConfigEntry ( const std::string  _name,
const std::string  _type,
const std::string  _d_val,
const std::string  _desc,
VAR_TYPE &  _ref 
)
inline
template<class VAR_TYPE >
emp::Config::tConfigEntry< VAR_TYPE >::~tConfigEntry ( )
inline

Member Function Documentation

ConfigEntry& emp::ConfigEntry::AddAlias ( const std::string &  _in)
inlineinherited

Alert this setting that it is aliased to alternate possible names.

const std::unordered_set<std::string>& emp::ConfigEntry::GetAliases ( )
inlineinherited

Retrieve the full set of aliases.

const std::string& emp::ConfigEntry::GetDefault ( ) const
inlineinherited
const std::string& emp::ConfigEntry::GetDescription ( ) const
inlineinherited
template<class VAR_TYPE >
std::string emp::Config::tConfigEntry< VAR_TYPE >::GetLiteralValue ( ) const
inlinevirtual

Conver the value of this setting into a literal that C++ would recognize as its current value.

Implements emp::ConfigEntry.

const std::string& emp::ConfigEntry::GetName ( ) const
inlineinherited
const std::string& emp::ConfigEntry::GetType ( ) const
inlineinherited
template<class VAR_TYPE >
std::string emp::Config::tConfigEntry< VAR_TYPE >::GetValue ( ) const
inlinevirtual

Retrieve the value of this setting as a string.

Implements emp::ConfigEntry.

bool emp::ConfigEntry::HasAlias ( const std::string &  _in)
inlineinherited

Are there any alternate names for this setting?

template<class VAR_TYPE >
bool emp::Config::tConfigEntry< VAR_TYPE >::IsConst ( ) const
inlinevirtual

Identify if this setting is fixed at compile time.

Implements emp::ConfigEntry.

bool emp::ConfigEntry::IsMatch ( const std::string &  _in)
inlineinherited

Will the provided name match this setting?

ConfigEntry& emp::ConfigEntry::SetDefault ( const std::string &  _in)
inlineinherited
ConfigEntry& emp::ConfigEntry::SetDescription ( const std::string &  _in)
inlineinherited
ConfigEntry& emp::ConfigEntry::SetName ( const std::string &  _in)
inlineinherited
ConfigEntry& emp::ConfigEntry::SetType ( const std::string &  _in)
inlineinherited
template<class VAR_TYPE >
ConfigEntry& emp::Config::tConfigEntry< VAR_TYPE >::SetValue ( const std::string &  in_val,
std::stringstream &  warnings 
)
inlinevirtual

Use a string to set the value of this setting.

Implements emp::ConfigEntry.

Member Data Documentation

std::unordered_set<std::string> emp::ConfigEntry::alias_set
protectedinherited
std::string emp::ConfigEntry::default_val
protectedinherited
std::string emp::ConfigEntry::desc
protectedinherited
template<class VAR_TYPE >
VAR_TYPE& emp::Config::tConfigEntry< VAR_TYPE >::entry_ref
protected
std::string emp::ConfigEntry::name
protectedinherited
std::string emp::ConfigEntry::type
protectedinherited

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