protocols::fldsgn::filters::HelixKinkFilter Class Reference

#include <HelixKinkFilter.hh>

Inheritance diagram for protocols::fldsgn::filters::HelixKinkFilter:

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

Public Member Functions
	HelixKinkFilter ()
	~HelixKinkFilter () 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...
std::string	name () const override
Public Member Functions inherited from protocols::filters::Filter
	Filter ()
	Filter (std::string const &)
	Filter (Filter const &)
	~Filter () override
virtual void	report (std::ostream &, core::pose::Pose const &) const
virtual core::Real	report_sm (core::pose::Pose const &) const
	used to report filter internals through a score or silent file More...
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	bend_angle_
String	secstruct_
String	string_resnums_
bool	select_resnums_
bool	select_range_
core::Size	helix_start_
core::Size	helix_end_

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

Member Typedef Documentation

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

typedef protocols::filters::Filter protocols::fldsgn::filters::HelixKinkFilter::Filter

typedef protocols::filters::FilterOP protocols::fldsgn::filters::HelixKinkFilter::FilterOP

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

typedef core::Real protocols::fldsgn::filters::HelixKinkFilter::Real

typedef core::Size protocols::fldsgn::filters::HelixKinkFilter::Size

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

typedef protocols::filters::Filter protocols::fldsgn::filters::HelixKinkFilter::Super

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

Constructor & Destructor Documentation

protocols::fldsgn::filters::HelixKinkFilter::HelixKinkFilter

(

)

protocols::fldsgn::filters::HelixKinkFilter::~HelixKinkFilter ( )

inlineoverride

Member Function Documentation

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

overridevirtual

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

Implements protocols::filters::Filter.

References bend_angle_, core::pose::Pose::chain(), protocols::fldsgn::topology::check_kink_helix(), core::scoring::Energies::data(), core::pose::Pose::energies(), core::pose::get_resnum_list_ordered(), core::scoring::EnergiesCacheableDataType::HBOND_SET, helix_end_, helix_start_, core::conformation::Residue::is_lower_terminus(), core::pose::Pose::residue(), core::pose::Pose::secstruct(), secstruct_, select_range_, select_resnums_, core::pose::Pose::size(), string_resnums_, and protocols::fldsgn::TR().

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

static

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

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

inlineoverridevirtual

Implements protocols::filters::Filter.

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

inlineoverridevirtual

Implements protocols::filters::Filter.

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

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

overridevirtual

parse xml

Reimplemented from protocols::filters::Filter.

References bend_angle_, helix_end_, helix_start_, protocols::parser::BluePrint::secstruct(), secstruct_, select_range_, select_resnums_, string_resnums_, and protocols::fldsgn::TR().

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

static

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

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

Member Data Documentation

Real protocols::fldsgn::filters::HelixKinkFilter::bend_angle_

private

Referenced by apply(), and parse_my_tag().

core::Size protocols::fldsgn::filters::HelixKinkFilter::helix_end_

private

Referenced by apply(), and parse_my_tag().

core::Size protocols::fldsgn::filters::HelixKinkFilter::helix_start_

private

Referenced by apply(), and parse_my_tag().

String protocols::fldsgn::filters::HelixKinkFilter::secstruct_

private

Referenced by apply(), and parse_my_tag().

bool protocols::fldsgn::filters::HelixKinkFilter::select_range_

private

Referenced by apply(), and parse_my_tag().

bool protocols::fldsgn::filters::HelixKinkFilter::select_resnums_

private

Referenced by apply(), and parse_my_tag().

String protocols::fldsgn::filters::HelixKinkFilter::string_resnums_

private

Referenced by apply(), and parse_my_tag().

---

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

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