test whether a pose contains a comment that evaluates to a predefined value. This is useful in controlling execution flow in RosettaScripts. More...

#include <PoseCommentFilter.hh>

Inheritance diagram for protocols::simple_filters::PoseComment:

[legend]

Public Member Functions
	PoseComment ()

	~PoseComment () override

filters::FilterOP	clone () const override

filters::FilterOP	fresh_instance () const override

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

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

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, filters::Filters_map const &filters, moves::Movers_map const &, core::pose::Pose const &) override

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

std::string	comment_name () const

void	comment_name (std::string const &s)

std::string	comment_value () const

void	comment_value (std::string const &s)

bool	comment_exists () const

void	comment_exists (bool const c)

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	comment_name_

std::string	comment_value_

bool	comment_exists_

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

Detailed Description

test whether a pose contains a comment that evaluates to a predefined value. This is useful in controlling execution flow in RosettaScripts.

Constructor & Destructor Documentation

protocols::simple_filters::PoseComment::PoseComment ( )

protocols::simple_filters::PoseComment::~PoseComment ( )

overridedefault

Member Function Documentation

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

overridevirtual

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

Implements protocols::filters::Filter.

References comment_name(), comment_value(), compute(), protocols::simple_filters::TR(), and protocols::hybridization::val.

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

static

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

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

inlineoverridevirtual

Implements protocols::filters::Filter.

bool protocols::simple_filters::PoseComment::comment_exists ( ) const

inline

References comment_exists_.

Referenced by compute(), and parse_my_tag().

void protocols::simple_filters::PoseComment::comment_exists ( bool const c )

inline

References core::pack::dunbrack::c, and comment_exists_.

std::string protocols::simple_filters::PoseComment::comment_name ( ) const

inline

References comment_name_.

Referenced by apply(), compute(), and parse_my_tag().

void protocols::simple_filters::PoseComment::comment_name ( std::string const & s )

inline

References comment_name_.

std::string protocols::simple_filters::PoseComment::comment_value ( ) const

inline

References comment_value_.

Referenced by apply(), compute(), and parse_my_tag().

void protocols::simple_filters::PoseComment::comment_value ( std::string const & s )

inline

References comment_value_.

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

References comment_exists(), comment_name(), comment_value(), core::pose::get_all_comments(), core::pose::get_comment(), and protocols::hybridization::val.

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

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

inlineoverridevirtual

Implements protocols::filters::Filter.

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::PoseComment::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	,
		filters::Filters_map const &	filters,
		moves::Movers_map const &	,
		core::pose::Pose const &
	)