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

#include <PackStatFilter.hh>

Inheritance diagram for protocols::simple_filters::PackStatFilter:
Inheritance graph

Public Types

typedef protocols::filters::Filter Super
typedef protocols::filters::Filter Filter
typedef protocols::filters::FilterOP FilterOP
typedef core::Real Real
typedef core::pose::Pose Pose
typedef utility::tag::TagCOP TagCOP
typedef basic::datacache::DataMap DataMap

Public Member Functions

 PackStatFilter ()
 default constructor More...
 PackStatFilter (Real const &ss)
 constructor with arguments More...
 PackStatFilter (PackStatFilter const &rval)
 copy constructor More...
 ~PackStatFilter () override=default
filters::FilterOP clone () const override
 make clone More...
filters::FilterOP fresh_instance () const override
 make fresh instance More...
void filtered_score (Real const &ss)
 set filtered secondary structure More...
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
 get name of this filter More...
bool apply (Pose const &pose) const override
 returns true if the given pose passes the filter, false otherwise. In this case, the test is whether the give pose is the topology we want. More...
Real report_sm (Pose const &pose) const override
 used to report filter internals through a score or silent file More...
Real compute (Pose const &pose) const
 calc packstat score More...
std::string name () const override
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 Filter (std::string const &)
 ~Filter () override
virtual void report (std::ostream &, core::pose::Pose const &) const
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)

Public Attributes

core::Size chain_
 determine which chain to evaluate, 0 is all More...
core::Size repeats_
 how many times to repeat evaluation More...

Private Attributes

Real filtered_score_

Additional Inherited Members

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

Member Typedef Documentation

◆ DataMap

◆ Filter

◆ FilterOP

◆ Pose

◆ Real

◆ Super

◆ TagCOP

Constructor & Destructor Documentation

◆ PackStatFilter() [1/3]

protocols::simple_filters::PackStatFilter::PackStatFilter ( )

default constructor

◆ PackStatFilter() [2/3]

protocols::simple_filters::PackStatFilter::PackStatFilter ( Real const &  ss)

constructor with arguments

◆ PackStatFilter() [3/3]

protocols::simple_filters::PackStatFilter::PackStatFilter ( PackStatFilter const &  rval)

copy constructor

◆ ~PackStatFilter()

protocols::simple_filters::PackStatFilter::~PackStatFilter ( )

Member Function Documentation

◆ apply()

bool protocols::simple_filters::PackStatFilter::apply ( Pose const &  pose) const

returns true if the given pose passes the filter, false otherwise. In this case, the test is whether the give pose is the topology we want.

Implements protocols::filters::Filter.

References compute(), filtered_score_, protocols::filters::Filter::score(), and protocols::simple_filters::tr().

◆ class_name()

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

◆ clone()

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

make clone

Implements protocols::filters::Filter.

◆ compute()

PackStatFilter::Real protocols::simple_filters::PackStatFilter::compute ( Pose const &  pose) const

◆ filtered_score()

void protocols::simple_filters::PackStatFilter::filtered_score ( Real const &  ss)

set filtered secondary structure

References filtered_score_, and protocols::filters::Filter::score().

◆ fresh_instance()

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

make fresh instance

Implements protocols::filters::Filter.

◆ name()

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

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::PackStatFilter::parse_my_tag ( TagCOP  tag,

get name of this filter

parse xml

Reimplemented from protocols::filters::Filter.

References chain_, filtered_score_, repeats_, and protocols::simple_filters::tr().

◆ provide_xml_schema()

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

◆ report_sm()

PackStatFilter::Real protocols::simple_filters::PackStatFilter::report_sm ( Pose const &  ) const

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

Member Data Documentation

◆ chain_

core::Size protocols::simple_filters::PackStatFilter::chain_

determine which chain to evaluate, 0 is all

Referenced by compute(), and parse_my_tag().

◆ filtered_score_

Real protocols::simple_filters::PackStatFilter::filtered_score_

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

◆ repeats_

core::Size protocols::simple_filters::PackStatFilter::repeats_

how many times to repeat evaluation

Referenced by compute(), and parse_my_tag().

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