Rosetta: protocols::simple_filters::ExpiryFilter Class Reference

Rosetta

#include <ExpiryFilter.hh>

Inheritance diagram for protocols::simple_filters::ExpiryFilter:

Inheritance graph

[legend]

Public Member Functions
	ExpiryFilter ()

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

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

core::Size	seconds () const

void	seconds (core::Size const s)

core::Size	start_time () const

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
core::Size	seconds_

core::Size	start_time_

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

Constructor & Destructor Documentation

◆ ExpiryFilter()

protocols::simple_filters::ExpiryFilter::ExpiryFilter ( )

References start_time_.

◆ ~ExpiryFilter()

protocols::simple_filters::ExpiryFilter::~ExpiryFilter ( )

overridedefault

Member Function Documentation

◆ apply()

bool protocols::simple_filters::ExpiryFilter::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(), and seconds().

◆ class_name()

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

static

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

◆ clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

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

References start_time().

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

◆ fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::ExpiryFilter::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 seconds().

◆ provide_xml_schema()

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

static

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

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

◆ report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

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

◆ report_sm()

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

◆ seconds() [1/2]

core::Size protocols::simple_filters::ExpiryFilter::seconds ( ) const

References seconds_.

Referenced by apply(), and parse_my_tag().

◆ seconds() [2/2]

void protocols::simple_filters::ExpiryFilter::seconds ( core::Size const s )

References seconds_.

◆ start_time()

core::Size protocols::simple_filters::ExpiryFilter::start_time ( ) const

References start_time_.

Referenced by compute().

Member Data Documentation

◆ seconds_

core::Size protocols::simple_filters::ExpiryFilter::seconds_

private

Referenced by seconds().

◆ start_time_

core::Size protocols::simple_filters::ExpiryFilter::start_time_

private

Referenced by ExpiryFilter(), and start_time().

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

src/protocols/simple_filters/ExpiryFilter.hh
src/protocols/simple_filters/ExpiryFilter.cc