Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Attributes | List of all members
protocols::constraint_filters::ConstraintScoreFilter Class Reference

Filter that computes scores of constraints generated by ConstraintGenerators. More...

#include <ConstraintScoreFilter.hh>

Inheritance diagram for protocols::constraint_filters::ConstraintScoreFilter:
Inheritance graph
[legend]

Public Member Functions

 ConstraintScoreFilter ()
 
 ~ConstraintScoreFilter () override
 
bool apply (core::pose::Pose const &pose) const override
 returns true if the structure passes the filter, false otherwise More...
 
core::Real report_sm (core::pose::Pose const &pose) const override
 required for reporting score values More...
 
void report (std::ostream &os, core::pose::Pose const &pose) const override
 allows printing data to a stream More...
 
virtual std::string get_name () const
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 parse XML tag (to use this Mover in Rosetta Scripts) More...
 
protocols::filters::FilterOP fresh_instance () const override
 required in the context of the parser/scripting scheme More...
 
protocols::filters::FilterOP clone () const override
 required in the context of the parser/scripting scheme 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 Types

typedef utility::vector1
< constraint_generator::ConstraintGeneratorCOP
ConstraintGeneratorCOPs
 

Private Attributes

ConstraintGeneratorCOPs cgs_
 
core::Real threshold_
 

Additional Inherited Members

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

Detailed Description

Filter that computes scores of constraints generated by ConstraintGenerators.

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::constraint_filters::ConstraintScoreFilter::ConstraintScoreFilter ( )
protocols::constraint_filters::ConstraintScoreFilter::~ConstraintScoreFilter ( )
overridedefault

Member Function Documentation

bool protocols::constraint_filters::ConstraintScoreFilter::apply ( core::pose::Pose const &  pose) const
overridevirtual

returns true if the structure passes the filter, false otherwise

Implements protocols::filters::Filter.

References report_sm(), and threshold_.

std::string protocols::constraint_filters::ConstraintScoreFilter::class_name ( )
static
protocols::filters::FilterOP protocols::constraint_filters::ConstraintScoreFilter::clone ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

protocols::filters::FilterOP protocols::constraint_filters::ConstraintScoreFilter::fresh_instance ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

std::string protocols::constraint_filters::ConstraintScoreFilter::get_name ( ) const
virtual

References class_name().

std::string protocols::constraint_filters::ConstraintScoreFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::constraint_filters::ConstraintScoreFilter::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual

parse XML tag (to use this Mover in Rosetta Scripts)

Reimplemented from protocols::filters::Filter.

References cgs_, protocols::constraint_generator::parse_constraint_generators(), and threshold_.

void protocols::constraint_filters::ConstraintScoreFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::constraint_filters::ConstraintScoreFilter::report ( std::ostream &  os,
core::pose::Pose const &  pose 
) const
overridevirtual

allows printing data to a stream

Reimplemented from protocols::filters::Filter.

core::Real protocols::constraint_filters::ConstraintScoreFilter::report_sm ( core::pose::Pose const &  pose) const
overridevirtual

Member Data Documentation

ConstraintGeneratorCOPs protocols::constraint_filters::ConstraintScoreFilter::cgs_
private

Referenced by parse_my_tag(), and report_sm().

core::Real protocols::constraint_filters::ConstraintScoreFilter::threshold_
private

Referenced by apply(), and parse_my_tag().


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