protocols::simple_filters::ResidueSelectionDistanceFilter Class Reference

#include <ResidueSelectionDistanceFilter.hh>

Inheritance diagram for protocols::simple_filters::ResidueSelectionDistanceFilter:

Public Member Functions
	ResidueSelectionDistanceFilter ()
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
	~ResidueSelectionDistanceFilter () override
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) 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
core::Real	distance_threshold_
std::string	atom_to_measure_
core::select::residue_selector::ResidueSelectorCOP	selector_

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

Constructor & Destructor Documentation

ResidueSelectionDistanceFilter()

protocols::simple_filters::ResidueSelectionDistanceFilter::ResidueSelectionDistanceFilter ( )

inline

~ResidueSelectionDistanceFilter()

protocols::simple_filters::ResidueSelectionDistanceFilter::~ResidueSelectionDistanceFilter ( )

overridedefault

Member Function Documentation

apply()

bool protocols::simple_filters::ResidueSelectionDistanceFilter::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(), core::kinematics::distance(), distance_threshold_, core::select::resids(), selector_, core::pose::Pose::total_residue(), and protocols::simple_filters::TR().

class_name()

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

static

Referenced by protocols::simple_filters::ResidueSelectionDistanceFilterCreator::keyname(), name(), and provide_xml_schema().

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

compute()

core::Real protocols::simple_filters::ResidueSelectionDistanceFilter::compute

(

core::pose::Pose const &

pose

)

const

References atom_to_measure_, core::pose::Pose::conformation(), core::kinematics::distance(), core::conformation::Residue::nbr_atom(), core::conformation::Conformation::residue(), selector_, core::pose::Pose::total_residue(), and core::conformation::Residue::xyz().

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

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::simple_filters::ResidueSelectionDistanceFilter::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 atom_to_measure_, distance_threshold_, core::select::residue_selector::parse_residue_selector(), and selector_.

provide_xml_schema()

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

static

References core::select::residue_selector::attributes_for_parse_residue_selector(), class_name(), and protocols::filters::xsd_type_definition_w_attributes().

Referenced by protocols::simple_filters::ResidueSelectionDistanceFilterCreator::provide_xml_schema().

report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), core::kinematics::distance(), distance_threshold_, core::conformation::membrane::out, core::select::resids(), selector_, and core::pose::Pose::total_residue().

report_sm()

core::Real protocols::simple_filters::ResidueSelectionDistanceFilter::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(), and core::kinematics::distance().

Member Data Documentation

atom_to_measure_

std::string protocols::simple_filters::ResidueSelectionDistanceFilter::atom_to_measure_

private

Referenced by compute(), and parse_my_tag().

distance_threshold_

core::Real protocols::simple_filters::ResidueSelectionDistanceFilter::distance_threshold_

private

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

selector_

core::select::residue_selector::ResidueSelectorCOP protocols::simple_filters::ResidueSelectionDistanceFilter::selector_

private

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

---

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

• src/protocols/simple_filters/ResidueSelectionDistanceFilter.hh
• src/protocols/simple_filters/ResidueSelectionDistanceFilter.cc