Rosetta: protocols::simple_filters::InterRepeatContactFilter Class Reference

Rosetta

#include <InterRepeatContactFilter.hh>

Inheritance diagram for protocols::simple_filters::InterRepeatContactFilter:

Inheritance graph

[legend]

Public Types
typedef protocols::filters::Filter	Super

typedef protocols::filters::Filter	Filter

typedef protocols::filters::FilterOP	FilterOP

typedef core::Size	Size

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
	InterRepeatContactFilter ()

	InterRepeatContactFilter (InterRepeatContactFilter const &rval)

	~InterRepeatContactFilter () override=default

filters::FilterOP	clone () const override

filters::FilterOP	fresh_instance () const override

void	filtered_value (Real const &value)

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

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
	used to report score More...

Real	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
Real	filtered_value_

core::Size	numbRepeats_

core::Size	sequenceSep_

Real	distThresh_

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

Member Typedef Documentation

◆ DataMap

typedef basic::datacache::DataMap protocols::simple_filters::InterRepeatContactFilter::DataMap

◆ Filter

typedef protocols::filters::Filter protocols::simple_filters::InterRepeatContactFilter::Filter

◆ FilterOP

typedef protocols::filters::FilterOP protocols::simple_filters::InterRepeatContactFilter::FilterOP

◆ Pose

typedef core::pose::Pose protocols::simple_filters::InterRepeatContactFilter::Pose

◆ Real

typedef core::Real protocols::simple_filters::InterRepeatContactFilter::Real

◆ Size

typedef core::Size protocols::simple_filters::InterRepeatContactFilter::Size

◆ String

typedef std::string protocols::simple_filters::InterRepeatContactFilter::String

◆ Super

typedef protocols::filters::Filter protocols::simple_filters::InterRepeatContactFilter::Super

◆ TagCOP

typedef utility::tag::TagCOP protocols::simple_filters::InterRepeatContactFilter::TagCOP

Constructor & Destructor Documentation

◆ InterRepeatContactFilter() [1/2]

protocols::simple_filters::InterRepeatContactFilter::InterRepeatContactFilter ( )

◆ InterRepeatContactFilter() [2/2]

protocols::simple_filters::InterRepeatContactFilter::InterRepeatContactFilter ( InterRepeatContactFilter const & rval )

default

◆ ~InterRepeatContactFilter()

protocols::simple_filters::InterRepeatContactFilter::~InterRepeatContactFilter ( )

overridedefault

Member Function Documentation

◆ apply()

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

overridevirtual

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

Implements protocols::filters::Filter.

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

◆ class_name()

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

static

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

◆ clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

InterRepeatContactFilter::Real protocols::simple_filters::InterRepeatContactFilter::compute ( Pose const & pose ) const

References core::pose::motif::a(), protocols::match::upstream::b, distThresh_, numbRepeats_, sequenceSep_, core::pose::Pose::size(), and core::pose::Pose::xyz().

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

◆ filtered_value()

void protocols::simple_filters::InterRepeatContactFilter::filtered_value ( Real const & value )

References filtered_value_.

◆ fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

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

overridevirtual

parse xml

Reimplemented from protocols::filters::Filter.

References distThresh_, filtered_value_, numbRepeats_, sequenceSep_, and protocols::simple_filters::tr().

◆ provide_xml_schema()

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

static

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

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

◆ report()

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

overridevirtual

used to report score

Reimplemented from protocols::filters::Filter.

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

◆ report_sm()

InterRepeatContactFilter::Real protocols::simple_filters::InterRepeatContactFilter::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

◆ distThresh_

Real protocols::simple_filters::InterRepeatContactFilter::distThresh_

private

Referenced by compute(), and parse_my_tag().

◆ filtered_value_

Real protocols::simple_filters::InterRepeatContactFilter::filtered_value_

private

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

◆ numbRepeats_

core::Size protocols::simple_filters::InterRepeatContactFilter::numbRepeats_

private

Referenced by compute(), and parse_my_tag().

◆ sequenceSep_

core::Size protocols::simple_filters::InterRepeatContactFilter::sequenceSep_

private

Referenced by compute(), and parse_my_tag().

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

src/protocols/simple_filters/InterRepeatContactFilter.hh
src/protocols/simple_filters/InterRepeatContactFilter.cc