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

#include <InterfaceSasaFilter.hh>

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

Public Member Functions

 InterfaceSasaFilter ()
 
 InterfaceSasaFilter (core::Real const lower_threshold, bool const hydrophobic=false, bool const polar=false, core::Real const upper_threshold=100000000.0, std::string const &sym_dof_names="")
 
bool apply (core::pose::Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. More...
 
void report (std::ostream &out, core::pose::Pose const &pose) const override
 
core::Real report_sm (core::pose::Pose const &pose) const override
 used to report filter internals through a score or silent file More...
 
core::Real compute (core::pose::Pose const &pose) const
 
filters::FilterOP clone () const override
 
filters::FilterOP fresh_instance () const override
 
 ~InterfaceSasaFilter () override
 
void jump (core::Size const jump)
 
void add_jump (core::Size const jump)
 
void jumps (utility::vector1< core::Size > const &jumps)
 
void sym_dof_names (std::string const &sym_dof_names)
 
void sym_dof_names (utility::vector1< std::string > const &sym_dof_names)
 
void add_sym_dof_name (std::string const &sym_dof_name)
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. 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

core::Real lower_threshold_
 
core::Real upper_threshold_
 
bool hydrophobic_
 
bool polar_
 
utility::vector1< core::Sizejumps_
 count only hydrophobics? polars? More...
 
utility::vector1< std::string > sym_dof_names_
 

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::simple_filters::InterfaceSasaFilter::InterfaceSasaFilter ( )

References jump().

protocols::simple_filters::InterfaceSasaFilter::InterfaceSasaFilter ( core::Real const  lower_threshold,
bool const  hydrophobic = false,
bool const  polar = false,
core::Real const  upper_threshold = 100000000.0,
std::string const &  sym_dof_names = "" 
)

References jump(), and sym_dof_names().

protocols::simple_filters::InterfaceSasaFilter::~InterfaceSasaFilter ( )
overridedefault

Member Function Documentation

void protocols::simple_filters::InterfaceSasaFilter::add_jump ( core::Size const  jump)

References jumps_.

void protocols::simple_filters::InterfaceSasaFilter::add_sym_dof_name ( std::string const &  sym_dof_name)

References sym_dof_names_.

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

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

Implements protocols::filters::Filter.

References compute(), lower_threshold_, protocols::simple_filters::TR(), and upper_threshold_.

std::string protocols::simple_filters::InterfaceSasaFilter::class_name ( )
static
filters::FilterOP protocols::simple_filters::InterfaceSasaFilter::clone ( ) const
overridevirtual
core::Real protocols::simple_filters::InterfaceSasaFilter::compute ( core::pose::Pose const &  pose) const
filters::FilterOP protocols::simple_filters::InterfaceSasaFilter::fresh_instance ( ) const
overridevirtual
void protocols::simple_filters::InterfaceSasaFilter::jump ( core::Size const  jump)

References jumps_, and sym_dof_names_.

Referenced by compute(), and InterfaceSasaFilter().

void protocols::simple_filters::InterfaceSasaFilter::jumps ( utility::vector1< core::Size > const &  jumps)
std::string protocols::simple_filters::InterfaceSasaFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

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

Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing.

Reimplemented from protocols::filters::Filter.

References hydrophobic_, jumps_, lower_threshold_, polar_, sym_dof_names_, protocols::simple_filters::TR(), and upper_threshold_.

void protocols::simple_filters::InterfaceSasaFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::simple_filters::InterfaceSasaFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::simple_filters::InterfaceSasaFilter::report_sm ( core::pose::Pose const &  ) const
overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

void protocols::simple_filters::InterfaceSasaFilter::sym_dof_names ( std::string const &  sym_dof_names)
void protocols::simple_filters::InterfaceSasaFilter::sym_dof_names ( utility::vector1< std::string > const &  sym_dof_names)

References sym_dof_names(), and sym_dof_names_.

Member Data Documentation

bool protocols::simple_filters::InterfaceSasaFilter::hydrophobic_
private

Referenced by compute(), and parse_my_tag().

utility::vector1<core::Size> protocols::simple_filters::InterfaceSasaFilter::jumps_
private

count only hydrophobics? polars?

Referenced by add_jump(), compute(), jump(), jumps(), parse_my_tag(), and sym_dof_names().

core::Real protocols::simple_filters::InterfaceSasaFilter::lower_threshold_
private

Referenced by apply(), and parse_my_tag().

bool protocols::simple_filters::InterfaceSasaFilter::polar_
private

Referenced by compute(), and parse_my_tag().

utility::vector1<std::string> protocols::simple_filters::InterfaceSasaFilter::sym_dof_names_
private
core::Real protocols::simple_filters::InterfaceSasaFilter::upper_threshold_
private

Referenced by apply(), and parse_my_tag().


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