protocols::simple_filters::PackerNeighborGraphFilter Class Reference

#include <PackerNeighborGraphFilter.hh>

Inheritance diagram for protocols::simple_filters::PackerNeighborGraphFilter:

Public Member Functions
	PackerNeighborGraphFilter (core::pack::task::PackerTaskCOP task, core::scoring::ScoreFunctionCOP sfxn)
	PackerNeighborGraphFilter ()
	~PackerNeighborGraphFilter () override
filters::FilterOP	clone () const override
filters::FilterOP	fresh_instance () const override
bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
std::string	name () const override
void	set_task (core::pack::task::PackerTaskCOP task)
void	set_required_connections_for_residue (core::Size residue, core::Size required_connections)
	note: will overwrite if information for this residue has already been entered More...
void	add_required_connection_for_residue (core::Size residue)
	note: will increase required connections for this residue by 1 More...
void	add_required_connections_between_regions (std::set< core::Size > const &region1, std::set< core::Size > const &region2, core::Size required_connections)
Public Member Functions inherited from protocols::filters::Filter
	Filter ()
	Filter (std::string 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 void	parse_my_tag (utility::tag::TagCOP, basic::datacache::DataMap &)
	Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. 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...

Private Attributes
core::pack::task::PackerTaskCOP	task_
core::scoring::ScoreFunctionCOP	sfxn_
std::map< core::Size, core::Size >	required_connections_per_res_
utility::vector1< RegionalConnections >	required_connections_between_regions_

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

Detailed Description

filter that creates a packer neighbor graph of the pose

in every apply function and returns true if this graph

satisfies a specified connectivity

Constructor & Destructor Documentation

PackerNeighborGraphFilter() [1/2]

protocols::simple_filters::PackerNeighborGraphFilter::PackerNeighborGraphFilter ( core::pack::task::PackerTaskCOP  task, core::scoring::ScoreFunctionCOP  sfxn  )

inline

PackerNeighborGraphFilter() [2/2]

protocols::simple_filters::PackerNeighborGraphFilter::PackerNeighborGraphFilter

(

)

References required_connections_between_regions_, and required_connections_per_res_.

~PackerNeighborGraphFilter()

protocols::simple_filters::PackerNeighborGraphFilter::~PackerNeighborGraphFilter ( )

overridedefault

Member Function Documentation

add_required_connection_for_residue()

void protocols::simple_filters::PackerNeighborGraphFilter::add_required_connection_for_residue

(

core::Size

residue

)

note: will increase required connections for this residue by 1

References required_connections_per_res_.

add_required_connections_between_regions()

void protocols::simple_filters::PackerNeighborGraphFilter::add_required_connections_between_regions	(	std::set< core::Size > const &	region1,
		std::set< core::Size > const &	region2,
		core::Size	required_connections
	)

References required_connections_between_regions_.

apply()

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

overridevirtual

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

Implements protocols::filters::Filter.

References core::pack::create_packer_graph(), required_connections_between_regions_, required_connections_per_res_, sfxn_, and task_.

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

inlineoverridevirtual

Reimplemented from protocols::filters::Filter.

set_required_connections_for_residue()

void protocols::simple_filters::PackerNeighborGraphFilter::set_required_connections_for_residue	(	core::Size	residue,
		core::Size	required_connections
	)

note: will overwrite if information for this residue has already been entered

References required_connections_per_res_.

set_task()

void protocols::simple_filters::PackerNeighborGraphFilter::set_task ( core::pack::task::PackerTaskCOP  task )

inline

References task_.

Member Data Documentation

required_connections_between_regions_

utility::vector1< RegionalConnections > protocols::simple_filters::PackerNeighborGraphFilter::required_connections_between_regions_

private

Referenced by add_required_connections_between_regions(), apply(), and PackerNeighborGraphFilter().

required_connections_per_res_

std::map< core::Size, core::Size > protocols::simple_filters::PackerNeighborGraphFilter::required_connections_per_res_

private

Referenced by add_required_connection_for_residue(), apply(), PackerNeighborGraphFilter(), and set_required_connections_for_residue().

sfxn_

core::scoring::ScoreFunctionCOP protocols::simple_filters::PackerNeighborGraphFilter::sfxn_

private

Referenced by apply().

task_

core::pack::task::PackerTaskCOP protocols::simple_filters::PackerNeighborGraphFilter::task_

private

Referenced by apply(), and set_task().

---

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

• src/protocols/simple_filters/PackerNeighborGraphFilter.hh
• src/protocols/simple_filters/PackerNeighborGraphFilter.cc