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::DomainInterfaceFilter Class Reference

#include <DomainInterfaceFilter.hh>

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

Public Member Functions

 DomainInterfaceFilter ()
 
 DomainInterfaceFilter (DomainInterfaceFilter const &)
 
 ~DomainInterfaceFilter () override
 
std::string const & query_region_string ()
 
std::string const & target_region_string ()
 
std::set< core::Size > const & query_region ()
 
std::set< core::Size > const & target_region ()
 
void query_region (std::set< core::Size > &region)
 
void target_region (std::set< core::Size > &region)
 
void query_region_string (std::string const &region_str)
 
void target_region_string (std::string const &region_str)
 
core::Real cb_dist_cut () const
 
core::Real nearby_atom_cut () const
 
core::Real vector_angle_cut () const
 
core::Real vector_dist_cut () const
 
void cb_dist_cut (core::Real setting)
 
void nearby_atom_cut (core::Real setting)
 
void vector_angle_cut (core::Real setting)
 
void vector_dist_cut (core::Real setting)
 
std::string get_type () const override
 
std::string get_user_defined_name () const
 
void set_user_defined_name (std::string const &name)
 
void parse_my_tag (utility::tag::TagCOP, basic::datacache::DataMap &) override
 used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...
 
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
 
- 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...
 
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 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

std::string const type_
 
std::string user_defined_name_
 
core::Real cb_dist_cut_
 
core::Real nearby_atom_cut_
 
core::Real vector_angle_cut_
 
core::Real vector_dist_cut_
 
std::set< core::Sizequery_region_
 
std::set< core::Sizetarget_region_
 
std::string query_region_str_
 
std::string target_region_str_
 

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Constructor & Destructor Documentation

protocols::simple_filters::DomainInterfaceFilter::DomainInterfaceFilter ( )
protocols::simple_filters::DomainInterfaceFilter::DomainInterfaceFilter ( DomainInterfaceFilter const &  src)
protocols::simple_filters::DomainInterfaceFilter::~DomainInterfaceFilter ( )
overridedefault

Member Function Documentation

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

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

Returns true if the given pose passes the filter, false otherwise. Pose passes the filter if ALL query residues are part of an interface with ANY of the target residues.

Implements protocols::filters::Filter.

References core::select::util::calc_interacting_vector(), cb_dist_cut_, core::pose::get_resnum_list(), nearby_atom_cut_, query_region_, query_region_str_, core::pose::Pose::size(), target_region_, target_region_str_, vector_angle_cut_, and vector_dist_cut_.

core::Real protocols::simple_filters::DomainInterfaceFilter::cb_dist_cut ( ) const

References cb_dist_cut_.

Referenced by parse_my_tag().

void protocols::simple_filters::DomainInterfaceFilter::cb_dist_cut ( core::Real  setting)

References cb_dist_cut_.

filters::FilterOP protocols::simple_filters::DomainInterfaceFilter::clone ( ) const
overridevirtual
filters::FilterOP protocols::simple_filters::DomainInterfaceFilter::fresh_instance ( ) const
overridevirtual
std::string protocols::simple_filters::DomainInterfaceFilter::get_type ( ) const
inlineoverridevirtual

Reimplemented from protocols::filters::Filter.

References type_.

std::string protocols::simple_filters::DomainInterfaceFilter::get_user_defined_name ( ) const
inline

References user_defined_name_.

std::string protocols::simple_filters::DomainInterfaceFilter::name ( ) const
inlineoverridevirtual

Reimplemented from protocols::filters::Filter.

Referenced by set_user_defined_name().

core::Real protocols::simple_filters::DomainInterfaceFilter::nearby_atom_cut ( ) const

References nearby_atom_cut_.

Referenced by parse_my_tag().

void protocols::simple_filters::DomainInterfaceFilter::nearby_atom_cut ( core::Real  setting)

References nearby_atom_cut_.

void protocols::simple_filters::DomainInterfaceFilter::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &   
)
overridevirtual

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

Reimplemented from protocols::filters::Filter.

References cb_dist_cut(), nearby_atom_cut(), query_region_string(), target_region_string(), vector_angle_cut(), and vector_dist_cut().

std::set< core::Size > const & protocols::simple_filters::DomainInterfaceFilter::query_region ( )

References query_region_.

void protocols::simple_filters::DomainInterfaceFilter::query_region ( std::set< core::Size > &  region)

References query_region_.

std::string const & protocols::simple_filters::DomainInterfaceFilter::query_region_string ( )

References query_region_str_.

Referenced by parse_my_tag().

void protocols::simple_filters::DomainInterfaceFilter::query_region_string ( std::string const &  region_str)

References query_region_str_.

void protocols::simple_filters::DomainInterfaceFilter::set_user_defined_name ( std::string const &  name)
inline

References name(), and user_defined_name_.

std::set< core::Size > const & protocols::simple_filters::DomainInterfaceFilter::target_region ( )

References target_region_.

void protocols::simple_filters::DomainInterfaceFilter::target_region ( std::set< core::Size > &  region)

References target_region_.

std::string const & protocols::simple_filters::DomainInterfaceFilter::target_region_string ( )

References target_region_str_.

Referenced by parse_my_tag().

void protocols::simple_filters::DomainInterfaceFilter::target_region_string ( std::string const &  region_str)

References target_region_str_.

core::Real protocols::simple_filters::DomainInterfaceFilter::vector_angle_cut ( ) const

References vector_angle_cut_.

Referenced by parse_my_tag().

void protocols::simple_filters::DomainInterfaceFilter::vector_angle_cut ( core::Real  setting)

References vector_angle_cut_.

core::Real protocols::simple_filters::DomainInterfaceFilter::vector_dist_cut ( ) const

References vector_dist_cut_.

Referenced by parse_my_tag().

void protocols::simple_filters::DomainInterfaceFilter::vector_dist_cut ( core::Real  setting)

References vector_dist_cut_.

Member Data Documentation

core::Real protocols::simple_filters::DomainInterfaceFilter::cb_dist_cut_
private

Referenced by apply(), and cb_dist_cut().

core::Real protocols::simple_filters::DomainInterfaceFilter::nearby_atom_cut_
private

Referenced by apply(), and nearby_atom_cut().

std::set< core::Size > protocols::simple_filters::DomainInterfaceFilter::query_region_
private

Referenced by apply(), and query_region().

std::string protocols::simple_filters::DomainInterfaceFilter::query_region_str_
private

Referenced by apply(), and query_region_string().

std::set< core::Size > protocols::simple_filters::DomainInterfaceFilter::target_region_
private

Referenced by apply(), and target_region().

std::string protocols::simple_filters::DomainInterfaceFilter::target_region_str_
private

Referenced by apply(), and target_region_string().

std::string const protocols::simple_filters::DomainInterfaceFilter::type_
private

Referenced by get_type().

std::string protocols::simple_filters::DomainInterfaceFilter::user_defined_name_
private
core::Real protocols::simple_filters::DomainInterfaceFilter::vector_angle_cut_
private

Referenced by apply(), and vector_angle_cut().

core::Real protocols::simple_filters::DomainInterfaceFilter::vector_dist_cut_
private

Referenced by apply(), and vector_dist_cut().


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