Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
protocols::frag_picker::quota::QuotaConfig Class Reference

read a config file for quota selector More...

#include <QuotaConfig.hh>

Inheritance diagram for protocols::frag_picker::quota::QuotaConfig:
Inheritance graph
[legend]

Public Member Functions

 QuotaConfig (std::string config_file_name)
 Constructor reads a config file. More...
 
 QuotaConfig ()
 Constructor used by derived classes. More...
 
core::Size count_pools ()
 how many pools have been defined in a config file More...
 
core::Real get_fraction (core::Size pool_id)
 returns a fraction for a given pool More...
 
void set_fraction (core::Size pool_id, core::Real fraction)
 returns a fraction for a given pool More...
 
core::Real get_fraction (std::string pool_name)
 returns a fraction for a given pool More...
 
bool is_valid_quota_pool_name (std::string &pool_name)
 returns true if a config file defined a given pool name More...
 
std::string & get_pool_name (core::Size pool_id)
 return a string id (name) assigned to a given pool More...
 

Protected Attributes

utility::vector1< core::Realpool_weights_
 
utility::vector1< std::string > pool_names_
 

Detailed Description

read a config file for quota selector

Constructor & Destructor Documentation

protocols::frag_picker::quota::QuotaConfig::QuotaConfig ( std::string  config_file_name)

Constructor reads a config file.

References protocols::frag_picker::quota::trQuotaConfig().

protocols::frag_picker::quota::QuotaConfig::QuotaConfig ( )
inline

Constructor used by derived classes.

Member Function Documentation

core::Size protocols::frag_picker::quota::QuotaConfig::count_pools ( )
inline

how many pools have been defined in a config file

References pool_names_.

core::Real protocols::frag_picker::quota::QuotaConfig::get_fraction ( core::Size  pool_id)
inline

returns a fraction for a given pool

References pool_weights_.

Referenced by protocols::frag_picker::FragmentPicker::set_up_quota_nnmake_style().

core::Real protocols::frag_picker::quota::QuotaConfig::get_fraction ( std::string  pool_name)
inline

returns a fraction for a given pool

if the given string is not a valid name of a quota pool, the method returns 0

References pool_names_, and pool_weights_.

std::string& protocols::frag_picker::quota::QuotaConfig::get_pool_name ( core::Size  pool_id)
inline

return a string id (name) assigned to a given pool

References pool_names_.

Referenced by protocols::frag_picker::FragmentPicker::set_up_ss_abego_quota().

bool protocols::frag_picker::quota::QuotaConfig::is_valid_quota_pool_name ( std::string &  pool_name)
inline

returns true if a config file defined a given pool name

References pool_names_.

Referenced by protocols::frag_picker::FragmentPicker::set_up_quota_nnmake_style().

void protocols::frag_picker::quota::QuotaConfig::set_fraction ( core::Size  pool_id,
core::Real  fraction 
)
inline

returns a fraction for a given pool

References pool_weights_.

Member Data Documentation

utility::vector1<std::string> protocols::frag_picker::quota::QuotaConfig::pool_names_
protected
utility::vector1<core::Real> protocols::frag_picker::quota::QuotaConfig::pool_weights_
protected

Referenced by get_fraction(), and set_fraction().


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