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

#include <ReadPoseExtraScoreFilter.hh>

Inheritance diagram for protocols::simple_filters::ReadPoseExtraScoreFilter:
Inheritance graph
[legend]

Public Member Functions

 ReadPoseExtraScoreFilter ()
 Constructor. More...
 
 ReadPoseExtraScoreFilter (ReadPoseExtraScoreFilter const &src)
 Copy constructor. More...
 
 ReadPoseExtraScoreFilter (std::string term, core::Real threshold)
 Constructor with parameters. More...
 
 ~ReadPoseExtraScoreFilter () override
 
bool apply (core::pose::Pose const &pose) const override
 Returns false if the score term is greater than the threshold. More...
 
filters::FilterOP clone () const override
 
filters::FilterOP fresh_instance () const override
 
void set_term_name (std::string term_name)
 Sets the name of the term being searched for in the pose. More...
 
void set_threshold (core::Real const &threshold)
 apply() returns false if the score is greater than this threshold More...
 
void report (std::ostream &out, core::pose::Pose const &pose) const override
 
core::Real report_sm (core::pose::Pose const &pose) const override
 polymorphic way to call compute() More...
 
core::Real compute (core::pose::Pose const &pose) const
 attempt to extract the score term from the pose. This method does no calculation. More...
 
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 term_name_
 
core::Real threshold_
 

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::simple_filters::ReadPoseExtraScoreFilter::ReadPoseExtraScoreFilter ( )

Constructor.

protocols::simple_filters::ReadPoseExtraScoreFilter::ReadPoseExtraScoreFilter ( ReadPoseExtraScoreFilter const &  src)

Copy constructor.

protocols::simple_filters::ReadPoseExtraScoreFilter::ReadPoseExtraScoreFilter ( std::string  term,
core::Real  threshold 
)

Constructor with parameters.

protocols::simple_filters::ReadPoseExtraScoreFilter::~ReadPoseExtraScoreFilter ( )
override

Member Function Documentation

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

Returns false if the score term is greater than the threshold.

Implements protocols::filters::Filter.

References compute(), protocols::filters::Filter::score(), and threshold_.

static std::string protocols::simple_filters::ReadPoseExtraScoreFilter::class_name ( )
inlinestatic
filters::FilterOP protocols::simple_filters::ReadPoseExtraScoreFilter::clone ( ) const
inlineoverridevirtual
core::Real protocols::simple_filters::ReadPoseExtraScoreFilter::compute ( core::pose::Pose const &  pose) const

attempt to extract the score term from the pose. This method does no calculation.

References core::pose::getPoseExtraScore(), and term_name_.

Referenced by apply(), report(), and report_sm().

filters::FilterOP protocols::simple_filters::ReadPoseExtraScoreFilter::fresh_instance ( ) const
inlineoverridevirtual
std::string protocols::simple_filters::ReadPoseExtraScoreFilter::name ( ) const
inlineoverridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::ReadPoseExtraScoreFilter::parse_my_tag ( utility::tag::TagCOP  ,
basic::datacache::DataMap &   
)
overridevirtual

Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing.

Reimplemented from protocols::filters::Filter.

References term_name_, and threshold_.

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

Reimplemented from protocols::filters::Filter.

References compute(), and term_name_.

core::Real protocols::simple_filters::ReadPoseExtraScoreFilter::report_sm ( core::pose::Pose const &  pose) const
overridevirtual

polymorphic way to call compute()

Reimplemented from protocols::filters::Filter.

References compute().

void protocols::simple_filters::ReadPoseExtraScoreFilter::set_term_name ( std::string  term_name)
inline

Sets the name of the term being searched for in the pose.

References term_name_.

void protocols::simple_filters::ReadPoseExtraScoreFilter::set_threshold ( core::Real const &  threshold)
inline

apply() returns false if the score is greater than this threshold

References threshold_.

Member Data Documentation

std::string protocols::simple_filters::ReadPoseExtraScoreFilter::term_name_
private
core::Real protocols::simple_filters::ReadPoseExtraScoreFilter::threshold_
private

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


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