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

#include <FileExistFilter.hh>

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

Public Member Functions

 FileExistFilter ()
 
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
 
 ~FileExistFilter () 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 filename (std::string const &f)
 
std::string filename () const
 
bool ignore_zero_byte () const
 
void ignore_zero_byte (bool const i)
 
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 Attributes

std::string filename_
 
bool ignore_zero_byte_
 

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::simple_filters::FileExistFilter::FileExistFilter ( )
protocols::simple_filters::FileExistFilter::~FileExistFilter ( )
overridedefault

Member Function Documentation

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

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

Implements protocols::filters::Filter.

References compute().

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

References filename_.

std::string protocols::simple_filters::FileExistFilter::filename ( ) const

References filename_.

filters::FilterOP protocols::simple_filters::FileExistFilter::fresh_instance ( ) const
inlineoverridevirtual
bool protocols::simple_filters::FileExistFilter::ignore_zero_byte ( ) const
inline

References ignore_zero_byte_.

Referenced by compute(), and parse_my_tag().

void protocols::simple_filters::FileExistFilter::ignore_zero_byte ( bool const  i)
inline

References ignore_zero_byte_.

std::string protocols::simple_filters::FileExistFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::FileExistFilter::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 filename_, and ignore_zero_byte().

void protocols::simple_filters::FileExistFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::simple_filters::FileExistFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), and filename_.

core::Real protocols::simple_filters::FileExistFilter::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 compute().

Member Data Documentation

std::string protocols::simple_filters::FileExistFilter::filename_
private
bool protocols::simple_filters::FileExistFilter::ignore_zero_byte_
private

Referenced by ignore_zero_byte().


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