protocols::filters::TrueFalseFilter Class Reference

A filter that can be set to either return true or false - useful in RS. More...

#include <BasicFilters.hh>

Inheritance diagram for protocols::filters::TrueFalseFilter:

Public Member Functions
	TrueFalseFilter ()
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
std::string	name () const override
void	set_action (bool action)
	Set the action that this filter will return. More...
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...
Public Member Functions inherited from protocols::filters::Filter
	Filter ()
	Filter (std::string const &)
	~Filter () override
virtual void	report (std::ostream &, core::pose::Pose const &) const
virtual core::Real	report_sm (core::pose::Pose const &) const
	used to report filter internals through a score or silent file More...
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
bool	action_ = true

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

Detailed Description

A filter that can be set to either return true or false - useful in RS.

Constructor & Destructor Documentation

TrueFalseFilter()

protocols::filters::TrueFalseFilter::TrueFalseFilter ( )

inline

Member Function Documentation

apply()

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

inlineoverridevirtual

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

Implements protocols::filters::Filter.

References action_.

class_name()

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

static

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

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

parse_my_tag()

void protocols::filters::TrueFalseFilter::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 protocols::filters::TR().

provide_xml_schema()

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

static

References protocols::filters::xsd_type_definition_w_attributes().

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

set_action()

void protocols::filters::TrueFalseFilter::set_action

(

bool

action

)

Set the action that this filter will return.

Member Data Documentation

action_

bool protocols::filters::TrueFalseFilter::action_ = true

private

Referenced by apply().

---

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

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