Rosetta  2020.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::simple_filters::ReportFilter Class Reference

#include <ReportFilter.hh>

Inheritance diagram for protocols::simple_filters::ReportFilter:
Inheritance graph
[legend]

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 &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &) override
 
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 (Filter 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 bool filter_provides_citation_info () const
 Does this filter provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool filter_is_unpublished () const
 Does this filter indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. 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

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

Member Function Documentation

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_.

void protocols::simple_filters::ReportFilter::checkpoint_read ( ) const
private
void protocols::simple_filters::ReportFilter::checkpoint_write ( ) const
private
std::string protocols::simple_filters::ReportFilter::checkpointing_file ( ) const
inline
void protocols::simple_filters::ReportFilter::checkpointing_file ( std::string const &  s)
inline

References checkpointing_file_.

std::string protocols::simple_filters::ReportFilter::class_name ( )
static
filters::FilterOP protocols::simple_filters::ReportFilter::clone ( ) const
inlineoverridevirtual
core::Real protocols::simple_filters::ReportFilter::compute ( core::pose::Pose const &  pose) const

References filter(), and report_sm().

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 compute(), and parse_my_tag().

core::Real protocols::simple_filters::ReportFilter::filter_val ( ) const
inline
filters::FilterOP protocols::simple_filters::ReportFilter::fresh_instance ( ) const
inlineoverridevirtual
std::string protocols::simple_filters::ReportFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::ReportFilter::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data,
protocols::filters::Filters_map const &  filters,
protocols::moves::Movers_map const &  ,
core::pose::Pose const &   
)
overridevirtual
void protocols::simple_filters::ReportFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::simple_filters::ReportFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
overridevirtual
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
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().

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

std::string protocols::simple_filters::ReportFilter::checkpointing_file_
private
protocols::filters::FilterOP protocols::simple_filters::ReportFilter::filter_
private

Referenced by filter(), and report().

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

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

std::string protocols::simple_filters::ReportFilter::report_filter_name_
private
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: