protocols::simple_filters::ReadPoseExtraScoreFilter Class Reference

#include <ReadPoseExtraScoreFilter.hh>

Inheritance diagram for protocols::simple_filters::ReadPoseExtraScoreFilter:

Public Member Functions
	ReadPoseExtraScoreFilter ()
	Constructor. More...
	ReadPoseExtraScoreFilter (std::string const &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 () 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
std::string	term_name_
core::Real	threshold_

Additional Inherited Members
Protected Attributes inherited from protocols::filters::Filter
std::string	scorename_

Constructor & Destructor Documentation

ReadPoseExtraScoreFilter() [1/2]

protocols::simple_filters::ReadPoseExtraScoreFilter::ReadPoseExtraScoreFilter

(

)

Constructor.

ReadPoseExtraScoreFilter() [2/2]

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

Constructor with parameters.

~ReadPoseExtraScoreFilter()

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

override

Member Function Documentation

apply()

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_.

class_name()

static std::string protocols::simple_filters::ReadPoseExtraScoreFilter::class_name ( )

inlinestatic

Referenced by protocols::simple_filters::ReadPoseExtraScoreFilterCreator::keyname(), name(), and provide_xml_schema().

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

compute()

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().

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

inlineoverridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

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_.

provide_xml_schema()

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

static

References class_name(), and protocols::filters::xsd_type_definition_w_attributes().

Referenced by protocols::simple_filters::ReadPoseExtraScoreFilterCreator::provide_xml_schema().

report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), core::conformation::membrane::out, and term_name_.

report_sm()

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().

set_term_name()

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_.

set_threshold()

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

term_name_

std::string protocols::simple_filters::ReadPoseExtraScoreFilter::term_name_

private

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

threshold_

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:

• src/protocols/simple_filters/ReadPoseExtraScoreFilter.hh
• src/protocols/simple_filters/ReadPoseExtraScoreFilter.cc