protocols::filters::IfThenFilter Class Reference

Evaluate to a value contingent on the evaluation of another filter. More...

#include <BasicFilters.hh>

Inheritance diagram for protocols::filters::IfThenFilter:

Public Member Functions
	IfThenFilter ()
	Evaluate to a value contingent on the evaluation of another filter. More...
	~IfThenFilter () override
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...
core::Real	compute (core::pose::Pose const &) const
void	threshold (core::Real threshold)
void	set_lower_threshold (bool floor=false)
	Set if threshold is an upper (false/default) or lower (true) limit. More...
void	add_condition (FilterCOP testfilter, FilterCOP valuefilter, core::Real value=0, bool invert=false, core::Real weight=1)
	Add a condition to the test. If testfilter evaluates true, then this filter evaluates to valuefilter. If valuefilter is NULL, then return value instead. Conditions are evaluated in the order they were added. More...
void	set_else (FilterCOP elsefilter, core::Real value=0, core::Real elseweight=1)
	Add evaluation if no conditions trigger If elsefilter is Null, use absolute value value instead. More...
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 void	clear ()
	used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...
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...

Static Public Member Functions
static std::string	class_name ()
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
utility::vector1< FilterCOP >	iffilters_
utility::vector1< FilterCOP >	thenfilters_
utility::vector1< core::Real >	values_
utility::vector1< core::Real >	weights_
utility::vector1< bool >	invert_
	If true, invert the sense of the iffilter test. More...
FilterCOP	elsefilter_
core::Real	elsevalue_
core::Real	elseweight_
core::Real	threshold_
bool	floor_
	If true, threshold_ is a lower limit, rather than upper limit. More...

Additional Inherited Members
Protected Attributes inherited from protocols::filters::Filter
std::string	scorename_

Detailed Description

Evaluate to a value contingent on the evaluation of another filter.

Constructor & Destructor Documentation

IfThenFilter()

protocols::filters::IfThenFilter::IfThenFilter

(

)

Evaluate to a value contingent on the evaluation of another filter.

~IfThenFilter()

protocols::filters::IfThenFilter::~IfThenFilter ( )

overridedefault

Member Function Documentation

add_condition()

void protocols::filters::IfThenFilter::add_condition	(	FilterCOP	testfilter,
		FilterCOP	valuefilter,
		core::Real	value = 0,
		bool	invert = false,
		core::Real	weight = 1
	)

Add a condition to the test. If testfilter evaluates true, then this filter evaluates to valuefilter. If valuefilter is NULL, then return value instead. Conditions are evaluated in the order they were added.

References iffilters_, invert_, thenfilters_, values_, and weights_.

Referenced by parse_my_tag().

apply()

bool protocols::filters::IfThenFilter::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(), floor_, threshold_, and protocols::filters::TR().

Referenced by compute().

class_name()

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

static

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

clone()

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

overridevirtual

Implements protocols::filters::Filter.

compute()

core::Real protocols::filters::IfThenFilter::compute

(

core::pose::Pose const &

pose

)

const

References apply(), elsefilter_, elsevalue_, elseweight_, iffilters_, invert_, thenfilters_, protocols::filters::TR(), values_, and weights_.

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

fresh_instance()

FilterOP protocols::filters::IfThenFilter::fresh_instance ( ) const

overridevirtual

Implements protocols::filters::Filter.

name()

std::string protocols::filters::IfThenFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References protocols::filters::TrueFilter::class_name().

parse_my_tag()

void protocols::filters::IfThenFilter::parse_my_tag ( utility::tag::TagCOP  , basic::datacache::DataMap &    )

overridevirtual

Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing.

Reimplemented from protocols::filters::Filter.

References add_condition(), elsefilter_, floor_, iffilters_, protocols::rosetta_scripts::parse_filter(), set_else(), set_lower_threshold(), threshold(), threshold_, and protocols::filters::TR().

provide_xml_schema()

void protocols::filters::IfThenFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References protocols::filters::TrueFilter::class_name(), and protocols::filters::xsd_type_definition_w_attributes_and_repeatable_subelements().

Referenced by protocols::filters::IfThenFilterCreator::provide_xml_schema().

report()

void protocols::filters::IfThenFilter::report ( std::ostream &  out, core::pose::Pose const &  pose  ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), and core::conformation::membrane::out.

report_sm()

core::Real protocols::filters::IfThenFilter::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().

set_else()

void protocols::filters::IfThenFilter::set_else	(	FilterCOP	elsefilter,
		core::Real	value = 0,
		core::Real	elseweight = 1
	)

Add evaluation if no conditions trigger If elsefilter is Null, use absolute value value instead.

References elsefilter_, elsevalue_, and elseweight_.

Referenced by parse_my_tag().

set_lower_threshold()

void protocols::filters::IfThenFilter::set_lower_threshold ( bool  floor = false )

inline

Set if threshold is an upper (false/default) or lower (true) limit.

References floor_.

Referenced by parse_my_tag().

threshold()

void protocols::filters::IfThenFilter::threshold ( core::Real  threshold )

inline

References threshold(), and threshold_.

Referenced by parse_my_tag(), and threshold().

Member Data Documentation

elsefilter_

FilterCOP protocols::filters::IfThenFilter::elsefilter_

private

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

elsevalue_

core::Real protocols::filters::IfThenFilter::elsevalue_

private

Referenced by compute(), and set_else().

elseweight_

core::Real protocols::filters::IfThenFilter::elseweight_

private

Referenced by compute(), and set_else().

floor_

bool protocols::filters::IfThenFilter::floor_

private

If true, threshold_ is a lower limit, rather than upper limit.

Referenced by apply(), parse_my_tag(), and set_lower_threshold().

iffilters_

utility::vector1< FilterCOP > protocols::filters::IfThenFilter::iffilters_

private

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

invert_

utility::vector1< bool > protocols::filters::IfThenFilter::invert_

private

If true, invert the sense of the iffilter test.

Referenced by add_condition(), and compute().

thenfilters_

utility::vector1< FilterCOP > protocols::filters::IfThenFilter::thenfilters_

private

Referenced by add_condition(), and compute().

threshold_

core::Real protocols::filters::IfThenFilter::threshold_

private

Referenced by apply(), parse_my_tag(), and threshold().

values_

utility::vector1< core::Real > protocols::filters::IfThenFilter::values_

private

Referenced by add_condition(), and compute().

weights_

utility::vector1< core::Real > protocols::filters::IfThenFilter::weights_

private

Referenced by add_condition(), and compute().

---

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

• src/protocols/filters/BasicFilters.hh
• src/protocols/filters/BasicFilters.cc