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::SidechainRmsdFilter Class Reference

#include <SidechainRmsdFilter.hh>

Inheritance diagram for protocols::simple_filters::SidechainRmsdFilter:
Inheritance graph

Public Member Functions

 SidechainRmsdFilter ()
 SidechainRmsdFilter (std::string const &res1, std::string const &res2, core::Real const rmsd_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
 ~SidechainRmsdFilter () 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 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 Attributes

std::string res1_
std::string res2_
core::Real rmsd_threshold_
core::pose::PoseCOP reference_pose_
bool include_backbone_

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::simple_filters::SidechainRmsdFilter::SidechainRmsdFilter ( )
protocols::simple_filters::SidechainRmsdFilter::SidechainRmsdFilter ( std::string const &  res1,
std::string const &  res2,
core::Real const  rmsd_threshold 
protocols::simple_filters::SidechainRmsdFilter::~SidechainRmsdFilter ( )

Member Function Documentation

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

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

Implements protocols::filters::Filter.

References compute(), res1_, rmsd_threshold_, and protocols::simple_filters::sidechain_rmsd_filter_tracer().

std::string protocols::simple_filters::SidechainRmsdFilter::class_name ( )
filters::FilterOP protocols::simple_filters::SidechainRmsdFilter::clone ( ) const
core::Real protocols::simple_filters::SidechainRmsdFilter::compute ( core::pose::Pose const &  pose) const
filters::FilterOP protocols::simple_filters::SidechainRmsdFilter::fresh_instance ( ) const
std::string protocols::simple_filters::SidechainRmsdFilter::name ( ) const

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::SidechainRmsdFilter::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 class_name(), core::pose::get_resnum_string(), include_backbone_, protocols::rosetta_scripts::legacy_saved_pose_or_input(), reference_pose_, res1_, res2_, and rmsd_threshold_.

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

Reimplemented from protocols::filters::Filter.

References compute(), and res1_.

core::Real protocols::simple_filters::SidechainRmsdFilter::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

bool protocols::simple_filters::SidechainRmsdFilter::include_backbone_

Referenced by compute(), and parse_my_tag().

core::pose::PoseCOP protocols::simple_filters::SidechainRmsdFilter::reference_pose_

Referenced by compute(), and parse_my_tag().

std::string protocols::simple_filters::SidechainRmsdFilter::res1_

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

std::string protocols::simple_filters::SidechainRmsdFilter::res2_

Referenced by compute(), and parse_my_tag().

core::Real protocols::simple_filters::SidechainRmsdFilter::rmsd_threshold_

Referenced by apply(), and parse_my_tag().

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