Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
protocols::frag_picker::CandidatesCollector Class Referenceabstract

A base class for collecting fragments. More...

#include <CandidatesCollector.hh>

Inheritance diagram for protocols::frag_picker::CandidatesCollector:
Inheritance graph
[legend]

Public Member Functions

virtual bool add (ScoredCandidate)=0
 Insert a fragment candidate to the container. More...
 
virtual void clear ()=0
 removes all candidates from the container More...
 
virtual void insert (core::Size, CandidatesCollectorOP)=0
 inserts candidates from another collector Candidates may or may not get inserted depending on the candidate and type of storage More...
 
virtual core::Size count_candidates (core::Size) const =0
 Check how many candidates have been already collected for a given position. More...
 
virtual core::Size count_candidates () const =0
 Check how many candidates have been already collected for all positions. More...
 
virtual core::Size query_length () const =0
 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...
 
virtual ScoredCandidatesVector1get_candidates (core::Size position_in_query)=0
 
virtual void print_report (std::ostream &output, scores::FragmentScoreManagerOP scoring) const =0
 Describes what has been collected. More...
 

Detailed Description

A base class for collecting fragments.

TODO write collector for mixed fragment lengths

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

Member Function Documentation

virtual bool protocols::frag_picker::CandidatesCollector::add ( ScoredCandidate  )
pure virtual
virtual void protocols::frag_picker::CandidatesCollector::clear ( )
pure virtual
virtual core::Size protocols::frag_picker::CandidatesCollector::count_candidates ( core::Size  ) const
pure virtual
virtual core::Size protocols::frag_picker::CandidatesCollector::count_candidates ( ) const
pure virtual
virtual ScoredCandidatesVector1& protocols::frag_picker::CandidatesCollector::get_candidates ( core::Size  position_in_query)
pure virtual
virtual void protocols::frag_picker::CandidatesCollector::insert ( core::Size  ,
CandidatesCollectorOP   
)
pure virtual
virtual void protocols::frag_picker::CandidatesCollector::print_report ( std::ostream &  output,
scores::FragmentScoreManagerOP  scoring 
) const
pure virtual
virtual core::Size protocols::frag_picker::CandidatesCollector::query_length ( ) const
pure virtual

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