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

#include <TerminusDistanceFilter.hh>

Inheritance diagram for protocols::simple_filters::TerminusDistanceFilter:
Inheritance graph

Public Member Functions

 TerminusDistanceFilter ()
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
 ~TerminusDistanceFilter () 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

core::Size distance_
core::Size jump_num_

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ TerminusDistanceFilter()

protocols::simple_filters::TerminusDistanceFilter::TerminusDistanceFilter ( )

◆ ~TerminusDistanceFilter()

protocols::simple_filters::TerminusDistanceFilter::~TerminusDistanceFilter ( )

Member Function Documentation

◆ apply()

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

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

Implements protocols::filters::Filter.

References compute(), distance_, and protocols::simple_filters::TR().

◆ class_name()

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

◆ clone()

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

◆ compute()

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

◆ fresh_instance()

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

◆ name()

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

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::TerminusDistanceFilter::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_, jump_num_, and protocols::simple_filters::TR().

◆ provide_xml_schema()

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

◆ report()

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

◆ report_sm()

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

◆ distance_

core::Size protocols::simple_filters::TerminusDistanceFilter::distance_

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

◆ jump_num_

core::Size protocols::simple_filters::TerminusDistanceFilter::jump_num_

Referenced by compute(), and parse_my_tag().

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