protocols::simple_filters::SSElementLengthFilter Class Reference

#include <SSElementLengthFilter.hh>

Inheritance diagram for protocols::simple_filters::SSElementLengthFilter:

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
	SSElementLengthFilter ()
	SSElementLengthFilter (SSElementLengthFilter const &rval)
	~SSElementLengthFilter () override
filters::FilterOP	clone () const override
filters::FilterOP	fresh_instance () const override
Real	report_sm (const Pose &pose) const override
	used to report filter internals through a score or silent file More...
void	report (std::ostream &out, const Pose &pose) const override
protocols::loops::Loops	get_ss_elements (const Pose &pose) const
	get ss_elements More...
Real	compute (const Pose &pose) const
bool	apply (const Pose &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
void	parse_my_tag (TagCOP tag, basic::datacache::DataMap &data) override
	parse xml 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 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
Real	threshold_
bool	report_avg_
bool	report_longest_
bool	report_shortest_
core::select::residue_selector::ResidueSelectorCOP	selector_

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

Member Typedef Documentation

typedef basic::datacache::DataMap protocols::simple_filters::SSElementLengthFilter::DataMap

typedef protocols::filters::Filter protocols::simple_filters::SSElementLengthFilter::Filter

typedef protocols::filters::FilterOP protocols::simple_filters::SSElementLengthFilter::FilterOP

typedef core::pose::Pose protocols::simple_filters::SSElementLengthFilter::Pose

typedef core::Real protocols::simple_filters::SSElementLengthFilter::Real

typedef std::string protocols::simple_filters::SSElementLengthFilter::String

typedef protocols::filters::Filter protocols::simple_filters::SSElementLengthFilter::Super

typedef utility::tag::TagCOP protocols::simple_filters::SSElementLengthFilter::TagCOP

Constructor & Destructor Documentation

protocols::simple_filters::SSElementLengthFilter::SSElementLengthFilter

(

)

protocols::simple_filters::SSElementLengthFilter::SSElementLengthFilter

(

SSElementLengthFilter const &

rval

)

protocols::simple_filters::SSElementLengthFilter::~SSElementLengthFilter ( )

overridedefault

Member Function Documentation

bool protocols::simple_filters::SSElementLengthFilter::apply ( const Pose &  pose ) const

overridevirtual

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

Implements protocols::filters::Filter.

References compute(), threshold_, and protocols::simple_filters::tr().

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

static

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

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

inlineoverridevirtual

Implements protocols::filters::Filter.

Real protocols::simple_filters::SSElementLengthFilter::compute

(

const Pose &

pose

)

const

References get_ss_elements(), report_longest_, report_shortest_, and protocols::loops::Loops::size().

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

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

inlineoverridevirtual

Implements protocols::filters::Filter.

protocols::loops::Loops protocols::simple_filters::SSElementLengthFilter::get_ss_elements

(

const Pose &

pose

)

const

get ss_elements

References protocols::loops::Loops::add_loop(), protocols::simple_filters::dssp(), core::scoring::dssp::Dssp::dssp_reduced(), core::scoring::dssp::Dssp::get_dssp_secstruct(), selector_, core::pose::Pose::size(), and core::pose::Pose::total_residue().

Referenced by compute().

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::SSElementLengthFilter::parse_my_tag ( TagCOP  tag, basic::datacache::DataMap &  data  )

overridevirtual

parse xml

Reimplemented from protocols::filters::Filter.

References core::select::residue_selector::parse_residue_selector(), report_avg_, report_longest_, report_shortest_, selector_, and threshold_.

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

static

References core::select::residue_selector::attributes_for_parse_residue_selector(), core::scoring::attributes_for_parse_score_function(), class_name(), and protocols::filters::xsd_type_definition_w_attributes().

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

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute().

SSElementLengthFilter::Real protocols::simple_filters::SSElementLengthFilter::report_sm ( const Pose &  ) const

overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

Member Data Documentation

bool protocols::simple_filters::SSElementLengthFilter::report_avg_

private

Referenced by parse_my_tag().

bool protocols::simple_filters::SSElementLengthFilter::report_longest_

private

Referenced by compute(), and parse_my_tag().

bool protocols::simple_filters::SSElementLengthFilter::report_shortest_

private

Referenced by compute(), and parse_my_tag().

core::select::residue_selector::ResidueSelectorCOP protocols::simple_filters::SSElementLengthFilter::selector_

private

Referenced by get_ss_elements(), and parse_my_tag().

Real protocols::simple_filters::SSElementLengthFilter::threshold_

private

Referenced by apply(), and parse_my_tag().

---

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

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