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

A base class for collecting fragments. More...

#include <QuotaCollector.hh>

Inheritance diagram for protocols::frag_picker::quota::QuotaCollector:
Inheritance graph
[legend]
Collaboration diagram for protocols::frag_picker::quota::QuotaCollector:
Collaboration graph
[legend]

Public Member Functions

 QuotaCollector (Size query_size, Size frag_size)
 
bool add (std::pair< FragmentCandidateOP, scores::FragmentScoreMapOP >)
 Insert a fragment candidate to the container. More...
 
void clear ()
 removes all candidates from the container More...
 
Size count_candidates (Size) const
 Check how many candidates have been already collected for a given position. More...
 
Size count_candidates () const
 Check how many candidates have been already collected for all positions. More...
 
Size query_length () const
 Check the size of query sequence that this object knows. This is mainly to be ale to check if it is the same as in the other parts of fragment picking machinery. More...
 
ScoredCandidatesVector1get_candidates (Size position_in_query)
 
void print_report (std::ostream &output, scores::FragmentScoreManagerOP scoring) const
 Describes what has been collected. More...
 
void insert (Size pos, CandidatesCollectorOP collector)
 Inserts candidates from another QuotaCollector for a give position in the query Candidates may or may not get inserted depending on the candidate. More...
 
void list_pools (std::ostream &where) const
 list all registered pools with their capacity More...
 
Size count_pools (Size position) const
 prints the number of quota pools for a given positio in query More...
 
QuotaPoolCOP get_pool (Size position, Size pool_id) const
 
QuotaPoolOP get_pool (Size position, Size pool_id)
 
void add_pool (Size position, QuotaPoolOP the_pool)
 
void renormalize_quota_pools ()
 
void attach_secondary_structure_pools (Real, core::fragment::SecondaryStructureOP, std::string, Size, utility::vector1< Size >, utility::vector1< Real >, Size)
 
- Public Member Functions inherited from protocols::frag_picker::CandidatesCollector
virtual bool add (ScoredCandidate)=0
 Insert a fragment candidate to the container. More...
 

Private Attributes

Size frag_size_
 
ScoredCandidatesVector1 frags_for_pos_
 
utility::vector1
< utility::vector1
< QuotaPoolOP > > 
storage_
 

Detailed Description

A base class for collecting fragments.

Detailed: The purpose of a collector is to keep fragment candidates to the end
of vall processing. Then a selector will go through all the candidates stored in a collector and select the final fragments
See Also
GrabAll collector for a possible implementation

Constructor & Destructor Documentation

protocols::frag_picker::quota::QuotaCollector::QuotaCollector ( Size  query_size,
Size  frag_size 
)
inline

References frag_size_, and storage_.

Member Function Documentation

bool protocols::frag_picker::quota::QuotaCollector::add ( std::pair< FragmentCandidateOP, scores::FragmentScoreMapOP candidate)

Insert a fragment candidate to the container.

References storage_.

void protocols::frag_picker::quota::QuotaCollector::add_pool ( Size  position,
QuotaPoolOP  the_pool 
)
inline

References storage_.

void protocols::frag_picker::quota::QuotaCollector::attach_secondary_structure_pools ( Real  prediction_fraction,
core::fragment::SecondaryStructureOP  prediction,
std::string  name,
Size  n_candidates,
utility::vector1< Size components,
utility::vector1< Real weights,
Size  n_scores 
)
void protocols::frag_picker::quota::QuotaCollector::clear ( )
virtual

removes all candidates from the container

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

Size protocols::frag_picker::quota::QuotaCollector::count_candidates ( Size  pos) const
virtual

Check how many candidates have been already collected for a given position.

Implements protocols::frag_picker::CandidatesCollector.

References count_candidates(), and storage_.

Size protocols::frag_picker::quota::QuotaCollector::count_candidates ( ) const
virtual

Check how many candidates have been already collected for all positions.

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

Referenced by count_candidates().

Size protocols::frag_picker::quota::QuotaCollector::count_pools ( Size  position) const
inline

prints the number of quota pools for a given positio in query

References storage_.

Referenced by protocols::frag_picker::QuotaDebug::setup_summary().

ScoredCandidatesVector1 & protocols::frag_picker::quota::QuotaCollector::get_candidates ( Size  position_in_query)
virtual
QuotaPoolCOP protocols::frag_picker::quota::QuotaCollector::get_pool ( Size  position,
Size  pool_id 
) const
inline
QuotaPoolOP protocols::frag_picker::quota::QuotaCollector::get_pool ( Size  position,
Size  pool_id 
)
inline

References storage_.

void protocols::frag_picker::quota::QuotaCollector::insert ( Size  pos,
CandidatesCollectorOP  collector 
)
inlinevirtual

Inserts candidates from another QuotaCollector for a give position in the query Candidates may or may not get inserted depending on the candidate.

Implements protocols::frag_picker::CandidatesCollector.

References core::pack::dunbrack::c, and storage_.

void protocols::frag_picker::quota::QuotaCollector::list_pools ( std::ostream &  where) const

list all registered pools with their capacity

References storage_.

void protocols::frag_picker::quota::QuotaCollector::print_report ( std::ostream &  output,
scores::FragmentScoreManagerOP  scoring 
) const
virtual

Describes what has been collected.

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

Size protocols::frag_picker::quota::QuotaCollector::query_length ( ) const
inlinevirtual

Check the size of query sequence that this object knows. This is mainly to be ale to check if it is the same as in the other parts of fragment picking machinery.

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

Referenced by protocols::frag_picker::QuotaDebug::setup_summary().

void protocols::frag_picker::quota::QuotaCollector::renormalize_quota_pools ( )

References storage_.

Member Data Documentation

Size protocols::frag_picker::quota::QuotaCollector::frag_size_
private
ScoredCandidatesVector1 protocols::frag_picker::quota::QuotaCollector::frags_for_pos_
private

Referenced by get_candidates().

utility::vector1< utility::vector1<QuotaPoolOP> > protocols::frag_picker::quota::QuotaCollector::storage_
private

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