Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
protocols::match::output::MatchProcessor Class Referenceabstract

#include <MatchProcessor.hh>

Inheritance diagram for protocols::match::output::MatchProcessor:
Inheritance graph
[legend]
Collaboration diagram for protocols::match::output::MatchProcessor:
Collaboration graph
[legend]

Public Member Functions

 MatchProcessor ()
 
virtual ~MatchProcessor ()
 
virtual void begin_processing ()
 Invoked by the Matcher before it begins feeding matches to the processor. Base-class has a no-op implementation. More...
 
virtual void process_match (match const &m)=0
 
virtual void process_match (match_dspos1 const &m)=0
 
virtual void end_processing ()
 Invoked by the Matcher after it finishes feeding matches to the processor. Base-class has a no-op implementation. More...
 
bool match_processing_successful () const
 
void set_output_writer (OutputWriterOP writer)
 
OutputWriterOP output_writer ()
 const access to the output writer, e.g. for the MatcherMover when incorporating matches into the pose More...
 
void add_filter (MatchFilterOP filter)
 
void reset_filters ()
 
void clear_filters ()
 
UpstreamDownstreamCollisionFilterCOP up_down_filt () const
 
UpstreamCollisionFilterCOP up_coll_filt () const
 

Protected Member Functions

bool passes_filters (match const &m)
 
bool passes_filters (match_dspos1 const &m)
 
void note_match_processed ()
 

Protected Attributes

bool match_processing_successful_
 
OutputWriterOP writer_
 

Private Member Functions

void note_filter_fail (std::string filter_name)
 

Private Attributes

std::list< MatchFilterOP > filters_
 
std::list
< StateAccumulatingMatchFilterOP > 		filters_with_state_
 NOTE: these filters are not given the opportunity to accumulate state. More...
 
std::map< std::string, core::Size > filter_failcounts_
 
core::Size num_matches_processed_
 
UpstreamDownstreamCollisionFilterCOP up_down_filt_
 NOTE: this is used for clash checking between upstream only hits and the ligand. More...
 
UpstreamCollisionFilterCOP up_coll_filt_
 

Detailed Description

Definition at line 44 of file MatchProcessor.hh.

Constructor & Destructor Documentation

protocols::match::output::MatchProcessor::MatchProcessor ( )

Definition at line 44 of file MatchProcessor.cc.

References filter_failcounts_.

protocols::match::output::MatchProcessor::~MatchProcessor ( )
virtual

Definition at line 52 of file MatchProcessor.cc.

Member Function Documentation

void protocols::match::output::MatchProcessor::add_filter ( MatchFilterOP  filter)

Definition at line 162 of file MatchProcessor.cc.

References filters_, filters_with_state_, up_coll_filt(), up_coll_filt_, up_down_filt(), and up_down_filt_.

void protocols::match::output::MatchProcessor::begin_processing ( )
virtual

Invoked by the Matcher before it begins feeding matches to the processor. Base-class has a no-op implementation.

Reimplemented in protocols::match::output::MatchConsolidator, and protocols::match::output::MatchOutputter.

Definition at line 56 of file MatchProcessor.cc.

References filter_failcounts_, match_processing_successful_, num_matches_processed_, and writer_.

Referenced by protocols::match::output::MatchOutputter::begin_processing(), protocols::match::output::MatchConsolidator::begin_processing(), and protocols::match::Matcher::process_matches().

void protocols::match::output::MatchProcessor::clear_filters ( )

Definition at line 199 of file MatchProcessor.cc.

References filters_.

void protocols::match::output::MatchProcessor::end_processing ( )
virtual

Invoked by the Matcher after it finishes feeding matches to the processor. Base-class has a no-op implementation.

Reimplemented in protocols::match::output::MatchConsolidator, and protocols::match::output::MatchOutputter.

Definition at line 66 of file MatchProcessor.cc.

References filter_failcounts_, match_processing_successful_, num_matches_processed_, protocols::match::output::TR(), and writer_.

Referenced by protocols::match::output::MatchOutputter::end_processing(), protocols::match::output::MatchConsolidator::end_processing(), and protocols::match::Matcher::process_matches().

bool protocols::match::output::MatchProcessor::match_processing_successful ( ) const
inline

Definition at line 77 of file MatchProcessor.hh.

References match_processing_successful_.

void protocols::match::output::MatchProcessor::note_filter_fail ( std::string  filter_name)
private

Definition at line 100 of file MatchProcessor.cc.

References filter_failcounts_.

Referenced by passes_filters().

void protocols::match::output::MatchProcessor::note_match_processed ( )
protected

Definition at line 110 of file MatchProcessor.cc.

References num_matches_processed_.

Referenced by protocols::match::output::MatchOutputter::process_match(), and protocols::match::output::MatchConsolidator::process_match().

OutputWriterOP protocols::match::output::MatchProcessor::output_writer ( )

const access to the output writer, e.g. for the MatcherMover when incorporating matches into the pose

Definition at line 94 of file MatchProcessor.cc.

References writer_.

bool protocols::match::output::MatchProcessor::passes_filters ( match const &  m)
protected

Definition at line 116 of file MatchProcessor.cc.

References filters_, filters_with_state_, and note_filter_fail().

Referenced by protocols::match::output::MatchOutputter::process_match(), and protocols::match::output::MatchConsolidator::process_match().

bool protocols::match::output::MatchProcessor::passes_filters ( match_dspos1 const &  m)
protected

Definition at line 139 of file MatchProcessor.cc.

References filters_, filters_with_state_, and note_filter_fail().

virtual void protocols::match::output::MatchProcessor::process_match ( match const &  m)
pure virtual

Implemented in protocols::match::output::MatchConsolidator, and protocols::match::output::MatchOutputter.

Referenced by protocols::match::Matcher::process_matches_all_hit_combos_for_hit_subsets(), and protocols::match::Matcher::process_matches_where_one_geomcst_defines_downstream_location().

virtual void protocols::match::output::MatchProcessor::process_match ( match_dspos1 const &  m)
pure virtual

Implemented in protocols::match::output::MatchConsolidator, and protocols::match::output::MatchOutputter.

void protocols::match::output::MatchProcessor::reset_filters ( )

Definition at line 189 of file MatchProcessor.cc.

References filters_with_state_.

void protocols::match::output::MatchProcessor::set_output_writer ( OutputWriterOP  writer)

Definition at line 88 of file MatchProcessor.cc.

References writer_.

UpstreamCollisionFilterCOP protocols::match::output::MatchProcessor::up_coll_filt ( ) const

Definition at line 211 of file MatchProcessor.cc.

References up_coll_filt_.

Referenced by add_filter(), protocols::match::Matcher::check_non_upstream_only_hit_incompatibility(), and protocols::match::Matcher::test_upstream_only_hit_incompatibility().

UpstreamDownstreamCollisionFilterCOP protocols::match::output::MatchProcessor::up_down_filt ( ) const

Definition at line 205 of file MatchProcessor.cc.

References up_down_filt_.

Referenced by add_filter(), and protocols::match::Matcher::test_upstream_only_hit_incompatibility().

Member Data Documentation

std::map< std::string, core::Size > protocols::match::output::MatchProcessor::filter_failcounts_
private

Definition at line 131 of file MatchProcessor.hh.

Referenced by begin_processing(), end_processing(), MatchProcessor(), and note_filter_fail().

std::list< MatchFilterOP > protocols::match::output::MatchProcessor::filters_
private

Definition at line 129 of file MatchProcessor.hh.

Referenced by add_filter(), clear_filters(), and passes_filters().

std::list< StateAccumulatingMatchFilterOP > protocols::match::output::MatchProcessor::filters_with_state_
private

NOTE: these filters are not given the opportunity to accumulate state.

Definition at line 130 of file MatchProcessor.hh.

Referenced by add_filter(), passes_filters(), and reset_filters().

bool protocols::match::output::MatchProcessor::match_processing_successful_
protected

Definition at line 120 of file MatchProcessor.hh.

Referenced by begin_processing(), end_processing(), and match_processing_successful().

core::Size protocols::match::output::MatchProcessor::num_matches_processed_
private

Definition at line 132 of file MatchProcessor.hh.

Referenced by begin_processing(), end_processing(), and note_match_processed().

UpstreamCollisionFilterCOP protocols::match::output::MatchProcessor::up_coll_filt_
private

Definition at line 137 of file MatchProcessor.hh.

Referenced by add_filter(), and up_coll_filt().

UpstreamDownstreamCollisionFilterCOP protocols::match::output::MatchProcessor::up_down_filt_
private

NOTE: this is used for clash checking between upstream only hits and the ligand.

Definition at line 135 of file MatchProcessor.hh.

Referenced by add_filter(), and up_down_filt().

OutputWriterOP protocols::match::output::MatchProcessor::writer_
protected

Definition at line 122 of file MatchProcessor.hh.

Referenced by begin_processing(), end_processing(), protocols::match::output::MatchConsolidator::end_processing(), output_writer(), protocols::match::output::MatchOutputter::process_match(), protocols::match::output::MatchConsolidator::process_match(), and set_output_writer().

The documentation for this class was generated from the following files:
Generated on Sat Jun 1 2013 12:43:01 for Rosetta 3.5 by   doxygen 1.8.4