Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::simple_filters::ResidueDistanceFilter Class Reference

#include <ResidueDistanceFilter.hh>

Inheritance diagram for protocols::simple_filters::ResidueDistanceFilter:
Inheritance graph

Public Member Functions

 ResidueDistanceFilter ()
 ResidueDistanceFilter (std::string const &res1, std::string const &res2, core::Real const distance_threshold)
bool apply (core::pose::Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. 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...
core::Real compute (core::pose::Pose const &pose) const
filters::FilterOP clone () const override
filters::FilterOP fresh_instance () const override
 ~ResidueDistanceFilter () override
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...
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

std::string res1_
std::string res2_
core::Real distance_threshold_

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_

Constructor & Destructor Documentation

◆ ResidueDistanceFilter() [1/2]

protocols::simple_filters::ResidueDistanceFilter::ResidueDistanceFilter ( )

◆ ResidueDistanceFilter() [2/2]

protocols::simple_filters::ResidueDistanceFilter::ResidueDistanceFilter ( std::string const &  res1,
std::string const &  res2,
core::Real const  distance_threshold 

◆ ~ResidueDistanceFilter()

protocols::simple_filters::ResidueDistanceFilter::~ResidueDistanceFilter ( )

Member Function Documentation

◆ apply()

bool protocols::simple_filters::ResidueDistanceFilter::apply ( core::pose::Pose const &  pose) const

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

Implements protocols::filters::Filter.

References compute(), core::kinematics::distance(), distance_threshold_, res1_, res2_, and protocols::simple_filters::residue_distance_filter_tracer().

◆ class_name()

std::string protocols::simple_filters::ResidueDistanceFilter::class_name ( )

◆ clone()

filters::FilterOP protocols::simple_filters::ResidueDistanceFilter::clone ( ) const

◆ compute()

core::Real protocols::simple_filters::ResidueDistanceFilter::compute ( core::pose::Pose const &  pose) const

◆ fresh_instance()

filters::FilterOP protocols::simple_filters::ResidueDistanceFilter::fresh_instance ( ) const

◆ name()

std::string protocols::simple_filters::ResidueDistanceFilter::name ( ) const

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::ResidueDistanceFilter::parse_my_tag ( utility::tag::TagCOP  ,

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

Reimplemented from protocols::filters::Filter.

References distance_threshold_, core::pose::get_resnum_string(), res1_, res2_, and protocols::simple_filters::residue_distance_filter_tracer().

◆ provide_xml_schema()

void protocols::simple_filters::ResidueDistanceFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)

◆ report()

void protocols::simple_filters::ResidueDistanceFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const

◆ report_sm()

core::Real protocols::simple_filters::ResidueDistanceFilter::report_sm ( core::pose::Pose const &  ) const

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute(), and core::kinematics::distance().

Member Data Documentation

◆ distance_threshold_

core::Real protocols::simple_filters::ResidueDistanceFilter::distance_threshold_

Referenced by apply(), and parse_my_tag().

◆ res1_

std::string protocols::simple_filters::ResidueDistanceFilter::res1_

Referenced by apply(), compute(), parse_my_tag(), and report().

◆ res2_

std::string protocols::simple_filters::ResidueDistanceFilter::res2_

Referenced by apply(), compute(), parse_my_tag(), and report().

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