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

#include <ResidueBurialFilter.hh>

Inheritance diagram for protocols::simple_filters::ResidueBurialFilter:
Inheritance graph
[legend]
Collaboration diagram for protocols::simple_filters::ResidueBurialFilter:
Collaboration graph
[legend]

Public Member Functions

 ResidueBurialFilter ()
 
 ResidueBurialFilter (core::Size const target_residue, core::Size const neighbors, core::Real const distance_threshold)
 
bool apply (core::pose::Pose const &pose) const
 Returns true if the given pose passes the filter, false otherwise. More...
 
void report (std::ostream &out, core::pose::Pose const &pose) const
 
core::Real report_sm (core::pose::Pose const &pose) const
 used to report filter internals through a score or silent file More...
 
core::Size compute (core::pose::Pose const &pose) const
 
filters::FilterOP clone () const
 
filters::FilterOP fresh_instance () const
 
core::pack::task::TaskFactoryOP task_factory () const
 
void task_factory (core::pack::task::TaskFactoryOP tf)
 
virtual ~ResidueBurialFilter ()
 
void parse_my_tag (utility::tag::TagPtr const tag, protocols::moves::DataMap &, filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)
 
core::Real residue_fraction_buried () const
 
void residue_fraction_buried (core::Real const r)
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
virtual ~Filter ()
 
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 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)
 
virtual std::string name () const
 

Private Attributes

core::Size target_residue_
 
core::Size neighbors_
 
core::Real distance_threshold_
 
core::pack::task::TaskFactoryOP task_factory_
 
core::Real residue_fraction_buried_
 used to determine which residues to check for burial dynamically. All designable residues will be checked, and if any of them is buried, returns true More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 28 of file ResidueBurialFilter.hh.

Constructor & Destructor Documentation

protocols::simple_filters::ResidueBurialFilter::ResidueBurialFilter ( )

Definition at line 36 of file ResidueBurialFilter.cc.

Referenced by clone(), and fresh_instance().

protocols::simple_filters::ResidueBurialFilter::ResidueBurialFilter ( core::Size const  target_residue,
core::Size const  neighbors,
core::Real const  distance_threshold 
)

Definition at line 43 of file ResidueBurialFilter.cc.

protocols::simple_filters::ResidueBurialFilter::~ResidueBurialFilter ( )
virtual

Definition at line 56 of file ResidueBurialFilter.cc.

Member Function Documentation

bool protocols::simple_filters::ResidueBurialFilter::apply ( core::pose::Pose const &  pose) const
virtual
filters::FilterOP protocols::simple_filters::ResidueBurialFilter::clone ( ) const
virtual

Implements protocols::filters::Filter.

Definition at line 147 of file ResidueBurialFilter.cc.

References ResidueBurialFilter().

core::Size protocols::simple_filters::ResidueBurialFilter::compute ( core::pose::Pose const &  pose) const
filters::FilterOP protocols::simple_filters::ResidueBurialFilter::fresh_instance ( ) const
virtual

Implements protocols::filters::Filter.

Definition at line 152 of file ResidueBurialFilter.cc.

References ResidueBurialFilter().

void protocols::simple_filters::ResidueBurialFilter::parse_my_tag ( utility::tag::TagPtr const  tag,
protocols::moves::DataMap data,
filters::Filters_map const &  ,
protocols::moves::Movers_map const &  ,
core::pose::Pose const &  pose 
)
virtual

Reimplemented from protocols::filters::Filter.

Definition at line 139 of file parse_filters.cc.

References core::pose::get_resnum(), and core::TR().

void protocols::simple_filters::ResidueBurialFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
virtual
core::Real protocols::simple_filters::ResidueBurialFilter::report_sm ( core::pose::Pose const &  ) const
virtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

Definition at line 115 of file ResidueBurialFilter.cc.

References compute(), and task_factory().

core::Real protocols::simple_filters::ResidueBurialFilter::residue_fraction_buried ( ) const
inline

Definition at line 44 of file ResidueBurialFilter.hh.

References residue_fraction_buried_.

Referenced by apply().

void protocols::simple_filters::ResidueBurialFilter::residue_fraction_buried ( core::Real const  r)
inline

Definition at line 45 of file ResidueBurialFilter.hh.

References residue_fraction_buried_.

core::pack::task::TaskFactoryOP protocols::simple_filters::ResidueBurialFilter::task_factory ( ) const

Definition at line 64 of file ResidueBurialFilter.cc.

References task_factory_.

Referenced by apply(), report(), and report_sm().

void protocols::simple_filters::ResidueBurialFilter::task_factory ( core::pack::task::TaskFactoryOP  tf)

Definition at line 59 of file ResidueBurialFilter.cc.

References task_factory_.

Member Data Documentation

core::Real protocols::simple_filters::ResidueBurialFilter::distance_threshold_
private

Definition at line 49 of file ResidueBurialFilter.hh.

Referenced by apply(), and compute().

core::Size protocols::simple_filters::ResidueBurialFilter::neighbors_
private

Definition at line 48 of file ResidueBurialFilter.hh.

Referenced by apply().

core::Real protocols::simple_filters::ResidueBurialFilter::residue_fraction_buried_
private

used to determine which residues to check for burial dynamically. All designable residues will be checked, and if any of them is buried, returns true

Definition at line 51 of file ResidueBurialFilter.hh.

Referenced by residue_fraction_buried().

core::Size protocols::simple_filters::ResidueBurialFilter::target_residue_
private

Definition at line 47 of file ResidueBurialFilter.hh.

Referenced by apply(), compute(), and report().

core::pack::task::TaskFactoryOP protocols::simple_filters::ResidueBurialFilter::task_factory_
private

Definition at line 50 of file ResidueBurialFilter.hh.

Referenced by task_factory().


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