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::simple_filters::RangeFilter Class Reference

#include <RangeFilter.hh>

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

Public Types

typedef protocols::filters::Filter Super
 
typedef protocols::filters::Filter Filter
 
typedef
protocols::filters::FilterOP 
FilterOP
 
typedef core::Real Real
 
typedef core::pose::Pose Pose
 
typedef std::string String
 
typedef utility::tag::TagPtr TagPtr
 
typedef
protocols::filters::Filters_map 
Filters_map
 
typedef protocols::moves::DataMap DataMap
 
typedef
protocols::moves::Movers_map 
Movers_map
 

Public Member Functions

 RangeFilter ()
 
 RangeFilter (Real lower_bound, Real upper_bound, const FilterOP &filter)
 
 RangeFilter (RangeFilter const &rval)
 
virtual ~RangeFilter ()
 
virtual filters::FilterOP clone () const
 
virtual filters::FilterOP fresh_instance () const
 
virtual std::string name () const
 
virtual void parse_my_tag (TagPtr const tag, DataMap &, filters::Filters_map const &, Movers_map const &, Pose const &)
 parse xml More...
 
virtual bool apply (Pose const &pose) const
 Returns true if the given pose passes the filter, false otherwise. More...
 
virtual void report (std::ostream &out, Pose const &pose) const
 used to report score More...
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
virtual ~Filter ()
 
virtual core::Real report_sm (core::pose::Pose const &) const
 used to report filter internals through a score or silent file More...
 
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)
 

Private Attributes

FilterOP filter_
 
Real lower_bound_
 
Real upper_bound_
 

Additional Inherited Members

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

Detailed Description

Definition at line 44 of file RangeFilter.hh.

Member Typedef Documentation

Definition at line 56 of file RangeFilter.hh.

Definition at line 48 of file RangeFilter.hh.

Definition at line 49 of file RangeFilter.hh.

Definition at line 55 of file RangeFilter.hh.

Definition at line 57 of file RangeFilter.hh.

Definition at line 51 of file RangeFilter.hh.

Definition at line 50 of file RangeFilter.hh.

Definition at line 52 of file RangeFilter.hh.

Definition at line 47 of file RangeFilter.hh.

typedef utility::tag::TagPtr protocols::simple_filters::RangeFilter::TagPtr

Definition at line 54 of file RangeFilter.hh.

Constructor & Destructor Documentation

protocols::simple_filters::RangeFilter::RangeFilter ( )

Definition at line 42 of file RangeFilter.cc.

Referenced by clone(), and fresh_instance().

protocols::simple_filters::RangeFilter::RangeFilter ( Real  lower_bound,
Real  upper_bound,
const FilterOP filter 
)

Definition at line 45 of file RangeFilter.cc.

protocols::simple_filters::RangeFilter::RangeFilter ( RangeFilter const &  rval)

Definition at line 52 of file RangeFilter.cc.

virtual protocols::simple_filters::RangeFilter::~RangeFilter ( )
inlinevirtual

Definition at line 72 of file RangeFilter.hh.

Member Function Documentation

bool protocols::simple_filters::RangeFilter::apply ( Pose const &  pose) const
virtual

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

Implements protocols::filters::Filter.

Definition at line 69 of file RangeFilter.cc.

References filter_, lower_bound_, protocols::simple_filters::tr(), and upper_bound_.

virtual filters::FilterOP protocols::simple_filters::RangeFilter::clone ( ) const
inlinevirtual

Implements protocols::filters::Filter.

Definition at line 79 of file RangeFilter.hh.

References RangeFilter().

virtual filters::FilterOP protocols::simple_filters::RangeFilter::fresh_instance ( ) const
inlinevirtual

Implements protocols::filters::Filter.

Definition at line 82 of file RangeFilter.hh.

References RangeFilter().

virtual std::string protocols::simple_filters::RangeFilter::name ( ) const
inlinevirtual

Reimplemented from protocols::filters::Filter.

Definition at line 92 of file RangeFilter.hh.

void protocols::simple_filters::RangeFilter::parse_my_tag ( TagPtr const  tag,
DataMap ,
filters::Filters_map const &  filters,
Movers_map const &  ,
Pose const &   
)
virtual

parse xml

Reimplemented from protocols::filters::Filter.

Definition at line 83 of file RangeFilter.cc.

References filter_, lower_bound_, and upper_bound_.

void protocols::simple_filters::RangeFilter::report ( std::ostream &  out,
Pose const &  pose 
) const
virtual

used to report score

Reimplemented from protocols::filters::Filter.

Definition at line 61 of file RangeFilter.cc.

References filter_, lower_bound_, and upper_bound_.

Member Data Documentation

FilterOP protocols::simple_filters::RangeFilter::filter_
private

Definition at line 116 of file RangeFilter.hh.

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

Real protocols::simple_filters::RangeFilter::lower_bound_
private

Definition at line 117 of file RangeFilter.hh.

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

Real protocols::simple_filters::RangeFilter::upper_bound_
private

Definition at line 117 of file RangeFilter.hh.

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


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