Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::simple_filters::NeighborTypeFilter Class Reference

#include <NeighborTypeFilter.hh>

Inheritance diagram for protocols::simple_filters::NeighborTypeFilter:
Inheritance graph

Public Member Functions

 NeighborTypeFilter ()
 NeighborTypeFilter (std::string const &target_residue, utility::vector1< bool > const &residue_types, 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...
std::vector< core::Sizecompute (core::pose::Pose const &pose) const
filters::FilterOP clone () const override
filters::FilterOP fresh_instance () const override
void clear () override
 used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...
 ~NeighborTypeFilter () 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 (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 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 target_residue_
utility::vector1< boolresidue_types_
core::Real distance_threshold_

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::simple_filters::NeighborTypeFilter::NeighborTypeFilter ( )
protocols::simple_filters::NeighborTypeFilter::NeighborTypeFilter ( std::string const &  target_residue,
utility::vector1< bool > const &  residue_types,
core::Real const  distance_threshold 
protocols::simple_filters::NeighborTypeFilter::~NeighborTypeFilter ( )

Member Function Documentation

bool protocols::simple_filters::NeighborTypeFilter::apply ( core::pose::Pose const &  pose) const
std::string protocols::simple_filters::NeighborTypeFilter::class_name ( )
void protocols::simple_filters::NeighborTypeFilter::clear ( )

used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual

Reimplemented from protocols::filters::Filter.

References residue_types_.

filters::FilterOP protocols::simple_filters::NeighborTypeFilter::clone ( ) const
std::vector< core::Size > protocols::simple_filters::NeighborTypeFilter::compute ( core::pose::Pose const &  pose) const
filters::FilterOP protocols::simple_filters::NeighborTypeFilter::fresh_instance ( ) const
std::string protocols::simple_filters::NeighborTypeFilter::name ( ) const

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::NeighborTypeFilter::parse_my_tag ( utility::tag::TagCOP  ,
basic::datacache::DataMap &   
void protocols::simple_filters::NeighborTypeFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
void protocols::simple_filters::NeighborTypeFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
core::Real protocols::simple_filters::NeighborTypeFilter::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().

Member Data Documentation

core::Real protocols::simple_filters::NeighborTypeFilter::distance_threshold_

Referenced by compute(), and parse_my_tag().

utility::vector1< bool > protocols::simple_filters::NeighborTypeFilter::residue_types_

Referenced by clear(), compute(), and parse_my_tag().

std::string protocols::simple_filters::NeighborTypeFilter::target_residue_

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

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