Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::fldsgn::filters::InterlockingAromaFilter Class Reference

#include <InterlockingAromaFilter.hh>

Inheritance diagram for protocols::fldsgn::filters::InterlockingAromaFilter:
Inheritance graph

Public Types

typedef protocols::filters::Filter Super
typedef protocols::filters::Filter Filter
typedef core::Real Real
typedef core::pose::Pose Pose
typedef std::string String
typedef utility::tag::TagCOP TagCOP
typedef basic::datacache::DataMap DataMap

Public Member Functions

 InterlockingAromaFilter ()
 InterlockingAromaFilter (String const &type)
 InterlockingAromaFilter (InterlockingAromaFilter const &rval)
 ~InterlockingAromaFilter () override
FilterOP clone () const override
FilterOP fresh_instance () const override
void filter_value (Real const value)
void contact_distance (Real const value)
void verbose (bool const b)
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
 parse xml More...
bool apply (Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. More...
Real report_sm (Pose const &pose) const override
 used to report filter internals through a score or silent file More...
void report (std::ostream &out, Pose const &pose) const override
 used to report score More...
Real compute (Pose const &pose) const
 compute this filter More...
bool compute (core::Size const &res, Pose const &pose, SS_Info2_COP const ssinfo) const
 compute this filter for a give residue 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 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 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...

Static Public Member Functions

static std::string class_name ()
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes

Real filter_value_
Real contact_dist2_
String input_ss_
bool verbose_

Additional Inherited Members

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

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::fldsgn::filters::InterlockingAromaFilter::InterlockingAromaFilter ( )
protocols::fldsgn::filters::InterlockingAromaFilter::InterlockingAromaFilter ( String const &  type)
protocols::fldsgn::filters::InterlockingAromaFilter::InterlockingAromaFilter ( InterlockingAromaFilter const &  rval)
protocols::fldsgn::filters::InterlockingAromaFilter::~InterlockingAromaFilter ( )

Member Function Documentation

bool protocols::fldsgn::filters::InterlockingAromaFilter::apply ( Pose const &  pose) const

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

Implements protocols::filters::Filter.

References compute(), filter_value_, and tr().

std::string protocols::fldsgn::filters::InterlockingAromaFilter::class_name ( )
FilterOP protocols::fldsgn::filters::InterlockingAromaFilter::clone ( ) const
InterlockingAromaFilter::Real protocols::fldsgn::filters::InterlockingAromaFilter::compute ( Pose const &  pose) const
bool protocols::fldsgn::filters::InterlockingAromaFilter::compute ( core::Size const &  res,
Pose const &  pose,
SS_Info2_COP const  ssinfo 
) const
void protocols::fldsgn::filters::InterlockingAromaFilter::contact_distance ( Real const  value)
void protocols::fldsgn::filters::InterlockingAromaFilter::filter_value ( Real const  value)

References filter_value_.

Referenced by parse_my_tag().

FilterOP protocols::fldsgn::filters::InterlockingAromaFilter::fresh_instance ( ) const
std::string protocols::fldsgn::filters::InterlockingAromaFilter::name ( ) const

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::fldsgn::filters::InterlockingAromaFilter::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap &   
void protocols::fldsgn::filters::InterlockingAromaFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
void protocols::fldsgn::filters::InterlockingAromaFilter::report ( std::ostream &  out,
Pose const &  pose 
) const

used to report score

Reimplemented from protocols::filters::Filter.

References compute().

InterlockingAromaFilter::Real protocols::fldsgn::filters::InterlockingAromaFilter::report_sm ( Pose const &  ) const

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

void protocols::fldsgn::filters::InterlockingAromaFilter::verbose ( bool const  b)

Member Data Documentation

Real protocols::fldsgn::filters::InterlockingAromaFilter::contact_dist2_

Referenced by compute(), and contact_distance().

Real protocols::fldsgn::filters::InterlockingAromaFilter::filter_value_

Referenced by apply(), and filter_value().

String protocols::fldsgn::filters::InterlockingAromaFilter::input_ss_

Referenced by compute(), and parse_my_tag().

bool protocols::fldsgn::filters::InterlockingAromaFilter::verbose_

Referenced by parse_my_tag(), and verbose().

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