protocols::simple_filters::TMsSpanMembraneFilter Class Reference

#include <TMsSpanMembraneFilter.hh>

Inheritance diagram for protocols::simple_filters::TMsSpanMembraneFilter:

Public Member Functions
	TMsSpanMembraneFilter ()
bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
void	report (std::ostream &out, core::pose::Pose const &pose) const override
core::Real	report_sm (core::pose::Pose const &pose) const override
	used to report filter internals through a score or silent file More...
core::Real	compute (core::pose::Pose const &pose) const
filters::FilterOP	clone () const override
filters::FilterOP	fresh_instance () const override
	~TMsSpanMembraneFilter () override
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
core::Real	threshold_ = 0.5
core::Real	min_distance_ = 20.0
std::string	output_ = ""
core::Size	flank_ = 1
core::Size	required_dist_ = 10

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

Constructor & Destructor Documentation

TMsSpanMembraneFilter()

protocols::simple_filters::TMsSpanMembraneFilter::TMsSpanMembraneFilter ( )

inline

~TMsSpanMembraneFilter()

protocols::simple_filters::TMsSpanMembraneFilter::~TMsSpanMembraneFilter ( )

override

Member Function Documentation

apply()

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

overridevirtual

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

Implements protocols::filters::Filter.

References compute(), and threshold_.

class_name()

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

static

Referenced by name(), and provide_xml_schema().

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

compute()

core::Real protocols::simple_filters::TMsSpanMembraneFilter::compute

(

core::pose::Pose const &

pose

)

const

References core::pose::Pose::conformation(), core::sequence::end, flank_, core::conformation::Residue::is_protein(), core::conformation::Residue::is_virtual_residue(), core::conformation::Conformation::membrane_info(), min_distance_, required_dist_, core::pose::Pose::residue(), core::conformation::Residue::seqpos(), core::pose::Pose::size(), protocols::loops::start, and protocols::simple_filters::TR().

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

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::simple_filters::TMsSpanMembraneFilter::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 flank_, min_distance_, output_, required_dist_, and threshold_.

provide_xml_schema()

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

static

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

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

report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

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

report_sm()

core::Real protocols::simple_filters::TMsSpanMembraneFilter::report_sm ( core::pose::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

flank_

core::Size protocols::simple_filters::TMsSpanMembraneFilter::flank_ = 1

private

Referenced by compute(), and parse_my_tag().

min_distance_

core::Real protocols::simple_filters::TMsSpanMembraneFilter::min_distance_ = 20.0

private

Referenced by compute(), and parse_my_tag().

output_

std::string protocols::simple_filters::TMsSpanMembraneFilter::output_ = ""

private

Referenced by parse_my_tag().

required_dist_

core::Size protocols::simple_filters::TMsSpanMembraneFilter::required_dist_ = 10

private

Referenced by compute(), and parse_my_tag().

threshold_

core::Real protocols::simple_filters::TMsSpanMembraneFilter::threshold_ = 0.5

private

Referenced by apply(), and parse_my_tag().

---

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

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