#include <PackerNeighborGraphFilter.hh>

Inheritance diagram for protocols::simple_filters::PackerNeighborGraphFilter:

Collaboration diagram for protocols::simple_filters::PackerNeighborGraphFilter:

Public Member Functions
	PackerNeighborGraphFilter (core::pack::task::PackerTaskCOP task, core::scoring::ScoreFunctionCOP sfxn)

	PackerNeighborGraphFilter ()

	~PackerNeighborGraphFilter ()

filters::FilterOP	clone () const

filters::FilterOP	fresh_instance () const

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

virtual std::string	name () const

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 (Filter const &)

virtual	~Filter ()

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::TagPtr const, moves::DataMap &, Filters_map const &, moves::Movers_map const &, core::pose::Pose const &)

virtual void	apply (core::io::serialization::PipeMap &pmap)

virtual void	score (core::io::serialization::PipeMap &pmap)

virtual core::Real	score (core::pose::Pose &pose)

virtual void	parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks)

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_

bool	task_invalidated_

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

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

inline

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

References required_connections_between_regions_, and required_connections_per_res_.

Referenced by clone(), and fresh_instance().

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

Member Function Documentation

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

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

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

virtual

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

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

inlinevirtual

Implements protocols::filters::Filter.

References PackerNeighborGraphFilter().

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

inlinevirtual

Implements protocols::filters::Filter.

References PackerNeighborGraphFilter().

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

inlinevirtual

Reimplemented from protocols::filters::Filter.

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

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

inline

References task_.

Member Data Documentation

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

private

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

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

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

private

Referenced by apply().

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

private

Referenced by apply(), and set_task().

bool protocols::simple_filters::PackerNeighborGraphFilter::task_invalidated_

private

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation