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

Used to combine multiple seperate filters into a single filter value. More...

#include <BasicFilters.hh>

Inheritance diagram for protocols::filters::CombinedFilter:
Inheritance graph
[legend]
Collaboration diagram for protocols::filters::CombinedFilter:
Collaboration graph
[legend]

Public Types

typedef std::pair< FilterOP,
core::Real
FilterWeightPair
 
typedef utility::vector1
< FilterWeightPair
FilterList
 

Public Member Functions

 CombinedFilter ()
 
virtual ~CombinedFilter ()
 
bool apply (core::pose::Pose const &) const
 Returns true if the given pose passes the filter, false otherwise. More...
 
FilterOP clone () const
 
FilterOP fresh_instance () const
 
void report (std::ostream &, core::pose::Pose const &) const
 
core::Real report_sm (core::pose::Pose const &) const
 used to report filter internals through a score or silent file More...
 
core::Real compute (core::pose::Pose const &) const
 
void parse_my_tag (utility::tag::TagPtr const, moves::DataMap &, Filters_map const &, moves::Movers_map const &, core::pose::Pose const &)
 
- 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::Real threshold_
 
FilterList filterlist_
 

Additional Inherited Members

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

Detailed Description

Used to combine multiple seperate filters into a single filter value.

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::filters::CombinedFilter::CombinedFilter ( )

Referenced by clone(), and fresh_instance().

protocols::filters::CombinedFilter::~CombinedFilter ( )
virtual

Member Function Documentation

bool protocols::filters::CombinedFilter::apply ( core::pose::Pose const &  pose) const
virtual

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

Implements protocols::filters::Filter.

References compute(), threshold_, and protocols::filters::TR().

FilterOP protocols::filters::CombinedFilter::clone ( ) const
virtual
core::Real protocols::filters::CombinedFilter::compute ( core::pose::Pose const &  pose) const

References filterlist_.

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

FilterOP protocols::filters::CombinedFilter::fresh_instance ( ) const
virtual
void protocols::filters::CombinedFilter::parse_my_tag ( utility::tag::TagPtr const  tag,
moves::DataMap ,
Filters_map const &  filters,
moves::Movers_map const &  ,
core::pose::Pose const &   
)
virtual
void protocols::filters::CombinedFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
virtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::filters::CombinedFilter::report_sm ( core::pose::Pose const &  ) const
virtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

Member Data Documentation

FilterList protocols::filters::CombinedFilter::filterlist_
private

Referenced by compute(), and parse_my_tag().

core::Real protocols::filters::CombinedFilter::threshold_
private

Referenced by apply(), and parse_my_tag().


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