protocols::simple_filters::PoseComment Class Reference

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:

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 &) override
	Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...
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 () 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	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

PoseComment()

protocols::simple_filters::PoseComment::PoseComment

(

)

~PoseComment()

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

overridedefault

Member Function Documentation

apply()

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.

class_name()

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

static

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

clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

comment_exists() [1/2]

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

inline

References comment_exists_.

Referenced by compute(), and parse_my_tag().

comment_exists() [2/2]

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

inline

References comment_exists_.

comment_name() [1/2]

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

inline

References comment_name_.

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

comment_name() [2/2]

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

inline

References comment_name_.

comment_value() [1/2]

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

inline

References comment_value_.

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

comment_value() [2/2]

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

inline

References comment_value_.

compute()

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

fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::simple_filters::PoseComment::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 comment_exists(), comment_name(), comment_value(), and protocols::simple_filters::TR().

provide_xml_schema()

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

static

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

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

report()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), and protocols::hybridization::val.

report_sm()

core::Real protocols::simple_filters::PoseComment::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

comment_exists_

bool protocols::simple_filters::PoseComment::comment_exists_

private

Referenced by comment_exists().

comment_name_

std::string protocols::simple_filters::PoseComment::comment_name_

private

Referenced by comment_name().

comment_value_

std::string protocols::simple_filters::PoseComment::comment_value_

private

Referenced by comment_value().

---

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

• src/protocols/simple_filters/PoseCommentFilter.hh
• src/protocols/simple_filters/PoseCommentFilter.cc