Rosetta  2020.37
 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
[legend]

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 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 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 ( )
inline
protocols::simple_filters::NeighborTypeFilter::NeighborTypeFilter ( std::string const &  target_residue,
utility::vector1< bool > const &  residue_types,
core::Real const  distance_threshold 
)
inline
protocols::simple_filters::NeighborTypeFilter::~NeighborTypeFilter ( )
overridedefault

Member Function Documentation

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

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
inlineoverridevirtual
std::vector< core::Size > protocols::simple_filters::NeighborTypeFilter::compute ( core::pose::Pose const &  pose) const
filters::FilterOP protocols::simple_filters::NeighborTypeFilter::fresh_instance ( ) const
inlineoverridevirtual
std::string protocols::simple_filters::NeighborTypeFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

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

Member Data Documentation

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

Referenced by compute(), and parse_my_tag().

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

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

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

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


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