Rosetta: protocols::simple_filters::FileExistFilter Class Reference

Rosetta

#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 () 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 Attributes
std::string	filename_

bool	ignore_zero_byte_

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

Constructor & Destructor Documentation

◆ FileExistFilter()

protocols::simple_filters::FileExistFilter::FileExistFilter ( )

◆ ~FileExistFilter()

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

overridedefault

Member Function Documentation

◆ apply()

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().

◆ class_name()

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

static

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

◆ clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

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

References core::sequence::end, filename_, ignore_zero_byte(), and core::conformation::membrane::in.

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

◆ filename() [1/2]

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

References filename_.

◆ filename() [2/2]

void protocols::simple_filters::FileExistFilter::filename ( std::string const & f )

References filename_.

◆ fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ ignore_zero_byte() [1/2]

bool protocols::simple_filters::FileExistFilter::ignore_zero_byte ( ) const

inline

References ignore_zero_byte_.

Referenced by compute(), and parse_my_tag().

◆ ignore_zero_byte() [2/2]

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

inline

References ignore_zero_byte_.

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

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().

◆ provide_xml_schema()

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

static

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

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

◆ report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), filename_, and core::conformation::membrane::out.

◆ report_sm()

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

◆ filename_

std::string protocols::simple_filters::FileExistFilter::filename_

private

Referenced by compute(), filename(), parse_my_tag(), and report().

◆ ignore_zero_byte_

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:

src/protocols/simple_filters/FileExistFilter.hh
src/protocols/simple_filters/FileExistFilter.cc