Rosetta Protocols  2014.35
Public Member Functions | Private Attributes | List of all members
protocols::frag_picker::GrabAllCollector Class Reference

Keeps all fragments candidates for the final selection. More...

#include <GrabAllCollector.hh>

Public Member Functions

 GrabAllCollector (Size query_size)
 create a collector for a given size of a query sequence More...
 
bool add (ScoredCandidate new_canditate)
 Insert a fragment candidate to the container. More...
 
void clear ()
 removes all candidates from the container More...
 
void print_report (std::ostream &output, scores::FragmentScoreManagerOP) const
 prints how many fragments have been collected for each position More...
 
Size count_candidates (Size seq_pos) 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 able to check if it is the same as in the other parts of fragment picking machinery. More...
 
void insert (Size pos, CandidatesCollectorOP collector)
 Inserts candidates from another Collector for a give position in the query. More...
 
virtual ScoredCandidatesVector1get_candidates (Size position_in_query)
 returns all stored fragment candidates that begins at a given position in a query More...
 

Private Attributes

utility::vector1
< ScoredCandidatesVector1
storage_
 

Detailed Description

Keeps all fragments candidates for the final selection.

Detailed: The purpose of a collector is to keep fragment candidates to the end
of vall processing. This simple implementation keeps all candidates which might use huge memory

Constructor & Destructor Documentation

protocols::frag_picker::GrabAllCollector::GrabAllCollector ( Size  query_size)
inline

create a collector for a given size of a query sequence

References storage_.

Member Function Documentation

bool protocols::frag_picker::GrabAllCollector::add ( ScoredCandidate  new_canditate)
inlinevirtual

Insert a fragment candidate to the container.

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

void protocols::frag_picker::GrabAllCollector::clear ( )
inlinevirtual

removes all candidates from the container

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

Size protocols::frag_picker::GrabAllCollector::count_candidates ( Size  seq_pos) const
inlinevirtual

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

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

Size protocols::frag_picker::GrabAllCollector::count_candidates ( ) const
inlinevirtual

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

Implements protocols::frag_picker::CandidatesCollector.

References size(), and storage_.

virtual ScoredCandidatesVector1& protocols::frag_picker::GrabAllCollector::get_candidates ( Size  position_in_query)
inlinevirtual

returns all stored fragment candidates that begins at a given position in a query

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

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

Inserts candidates from another Collector for a give position in the query.

Implements protocols::frag_picker::CandidatesCollector.

References c, l, storage_, and utility_exit_with_message.

void protocols::frag_picker::GrabAllCollector::print_report ( std::ostream &  output,
scores::FragmentScoreManagerOP   
) const
inlinevirtual

prints how many fragments have been collected for each position

Implements protocols::frag_picker::CandidatesCollector.

References I, size(), and storage_.

Size protocols::frag_picker::GrabAllCollector::query_length ( ) const
inlinevirtual

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

Implements protocols::frag_picker::CandidatesCollector.

References storage_.

Member Data Documentation

utility::vector1< ScoredCandidatesVector1 > protocols::frag_picker::GrabAllCollector::storage_
private

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