protocols::protein_interface_design::filters::RelativeSegmentFilter Class Reference

returns the residues aligned to a segment on the input pdb to the source pdb More...

#include <RelativeSegmentFilter.hh>

Inheritance diagram for protocols::protein_interface_design::filters::RelativeSegmentFilter:

Public Types
typedef core::Real	Real
typedef core::Size	Size

Public Member Functions
	RelativeSegmentFilter ()
bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
protocols::filters::FilterOP	clone () const override
protocols::filters::FilterOP	fresh_instance () const override
void	report (std::ostream &out, core::pose::Pose const &pose) const override
core::Real	report_sm (core::pose::Pose const &pose) const override
	used to report filter internals through a score or silent file More...
	~RelativeSegmentFilter () override
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...
std::string	source_pose () const
void	source_pose (std::string const &s)
core::Size	start_res () const
void	start_res (core::Size const s)
core::Size	stop_res () const
void	stop_res (core::Size const s)
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
std::string	source_pose_
core::Size	start_res_
core::Size	stop_res_

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

Detailed Description

returns the residues aligned to a segment on the input pdb to the source pdb

Member Typedef Documentation

Real

typedef core::Real protocols::protein_interface_design::filters::RelativeSegmentFilter::Real

Size

typedef core::Size protocols::protein_interface_design::filters::RelativeSegmentFilter::Size

Constructor & Destructor Documentation

RelativeSegmentFilter()

protocols::protein_interface_design::filters::RelativeSegmentFilter::RelativeSegmentFilter ( )

inline

~RelativeSegmentFilter()

protocols::protein_interface_design::filters::RelativeSegmentFilter::~RelativeSegmentFilter ( )

overridedefault

Member Function Documentation

apply()

bool protocols::protein_interface_design::filters::RelativeSegmentFilter::apply ( core::pose::Pose const &  pose ) const

overridevirtual

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

Implements protocols::filters::Filter.

References protocols::rosetta_scripts::find_nearest_res(), core::import_pose::PDB_file, core::import_pose::pose_from_file(), core::pose::Pose::size(), source_pose(), source_pose_, start_res(), stop_res(), and protocols::protein_interface_design::filters::TR().

class_name()

std::string protocols::protein_interface_design::filters::RelativeSegmentFilter::class_name ( )

static

Referenced by protocols::protein_interface_design::filters::RelativeSegmentFilterCreator::keyname(), name(), and provide_xml_schema().

clone()

protocols::filters::FilterOP protocols::protein_interface_design::filters::RelativeSegmentFilter::clone ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

fresh_instance()

protocols::filters::FilterOP protocols::protein_interface_design::filters::RelativeSegmentFilter::fresh_instance ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

std::string protocols::protein_interface_design::filters::RelativeSegmentFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::protein_interface_design::filters::RelativeSegmentFilter::parse_my_tag ( utility::tag::TagCOP  , basic::datacache::DataMap &    )

overridevirtual

Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing.

Reimplemented from protocols::filters::Filter.

References source_pose(), start_res(), stop_res(), and protocols::protein_interface_design::filters::TR().

provide_xml_schema()

void protocols::protein_interface_design::filters::RelativeSegmentFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

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

Referenced by protocols::protein_interface_design::filters::RelativeSegmentFilterCreator::provide_xml_schema().

report()

void protocols::protein_interface_design::filters::RelativeSegmentFilter::report ( std::ostream &  out, core::pose::Pose const &  pose  ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

report_sm()

core::Real protocols::protein_interface_design::filters::RelativeSegmentFilter::report_sm ( core::pose::Pose const &  ) const

overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

source_pose() [1/2]

std::string protocols::protein_interface_design::filters::RelativeSegmentFilter::source_pose ( ) const

inline

References source_pose_.

Referenced by apply(), and parse_my_tag().

source_pose() [2/2]

void protocols::protein_interface_design::filters::RelativeSegmentFilter::source_pose ( std::string const &  s )

inline

References source_pose_.

start_res() [1/2]

core::Size protocols::protein_interface_design::filters::RelativeSegmentFilter::start_res ( ) const

inline

References start_res_.

Referenced by apply(), and parse_my_tag().

start_res() [2/2]

void protocols::protein_interface_design::filters::RelativeSegmentFilter::start_res ( core::Size const  s )

inline

References start_res_.

stop_res() [1/2]

core::Size protocols::protein_interface_design::filters::RelativeSegmentFilter::stop_res ( ) const

inline

References stop_res_.

Referenced by apply(), and parse_my_tag().

stop_res() [2/2]

void protocols::protein_interface_design::filters::RelativeSegmentFilter::stop_res ( core::Size const  s )

inline

References stop_res_.

Member Data Documentation

source_pose_

std::string protocols::protein_interface_design::filters::RelativeSegmentFilter::source_pose_

private

Referenced by apply(), and source_pose().

start_res_

core::Size protocols::protein_interface_design::filters::RelativeSegmentFilter::start_res_

private

Referenced by start_res().

stop_res_

core::Size protocols::protein_interface_design::filters::RelativeSegmentFilter::stop_res_

private

Referenced by stop_res().

---

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

• src/protocols/protein_interface_design/filters/RelativeSegmentFilter.hh
• src/protocols/protein_interface_design/filters/RelativeSegmentFilter.cc