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:

[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 () 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 void	provide_citation_info (basic::citation_manager::CitationCollectionList &) const
	Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...

Public Member Functions inherited from protocols::moves::ResId
	ResId ()=default

	ResId (core::Size const r)

virtual	~ResId ()=default

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< FilterOP >	reset_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

◆ CompoundStatement

typedef std::vector< std::pair< FilterOP, boolean_operations > > protocols::filters::CompoundFilter::CompoundStatement

◆ const_iterator

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

◆ iterator

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

Constructor & Destructor Documentation

◆ CompoundFilter() [1/2]

protocols::filters::CompoundFilter::CompoundFilter ( )

◆ ~CompoundFilter()

protocols::filters::CompoundFilter::~CompoundFilter ( )

overridedefault

◆ CompoundFilter() [2/2]

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

Member Function Documentation

◆ apply()

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().

◆ begin() [1/2]

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

References compound_statement_.

◆ begin() [2/2]

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

References compound_statement_.

◆ class_name()

std::string protocols::filters::CompoundFilter::class_name ( )

static

Referenced by protocols::filters::CompoundFilterCreator::keyname().

◆ clear()

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_.

◆ clear_reset_filters()

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

References reset_filters_.

◆ clone()

FilterOP protocols::filters::CompoundFilter::clone ( ) const

overridevirtual

Implements protocols::filters::Filter.

◆ compute()

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

References protocols::filters::AND, protocols::filters::ANDNOT, compound_statement_, compute_subfilter(), invert_, protocols::filters::NAND, protocols::filters::NOR, protocols::filters::NOT, protocols::filters::OR, protocols::filters::ORNOT, protocols::filters::TR(), and protocols::filters::XOR.

Referenced by apply(), report(), and report_sm().

◆ compute_subfilter()

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().