protocols::fldsgn::filters::FragQualFilter Class Reference

#include <FragQualFilter.hh>

Inheritance diagram for protocols::fldsgn::filters::FragQualFilter:

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 std::string	String
typedef utility::tag::TagCOP	TagCOP
typedef basic::datacache::DataMap	DataMap

Public Member Functions
	FragQualFilter ()
	FragQualFilter (FragQualFilter const &rval)
	~FragQualFilter () override
FilterOP	clone () const override
FilterOP	fresh_instance () const override
void	filtered_value (Real const &ss)
void	filtered_type (String const &ss)
void	parse_my_tag (TagCOP tag, basic::datacache::DataMap &data) override
	parse xml More...
bool	apply (Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
Real	report_sm (Pose const &pose) const override
	used to report filter internals through a score or silent file More...
void	report (std::ostream &out, Pose const &pose) const override
	used to report score More...
Real	compute (Pose const &pose) const
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
String	filtered_type_
Real	filtered_value_

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

Member Typedef Documentation

DataMap

typedef basic::datacache::DataMap protocols::fldsgn::filters::FragQualFilter::DataMap

Filter

typedef protocols::filters::Filter protocols::fldsgn::filters::FragQualFilter::Filter

FilterOP

typedef protocols::filters::FilterOP protocols::fldsgn::filters::FragQualFilter::FilterOP

Pose

typedef core::pose::Pose protocols::fldsgn::filters::FragQualFilter::Pose

Real

typedef core::Real protocols::fldsgn::filters::FragQualFilter::Real

String

typedef std::string protocols::fldsgn::filters::FragQualFilter::String

Super

typedef protocols::filters::Filter protocols::fldsgn::filters::FragQualFilter::Super

TagCOP

typedef utility::tag::TagCOP protocols::fldsgn::filters::FragQualFilter::TagCOP

Constructor & Destructor Documentation

FragQualFilter() [1/2]

protocols::fldsgn::filters::FragQualFilter::FragQualFilter

(

)

FragQualFilter() [2/2]

protocols::fldsgn::filters::FragQualFilter::FragQualFilter ( FragQualFilter const &  rval )

default

~FragQualFilter()

protocols::fldsgn::filters::FragQualFilter::~FragQualFilter ( )

inlineoverride

Member Function Documentation

apply()

bool protocols::fldsgn::filters::FragQualFilter::apply ( Pose const &  pose ) const

overridevirtual

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

Implements protocols::filters::Filter.

References compute(), filtered_value_, and tr().

class_name()

std::string protocols::fldsgn::filters::FragQualFilter::class_name ( )

static

Referenced by protocols::fldsgn::filters::FragQualFilterCreator::keyname(), name(), and provide_xml_schema().

clone()

FilterOP protocols::fldsgn::filters::FragQualFilter::clone ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

compute()

FragQualFilter::Real protocols::fldsgn::filters::FragQualFilter::compute

(

Pose const &

pose

)

const

References filtered_type_, core::pose::Pose::metric(), and protocols::filters::Filter::score().

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

filtered_type()

void protocols::fldsgn::filters::FragQualFilter::filtered_type

(

String const &

ss

)

References filtered_type_.

filtered_value()

void protocols::fldsgn::filters::FragQualFilter::filtered_value

(

Real const &

ss

)

References filtered_value_.

fresh_instance()

FilterOP protocols::fldsgn::filters::FragQualFilter::fresh_instance ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

std::string protocols::fldsgn::filters::FragQualFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::fldsgn::filters::FragQualFilter::parse_my_tag ( TagCOP  tag, basic::datacache::DataMap &  data  )

overridevirtual

parse xml

Reimplemented from protocols::filters::Filter.

References filtered_type_, filtered_value_, and tr().

provide_xml_schema()

void protocols::fldsgn::filters::FragQualFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

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

Referenced by protocols::fldsgn::filters::FragQualFilterCreator::provide_xml_schema().

report()

void protocols::fldsgn::filters::FragQualFilter::report ( std::ostream &  out, Pose const &  pose  ) const

overridevirtual

used to report score

Reimplemented from protocols::filters::Filter.

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

report_sm()

FragQualFilter::Real protocols::fldsgn::filters::FragQualFilter::report_sm ( Pose const &  ) const

overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

Member Data Documentation

filtered_type_

String protocols::fldsgn::filters::FragQualFilter::filtered_type_

private

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

filtered_value_

Real protocols::fldsgn::filters::FragQualFilter::filtered_value_

private

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

---

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

• src/protocols/fldsgn/filters/FragQualFilter.hh
• src/protocols/fldsgn/filters/FragQualFilter.cc