Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
protocols::simple_filters::PackerNeighborGraphFilter Class Reference

#include <PackerNeighborGraphFilter.hh>

Inheritance diagram for protocols::simple_filters::PackerNeighborGraphFilter:
Inheritance graph
[legend]

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 (Filter 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 bool filter_provides_citation_info () const
 Does this filter provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool filter_is_unpublished () const
 Does this filter indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Private Attributes

core::pack::task::PackerTaskCOP task_
 
core::scoring::ScoreFunctionCOP sfxn_
 
std::map< core::Size, core::Sizerequired_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

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

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

filters::FilterOP protocols::simple_filters::PackerNeighborGraphFilter::clone ( ) const
inlineoverridevirtual
filters::FilterOP protocols::simple_filters::PackerNeighborGraphFilter::fresh_instance ( ) const
inlineoverridevirtual
std::string protocols::simple_filters::PackerNeighborGraphFilter::name ( ) const
inlineoverridevirtual

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
std::map< core::Size, core::Size > protocols::simple_filters::PackerNeighborGraphFilter::required_connections_per_res_
private
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().


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