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

#include <ContingentFilter.hh>

Inheritance diagram for protocols::filters::ContingentFilter:
Inheritance graph

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

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

Constructor & Destructor Documentation

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

default ctor

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

Member Function Documentation

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

Constructor with a single target residue.

Implements protocols::filters::Filter.

References get_value().

std::string protocols::filters::ContingentFilter::class_name ( )
protocols::filters::FilterOP protocols::filters::ContingentFilter::clone ( ) const
protocols::filters::FilterOP protocols::filters::ContingentFilter::fresh_instance ( ) const
bool protocols::filters::ContingentFilter::get_value ( ) const

References value_.

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

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

Reimplemented from protocols::filters::Filter.

References class_name().

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

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

Reimplemented from protocols::filters::Filter.

References protocols::filters::TR().

void protocols::filters::ContingentFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
void protocols::filters::ContingentFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const

Reimplemented from protocols::filters::Filter.

References get_value().

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

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References get_value().

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

References value_.

Member Data Documentation

bool protocols::filters::ContingentFilter::value_

Referenced by get_value(), and set_value().

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