protocols::simple_filters::ReportFilter Class Reference

#include <ReportFilter.hh>

Inheritance diagram for protocols::simple_filters::ReportFilter:

Collaboration diagram for protocols::simple_filters::ReportFilter:

Public Member Functions
	ReportFilter ()
bool	apply (core::pose::Pose const &pose) const
	Returns true if the given pose passes the filter, false otherwise. More...
filters::FilterOP	clone () const
filters::FilterOP	fresh_instance () const
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::Real	compute (core::pose::Pose const &pose) const
virtual	~ReportFilter ()
void	parse_my_tag (utility::tag::TagPtr const tag, protocols::moves::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)
void	report_string (std::string const s)
std::string	report_string () const
void	filter (protocols::filters::FilterOP f)
protocols::filters::FilterOP	filter () const
std::string	report_filter_name () 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
utility::pointer::owning_ptr < protocols::moves::DataMapObj < std::string > >	report_string_
protocols::filters::FilterOP	filter_
std::string	report_filter_name_

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

Constructor & Destructor Documentation

protocols::simple_filters::ReportFilter::ReportFilter

(

)

Referenced by clone(), and fresh_instance().

protocols::simple_filters::ReportFilter::~ReportFilter ( )

virtual

Member Function Documentation

bool protocols::simple_filters::ReportFilter::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().

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

inlinevirtual

Implements protocols::filters::Filter.

References ReportFilter().

core::Real protocols::simple_filters::ReportFilter::compute

(

core::pose::Pose const &

pose)

const

Referenced by apply().

void protocols::simple_filters::ReportFilter::filter ( protocols::filters::FilterOP  f)

inline

References filter_.

protocols::filters::FilterOP protocols::simple_filters::ReportFilter::filter ( ) const

inline

References filter_.

Referenced by parse_my_tag().

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

inlinevirtual

Implements protocols::filters::Filter.

References ReportFilter().

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

virtual

Reimplemented from protocols::filters::Filter.

References filter(), protocols::moves::DataMap::get(), protocols::rosetta_scripts::parse_filter(), report_filter_name_, and report_string_.

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

virtual

Reimplemented from protocols::filters::Filter.

References protocols::jd2::JobDistributor::current_job(), filter_, protocols::jd2::JobDistributor::get_instance(), report_filter_name_, and report_string_.

std::string protocols::simple_filters::ReportFilter::report_filter_name ( ) const

inline

References report_filter_name_.

core::Real protocols::simple_filters::ReportFilter::report_sm ( core::pose::Pose const &  ) const

virtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

void protocols::simple_filters::ReportFilter::report_string

(

std::string const

s)

References report_string_.

std::string protocols::simple_filters::ReportFilter::report_string

(

)

const

References report_string_.

Member Data Documentation

protocols::filters::FilterOP protocols::simple_filters::ReportFilter::filter_

private

Referenced by filter(), and report().

std::string protocols::simple_filters::ReportFilter::report_filter_name_

private

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

utility::pointer::owning_ptr< protocols::moves::DataMapObj< std::string > > protocols::simple_filters::ReportFilter::report_string_

private

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

---

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

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