protocols::simple_filters::RangeFilter Class Reference

#include <RangeFilter.hh>

Inheritance diagram for protocols::simple_filters::RangeFilter:

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::TagCOP	TagCOP
typedef basic::datacache::DataMap	DataMap

Public Member Functions
	RangeFilter ()
	RangeFilter (Real lower_bound, Real upper_bound, FilterOP filter)
filters::FilterOP	clone () const override
filters::FilterOP	fresh_instance () const override
void	parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
	parse xml More...
bool	apply (Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
void	report (std::ostream &out, Pose const &pose) const override
	used to report score More...
std::string	name () const override
Public Member Functions inherited from protocols::filters::Filter
	Filter ()
	Filter (std::string const &)
	~Filter () override
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 core::Real	score (core::pose::Pose &pose)
virtual void	provide_citation_info (basic::citation_manager::CitationCollectionList &) const
	Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...

Static Public Member Functions
static std::string	class_name ()
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
FilterOP	filter_
Real	lower_bound_
Real	upper_bound_

Additional Inherited Members
Protected Attributes inherited from protocols::filters::Filter
std::string	scorename_

Member Typedef Documentation

DataMap

typedef basic::datacache::DataMap protocols::simple_filters::RangeFilter::DataMap

Filter

typedef protocols::filters::Filter protocols::simple_filters::RangeFilter::Filter

FilterOP

typedef protocols::filters::FilterOP protocols::simple_filters::RangeFilter::FilterOP

Pose

typedef core::pose::Pose protocols::simple_filters::RangeFilter::Pose

Real

typedef core::Real protocols::simple_filters::RangeFilter::Real

String

typedef std::string protocols::simple_filters::RangeFilter::String

Super

typedef protocols::filters::Filter protocols::simple_filters::RangeFilter::Super

TagCOP

typedef utility::tag::TagCOP protocols::simple_filters::RangeFilter::TagCOP

Constructor & Destructor Documentation

RangeFilter() [1/2]

protocols::simple_filters::RangeFilter::RangeFilter

(

)

RangeFilter() [2/2]

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

Member Function Documentation

apply()

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

overridevirtual

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

Implements protocols::filters::Filter.

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

class_name()

std::string protocols::simple_filters::RangeFilter::class_name ( )

static

Referenced by protocols::simple_filters::RangeFilterCreator::keyname(), name(), and provide_xml_schema().

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::simple_filters::RangeFilter::parse_my_tag ( TagCOP  tag, basic::datacache::DataMap &  data  )

overridevirtual

parse xml

Reimplemented from protocols::filters::Filter.

References filter_, lower_bound_, protocols::rosetta_scripts::parse_filter(), and upper_bound_.

provide_xml_schema()

void protocols::simple_filters::RangeFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References class_name(), and protocols::filters::xsd_type_definition_w_attributes().

Referenced by protocols::simple_filters::RangeFilterCreator::provide_xml_schema().

report()

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

overridevirtual

used to report score

Reimplemented from protocols::filters::Filter.

References filter_, lower_bound_, core::conformation::membrane::out, and upper_bound_.

Member Data Documentation

filter_

FilterOP protocols::simple_filters::RangeFilter::filter_

private

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

lower_bound_

Real protocols::simple_filters::RangeFilter::lower_bound_

private

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

upper_bound_

Real protocols::simple_filters::RangeFilter::upper_bound_

private

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

---

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

• src/protocols/simple_filters/RangeFilter.hh
• src/protocols/simple_filters/RangeFilter.cc