Rosetta: protocols::simple_filters::NeighborTypeFilter Class Reference

Rosetta

#include <NeighborTypeFilter.hh>

Inheritance diagram for protocols::simple_filters::NeighborTypeFilter:

Inheritance graph

[legend]

Public Member Functions
	NeighborTypeFilter ()

	NeighborTypeFilter (std::string const &target_residue, utility::vector1< bool > const &residue_types, core::Real const distance_threshold)

bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...

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

std::vector< core::Size >	compute (core::pose::Pose const &pose) const

filters::FilterOP	clone () const override

filters::FilterOP	fresh_instance () const override

void	clear () override
	used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...

	~NeighborTypeFilter () 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	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 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	target_residue_

utility::vector1< bool >	residue_types_

core::Real	distance_threshold_

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

Constructor & Destructor Documentation

◆ NeighborTypeFilter() [1/2]

protocols::simple_filters::NeighborTypeFilter::NeighborTypeFilter ( )

inline

◆ NeighborTypeFilter() [2/2]

protocols::simple_filters::NeighborTypeFilter::NeighborTypeFilter	(	std::string const &	target_residue,
		utility::vector1< bool > const &	residue_types,
		core::Real const	distance_threshold
	)

inline

◆ ~NeighborTypeFilter()

protocols::simple_filters::NeighborTypeFilter::~NeighborTypeFilter ( )

overridedefault

Member Function Documentation

◆ apply()

bool protocols::simple_filters::NeighborTypeFilter::apply ( core::pose::Pose const & pose ) const

overridevirtual

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

Implements protocols::filters::Filter.

References compute(), core::conformation::Residue::name3(), protocols::simple_filters::neighbor_type_filter_tracer(), core::pose::Pose::residue(), and target_residue_.

◆ class_name()

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

static

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

◆ clear()

void protocols::simple_filters::NeighborTypeFilter::clear ( )

inlineoverridevirtual

used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual

Reimplemented from protocols::filters::Filter.

References residue_types_.

◆ clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

std::vector< core::Size > protocols::simple_filters::NeighborTypeFilter::compute ( core::pose::Pose const & pose ) const

References core::conformation::Residue::aa(), core::conformation::Conformation::chain_begin(), core::pose::Pose::conformation(), core::kinematics::distance(), distance_threshold_, core::sequence::end, core::conformation::Residue::nbr_atom(), core::pose::parse_resnum(), core::pose::Pose::residue(), residue_types_, core::pose::Pose::size(), protocols::loops::start, target_residue_, and core::conformation::Residue::xyz().

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

◆ fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::NeighborTypeFilter::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 core::chemical::aa_from_name(), distance_threshold_, core::pose::get_resnum_string(), protocols::simple_filters::neighbor_type_filter_tracer(), core::chemical::num_canonical_aas, residue_types_, and target_residue_.

◆ provide_xml_schema()

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

static

References core::pose::attributes_for_get_resnum_string(), class_name(), protocols::filters::complex_type_name_for_filter(), and protocols::simple_filters::NeighborType_subelement_ct_name().

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

◆ report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), core::conformation::Residue::name3(), core::conformation::membrane::out, core::pose::Pose::residue(), and target_residue_.

◆ report_sm()

core::Real protocols::simple_filters::NeighborTypeFilter::report_sm ( core::pose::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

◆ distance_threshold_

core::Real protocols::simple_filters::NeighborTypeFilter::distance_threshold_

private

Referenced by compute(), and parse_my_tag().

◆ residue_types_

utility::vector1< bool > protocols::simple_filters::NeighborTypeFilter::residue_types_

private

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

◆ target_residue_

std::string protocols::simple_filters::NeighborTypeFilter::target_residue_

private

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

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

src/protocols/simple_filters/NeighborTypeFilter.hh
src/protocols/simple_filters/NeighborTypeFilter.cc