This filter computes the longest continuous stretch of polar residues within a pose or selection. More...

#include <LongestContinuousApolarSegmentFilter.hh>

Inheritance diagram for protocols::simple_filters::LongestContinuousApolarSegmentFilter:

[legend]

Public Member Functions
	LongestContinuousApolarSegmentFilter ()
	Constructor. More...

	~LongestContinuousApolarSegmentFilter () override
	destructor. More...

std::string	name () const override

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

bool	is_counted (core::chemical::ResidueType const &restype) const override
	Given a residue type, determine whether it's one of the types that this filter should count. More...

std::string	counted_residue_description () const override
	returns type of counted residues (apolar) More...

Public Member Functions inherited from protocols::simple_filters::LongestContinuousPolarSegmentFilter
	LongestContinuousPolarSegmentFilter ()
	Constructor. More...

	LongestContinuousPolarSegmentFilter (std::string const &filter_name)
	Constructor. More...

	~LongestContinuousPolarSegmentFilter () override
	destructor (important for properly forward-declaring smart-pointer members) More...

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

void	set_exclude_chain_termini (bool const setting)
	Set whether I should exclude stretches of polars are the N- and C-termini of chains. More...

bool	exclude_chain_termini () const
	Get whether I should exclude stretches of polars are the N- and C-termini of chains. More...

void	set_count_gly_as_polar (bool const setting)
	Set whether glycine is counted as a polar residue type. More...

bool	count_gly_as_polar () const
	Get whether glycine is counted as a polar residue type. More...

void	set_filter_out_high (bool const setting)
	Set whether I should filter out high (true) or low (false) poses. More...

bool	filter_out_high () const
	Get whether I should filter out high (true) or low (false) poses. More...

void	set_cutoff (core::Size const cutoff)
	Set the max (or min) tolerated number of polars. More...

core::Size	cutoff () const
	Get the max (or min) tolerated number of polars. More...

void	set_residue_selector (core::select::residue_selector::ResidueSelectorCOP selector_in)
	Set the residue selector. More...

core::select::residue_selector::ResidueSelectorCOP	residue_selector () const
	Get the residue selector. More...

std::string	name () const override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
	parse XML tag (to use this Filter 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...

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)

Static Public Member Functions inherited from protocols::simple_filters::LongestContinuousPolarSegmentFilter
static std::string	class_name ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

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

Detailed Description

This filter computes the longest continuous stretch of polar residues within a pose or selection.

Constructor & Destructor Documentation

◆ LongestContinuousApolarSegmentFilter()

protocols::simple_filters::LongestContinuousApolarSegmentFilter::LongestContinuousApolarSegmentFilter ( )

Constructor.

Constructor of parent.

◆ ~LongestContinuousApolarSegmentFilter()

protocols::simple_filters::LongestContinuousApolarSegmentFilter::~LongestContinuousApolarSegmentFilter ( )

overridedefault

destructor.

Destructor.

Member Function Documentation

◆ class_name()

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

static

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

◆ clone()

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

overridevirtual

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

◆ counted_residue_description()

std::string protocols::simple_filters::LongestContinuousApolarSegmentFilter::counted_residue_description ( ) const

overridevirtual

returns type of counted residues (apolar)

Reimplemented from protocols::simple_filters::LongestContinuousPolarSegmentFilter.

◆ fresh_instance()

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

overridevirtual

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

◆ is_counted()

bool protocols::simple_filters::LongestContinuousApolarSegmentFilter::is_counted ( core::chemical::ResidueType const & restype ) const

overridevirtual

Given a residue type, determine whether it's one of the types that this filter should count.

Based on whether the residue type has the APOLAR property.

Based on whether the residue type has the APOLAR property. APOLAR is defined as "not POLAR".

Reimplemented from protocols::simple_filters::LongestContinuousPolarSegmentFilter.

References core::chemical::ResidueType::is_polar().

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ provide_xml_schema()

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

static

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

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

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

src/protocols/simple_filters/LongestContinuousApolarSegmentFilter.hh
src/protocols/simple_filters/LongestContinuousApolarSegmentFilter.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LongestContinuousApolarSegmentFilter()

◆ ~LongestContinuousApolarSegmentFilter()

Member Function Documentation

◆ class_name()

◆ clone()

◆ counted_residue_description()

◆ fresh_instance()

◆ is_counted()

◆ name()

◆ provide_xml_schema()