protocols::filters::ContingentFilter Class Reference

#include <ContingentFilter.hh>

Inheritance diagram for protocols::filters::ContingentFilter:

Public Member Functions
	ContingentFilter ()
	default ctor More...
bool	apply (core::pose::Pose const &pose) const override
	Constructor with a single target residue. More...
void	report (std::ostream &out, core::pose::Pose const &pose) const override
core::Real	report_sm (core::pose::Pose const &pose) const override
	used to report filter internals through a score or silent file More...
protocols::filters::FilterOP	clone () const override
protocols::filters::FilterOP	fresh_instance () const override
	~ContingentFilter () override=default
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...
virtual void	set_value (bool const value)
virtual bool	get_value () const
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 Types
typedef protocols::filters::Filter	parent

Private Attributes
bool	value_

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

Member Typedef Documentation

parent

typedef protocols::filters::Filter protocols::filters::ContingentFilter::parent

private

Constructor & Destructor Documentation

ContingentFilter()

protocols::filters::ContingentFilter::ContingentFilter

(

)

default ctor

~ContingentFilter()

protocols::filters::ContingentFilter::~ContingentFilter ( )

overridedefault

Member Function Documentation

apply()

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

overridevirtual

Constructor with a single target residue.

Implements protocols::filters::Filter.

References get_value().

class_name()

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

static

Referenced by protocols::filters::ContingentFilterCreator::keyname(), name(), and provide_xml_schema().

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

get_value()

bool protocols::filters::ContingentFilter::get_value ( ) const

virtual

References value_.

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

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::filters::ContingentFilter::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::ContingentFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References class_name(), and protocols::filters::xsd_type_definition_w_attributes().

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

report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

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

report_sm()

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

set_value()

void protocols::filters::ContingentFilter::set_value ( bool const  value )

virtual

References value_.

Member Data Documentation

value_

bool protocols::filters::ContingentFilter::value_

private

Referenced by get_value(), and set_value().

---

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

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