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:

Collaboration diagram for protocols::filters::CombinedFilter:

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.

Definition at line 121 of file BasicFilters.hh.

Member Typedef Documentation

typedef utility::vector1< FilterWeightPair > protocols::filters::CombinedFilter::FilterList

Definition at line 125 of file BasicFilters.hh.

typedef std::pair< FilterOP, core::Real > protocols::filters::CombinedFilter::FilterWeightPair

Definition at line 124 of file BasicFilters.hh.

Constructor & Destructor Documentation

protocols::filters::CombinedFilter::CombinedFilter

(

)

Definition at line 304 of file BasicFilters.cc.

Referenced by clone(), and fresh_instance().

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

virtual

Definition at line 305 of file BasicFilters.cc.

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.

Definition at line 308 of file BasicFilters.cc.

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

FilterOP protocols::filters::CombinedFilter::clone ( ) const

virtual

Implements protocols::filters::Filter.

Definition at line 317 of file BasicFilters.cc.

References CombinedFilter().

core::Real protocols::filters::CombinedFilter::compute

(

core::pose::Pose const &

pose)

const

Definition at line 343 of file BasicFilters.cc.

References filterlist_.

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

FilterOP protocols::filters::CombinedFilter::fresh_instance ( ) const

virtual

Implements protocols::filters::Filter.

Definition at line 323 of file BasicFilters.cc.

References CombinedFilter().

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

Reimplemented from protocols::filters::Filter.

Definition at line 354 of file BasicFilters.cc.

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

void protocols::filters::CombinedFilter::report ( std::ostream &  out, core::pose::Pose const &  pose  ) const

virtual

Reimplemented from protocols::filters::Filter.

Definition at line 329 of file BasicFilters.cc.

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.

Definition at line 337 of file BasicFilters.cc.

References compute().

Member Data Documentation

FilterList protocols::filters::CombinedFilter::filterlist_

private

Definition at line 145 of file BasicFilters.hh.

Referenced by compute(), and parse_my_tag().

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

private

Definition at line 144 of file BasicFilters.hh.

Referenced by apply(), and parse_my_tag().

---

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

• src/protocols/filters/BasicFilters.hh
• src/protocols/filters/BasicFilters.cc