#include <ReportFilter.hh>

Inheritance diagram for protocols::simple_filters::ReportFilter:

Public Member Functions
	ReportFilter ()

bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...

filters::FilterOP	clone () const override

filters::FilterOP	fresh_instance () const override

void	report (std::ostream &out, core::pose::Pose const &pose) const override

core::Real	report_sm (core::pose::Pose const &pose) const override
	used to report filter internals through a score or silent file More...

core::Real	compute (core::pose::Pose const &pose) const

	~ReportFilter () override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...

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

core::Real	filter_val () const

std::string	checkpointing_file () const

void	checkpointing_file (std::string const &s)

std::string	name () const override

Public Member Functions inherited from protocols::filters::Filter
	Filter ()

	Filter (std::string const &)

	~Filter () override

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 Member Functions
void	checkpoint_read () const

void	checkpoint_write () const

Private Attributes
utility::pointer::shared_ptr< basic::datacache::DataMapObj< std::string > >	report_string_

protocols::filters::FilterOP	filter_

std::string	report_filter_name_

core::Real	filter_val_

std::string	checkpointing_file_

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

Constructor & Destructor Documentation

◆ ReportFilter()

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

◆ ~ReportFilter()

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

overridedefault

Member Function Documentation

◆ apply()

bool protocols::simple_filters::ReportFilter::apply ( core::pose::Pose const & pose ) const

overridevirtual

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

Implements protocols::filters::Filter.

References checkpoint_read(), checkpoint_write(), compute(), and filter_val_.

◆ checkpoint_read()

void protocols::simple_filters::ReportFilter::checkpoint_read ( ) const

private

References checkpointing_file(), checkpointing_file_, filter_val(), filter_val_, and protocols::simple_filters::TR().

Referenced by apply(), and report_sm().

◆ checkpoint_write()

void protocols::simple_filters::ReportFilter::checkpoint_write ( ) const

private

References checkpointing_file(), checkpointing_file_, filter_val(), and protocols::simple_filters::TR().

Referenced by apply().

◆ checkpointing_file() [1/2]

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

inline

References checkpointing_file_.

Referenced by checkpoint_read(), checkpoint_write(), and parse_my_tag().

◆ checkpointing_file() [2/2]

void protocols::simple_filters::ReportFilter::checkpointing_file ( std::string const & s )

inline

References checkpointing_file_.

◆ class_name()

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

static

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

◆ clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

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

References filter(), and report_sm().

Referenced by apply().

◆ filter() [1/2]

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

inline

References filter_.

Referenced by compute(), and parse_my_tag().

◆ filter() [2/2]

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

inline

References filter_.

◆ filter_val()

core::Real protocols::simple_filters::ReportFilter::filter_val ( ) const

inline

References filter_val_.

Referenced by checkpoint_read(), checkpoint_write(), report(), and report_sm().

◆ fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::ReportFilter::parse_my_tag	(	utility::tag::TagCOP	,
		basic::datacache::DataMap &
	)

overridevirtual

Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing.

Reimplemented from protocols::filters::Filter.

References checkpointing_file(), filter(), protocols::rosetta_scripts::parse_filter(), report_filter_name_, report_string_, and protocols::simple_filters::TR().

◆ provide_xml_schema()

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

static

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

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

◆ report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References protocols::jd2::current_output_name(), filter_, filter_val(), core::conformation::membrane::out, report_filter_name_, and report_string_.

◆ report_filter_name()

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

inline

References report_filter_name_.

◆ report_sm()

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

overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References checkpoint_read(), and filter_val().

Referenced by compute().

◆ report_string() [1/2]

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

References report_string_.

◆ report_string() [2/2]

void protocols::simple_filters::ReportFilter::report_string ( std::string const & s )

References report_string_.

Member Data Documentation

◆ checkpointing_file_

std::string protocols::simple_filters::ReportFilter::checkpointing_file_

private

Referenced by checkpoint_read(), checkpoint_write(), and checkpointing_file().

◆ filter_

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

private

Referenced by filter(), and report().

◆ filter_val_

core::Real protocols::simple_filters::ReportFilter::filter_val_

mutableprivate

Referenced by apply(), checkpoint_read(), and filter_val().

◆ report_filter_name_

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

private

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

◆ report_string_

utility::pointer::shared_ptr< basic::datacache::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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ReportFilter()

◆ ~ReportFilter()

Member Function Documentation

◆ apply()

◆ checkpoint_read()

◆ checkpoint_write()

◆ checkpointing_file() [1/2]

◆ checkpointing_file() [2/2]

◆ class_name()

◆ clone()

◆ compute()

◆ filter() [1/2]

◆ filter() [2/2]

◆ filter_val()

◆ fresh_instance()

◆ name()

◆ parse_my_tag()

◆ provide_xml_schema()

◆ report()

◆ report_filter_name()

◆ report_sm()

◆ report_string() [1/2]

◆ report_string() [2/2]

Member Data Documentation

◆ checkpointing_file_

◆ filter_

◆ filter_val_

◆ report_filter_name_

◆ report_string_