Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::filters::CompoundFilter Class Reference

Used to define a compound logical statement involving other filters with AND, OR and XOR. More...

#include <BasicFilters.hh>

Inheritance diagram for protocols::filters::CompoundFilter:
Inheritance graph
[legend]

Public Types

typedef std::vector< std::pair
< FilterOP, boolean_operations > > 
CompoundStatement
 
typedef CompoundStatement::iterator iterator
 
typedef
CompoundStatement::const_iterator 
const_iterator
 

Public Member Functions

 CompoundFilter ()
 
 ~CompoundFilter () override
 
 CompoundFilter (CompoundStatement const &)
 
bool apply (core::pose::Pose const &) const override
 Returns true if the given pose passes the filter, false otherwise. More...
 
FilterOP clone () const override
 
FilterOP fresh_instance () const override
 
void report (std::ostream &, core::pose::Pose const &) const override
 
core::Real report_sm (core::pose::Pose const &) const override
 used to report filter internals through a score or silent file More...
 
bool compute (core::pose::Pose const &) const
 
void clear () override
 used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
void set_resid (core::Size const resid) override
 
void set_resid (core::pose::ResidueIndexDescriptionCOP r) override
 
void invert (bool const inv)
 
void set_reset_filters (utility::vector1< FilterOP > const &reset_filters)
 
void reset_filters ()
 
void clear_reset_filters ()
 
void parse_my_tag (utility::tag::TagCOP, basic::datacache::DataMap &) override
 Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...
 
std::string name () const override
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
 ~Filter () override
 
virtual std::string get_type () const
 
std::string get_user_defined_name () const
 
void set_user_defined_name (std::string const &name)
 
virtual core::Real score (core::pose::Pose &pose)
 
virtual bool filter_provides_citation_info () const
 Does this filter provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool filter_is_unpublished () const
 Does this filter indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 
- Public Member Functions inherited from protocols::moves::ResId
 ResId ()=default
 
 ResId (core::Size const r)
 
virtual core::Size get_resid (core::pose::Pose const &) const
 
bool modifiable () const
 should another method be able to modify resid_. This is used by modify_ResId_based_object as a test More...
 
void modifiable (bool const u)
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Protected Member Functions

bool compute_subfilter (FilterOP const &filter, core::pose::Pose const &pose) const
 

Private Attributes

CompoundStatement compound_statement_
 
bool invert_
 
utility::vector1< FilterOPreset_filters_
 

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Detailed Description

Used to define a compound logical statement involving other filters with AND, OR and XOR.

Member Typedef Documentation

typedef CompoundStatement::const_iterator protocols::filters::CompoundFilter::const_iterator
typedef CompoundStatement::iterator protocols::filters::CompoundFilter::iterator

Constructor & Destructor Documentation

protocols::filters::CompoundFilter::CompoundFilter ( )
protocols::filters::CompoundFilter::~CompoundFilter ( )
overridedefault
protocols::filters::CompoundFilter::CompoundFilter ( CompoundStatement const &  compound_statement)

Member Function Documentation

bool protocols::filters::CompoundFilter::apply ( core::pose::Pose const &  pose) const
overridevirtual

Returns true if the given pose passes the filter, false otherwise.

Implements protocols::filters::Filter.

References compute(), and protocols::filters::TR().

CompoundFilter::iterator protocols::filters::CompoundFilter::begin ( )

References compound_statement_.

CompoundFilter::const_iterator protocols::filters::CompoundFilter::begin ( ) const

References compound_statement_.

std::string protocols::filters::CompoundFilter::class_name ( )
static
void protocols::filters::CompoundFilter::clear ( )
overridevirtual

used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual

Reimplemented from protocols::filters::Filter.

References compound_statement_.

void protocols::filters::CompoundFilter::clear_reset_filters ( )

References reset_filters_.

FilterOP protocols::filters::CompoundFilter::clone ( ) const
overridevirtual
bool protocols::filters::CompoundFilter::compute ( core::pose::Pose const &  pose) const
bool protocols::filters::CompoundFilter::compute_subfilter ( FilterOP const &  filter,
core::pose::Pose const &  pose 
) const
protected

We break out the subfilter evaluation into a separate method so that we can have diagnostic output while still preserving the lazy evaluation semantics.

References protocols::filters::TR().

Referenced by compute().

CompoundFilter::iterator protocols::filters::CompoundFilter::end ( )

References compound_statement_.

CompoundFilter::const_iterator protocols::filters::CompoundFilter::end ( ) const

References compound_statement_.

FilterOP protocols::filters::CompoundFilter::fresh_instance ( ) const
overridevirtual
void protocols::filters::CompoundFilter::invert ( bool const  inv)

References invert_.

std::string protocols::filters::CompoundFilter::name ( ) const
overridevirtual
void protocols::filters::CompoundFilter::parse_my_tag ( utility::tag::TagCOP  ,
basic::datacache::DataMap &   
)
overridevirtual
void protocols::filters::CompoundFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::filters::CompoundFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::filters::CompoundFilter::report_sm ( core::pose::Pose const &  ) const
overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

void protocols::filters::CompoundFilter::reset_filters ( )

References compound_statement_, and reset_filters_.

Referenced by set_reset_filters().

void protocols::filters::CompoundFilter::set_reset_filters ( utility::vector1< FilterOP > const &  reset_filters)

References reset_filters(), and reset_filters_.

void protocols::filters::CompoundFilter::set_resid ( core::Size const  resid)
overridevirtual

call the compound statement's constituent filters' set_resid

Reimplemented from protocols::moves::ResId.

References compound_statement_, and protocols::moves::modify_ResId_based_object().

void protocols::filters::CompoundFilter::set_resid ( core::pose::ResidueIndexDescriptionCOP  r)
overridevirtual

call the compound statement's constituent filters' set_resid

Reimplemented from protocols::moves::ResId.

References compound_statement_, and protocols::moves::modify_ResId_based_object().

Member Data Documentation

CompoundStatement protocols::filters::CompoundFilter::compound_statement_
private
bool protocols::filters::CompoundFilter::invert_
private

Referenced by compute(), invert(), and parse_my_tag().

utility::vector1<FilterOP> protocols::filters::CompoundFilter::reset_filters_
private

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