protocols::fldsgn::filters::SecondaryStructureCountFilter Class Reference

#include <SecondaryStructureCountFilter.hh>

Inheritance diagram for protocols::fldsgn::filters::SecondaryStructureCountFilter:

Public Types
typedef protocols::filters::Filter	Filter
typedef std::string	String
typedef protocols::filters::FilterOP	FilterOP
typedef core::pose::Pose	Pose
typedef utility::tag::TagCOP	TagCOP
typedef basic::datacache::DataMap	DataMap

Public Member Functions
	SecondaryStructureCountFilter ()
	~SecondaryStructureCountFilter () override
FilterOP	clone () const override
FilterOP	fresh_instance () const override
void	parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
	parse xml More...
bool	apply (Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
core::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
core::Size	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
core::Size	num_helix_pose_
core::Size	num_sheet_pose_
core::Size	num_loop_pose_
core::Size	num_helix_
core::Size	num_sheet_
core::Size	num_loop_
core::Size	num_helix_sheet_
core::Size	min_helix_length_
core::Size	max_helix_length_
core::Size	min_sheet_length_
core::Size	max_sheet_length_
core::Size	min_loop_length_
core::Size	max_loop_length_
bool	filter_helix_
bool	filter_sheet_
bool	filter_loop_
bool	filter_helix_sheet_
bool	return_total_
core::Size	min_element_resis_
core::select::residue_selector::ResidueSelectorCOP	selector_

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

Member Typedef Documentation

DataMap

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

Filter

typedef protocols::filters::Filter protocols::fldsgn::filters::SecondaryStructureCountFilter::Filter

FilterOP

typedef protocols::filters::FilterOP protocols::fldsgn::filters::SecondaryStructureCountFilter::FilterOP

Pose

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

String

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

TagCOP

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

Constructor & Destructor Documentation

SecondaryStructureCountFilter()

protocols::fldsgn::filters::SecondaryStructureCountFilter::SecondaryStructureCountFilter

(

)

~SecondaryStructureCountFilter()

protocols::fldsgn::filters::SecondaryStructureCountFilter::~SecondaryStructureCountFilter ( )

inlineoverride

Member Function Documentation

apply()

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

overridevirtual

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

Implements protocols::filters::Filter.

References compute(), filter_helix_, filter_helix_sheet_, filter_loop_, filter_sheet_, num_helix_, num_helix_pose_, num_helix_sheet_, num_loop_, num_loop_pose_, num_sheet_, and num_sheet_pose_.

class_name()

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

static

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

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

compute()

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::compute

(

Pose const &

pose

)

const

References protocols::simple_filters::dssp(), filter_helix_, filter_helix_sheet_, filter_loop_, filter_sheet_, max_helix_length_, max_loop_length_, max_sheet_length_, min_element_resis_, min_helix_length_, min_loop_length_, min_sheet_length_, num_helix_pose_, num_loop_pose_, num_sheet_pose_, return_total_, selector_, protocols::analysis::total, and tr().

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

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

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

overridevirtual

parse xml

Reimplemented from protocols::filters::Filter.

References filter_helix_, filter_helix_sheet_, filter_loop_, filter_sheet_, core::select::residue_selector::get_residue_selector(), max_helix_length_, max_loop_length_, max_sheet_length_, min_element_resis_, min_helix_length_, min_loop_length_, min_sheet_length_, num_helix_, num_helix_sheet_, num_loop_, num_sheet_, return_total_, selector_, and tr().

provide_xml_schema()

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

static

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

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

report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

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

report_sm()

core::Real protocols::fldsgn::filters::SecondaryStructureCountFilter::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

filter_helix_

bool protocols::fldsgn::filters::SecondaryStructureCountFilter::filter_helix_

private

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

filter_helix_sheet_

bool protocols::fldsgn::filters::SecondaryStructureCountFilter::filter_helix_sheet_

private

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

filter_loop_

bool protocols::fldsgn::filters::SecondaryStructureCountFilter::filter_loop_

private

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

filter_sheet_

bool protocols::fldsgn::filters::SecondaryStructureCountFilter::filter_sheet_

private

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

max_helix_length_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::max_helix_length_

private

Referenced by compute(), and parse_my_tag().

max_loop_length_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::max_loop_length_

private

Referenced by compute(), and parse_my_tag().

max_sheet_length_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::max_sheet_length_

private

Referenced by compute(), and parse_my_tag().

min_element_resis_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::min_element_resis_

private

Referenced by compute(), and parse_my_tag().

min_helix_length_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::min_helix_length_

private

Referenced by compute(), and parse_my_tag().

min_loop_length_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::min_loop_length_

private

Referenced by compute(), and parse_my_tag().

min_sheet_length_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::min_sheet_length_

private

Referenced by compute(), and parse_my_tag().

num_helix_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::num_helix_

private

Referenced by apply(), and parse_my_tag().

num_helix_pose_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::num_helix_pose_

mutableprivate

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

num_helix_sheet_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::num_helix_sheet_

private

Referenced by apply(), and parse_my_tag().

num_loop_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::num_loop_

private

Referenced by apply(), and parse_my_tag().

num_loop_pose_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::num_loop_pose_

mutableprivate

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

num_sheet_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::num_sheet_

private

Referenced by apply(), and parse_my_tag().

num_sheet_pose_

core::Size protocols::fldsgn::filters::SecondaryStructureCountFilter::num_sheet_pose_

mutableprivate

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

return_total_

bool protocols::fldsgn::filters::SecondaryStructureCountFilter::return_total_

private

Referenced by compute(), and parse_my_tag().

selector_

core::select::residue_selector::ResidueSelectorCOP protocols::fldsgn::filters::SecondaryStructureCountFilter::selector_

private

Referenced by compute(), and parse_my_tag().

---

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

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