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>

Public Member Functions
	PoseComment ()

virtual	~PoseComment ()

filters::FilterOP	clone () const

filters::FilterOP	fresh_instance () const

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

virtual void	report (std::ostream &out, core::pose::Pose const &pose) const

virtual core::Real	report_sm (core::pose::Pose const &pose) const
	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 &)

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)

Public Member Functions inherited from protocols::filters::Filter
	Filter ()

	Filter (std::string const &)

	Filter (Filter const &)

virtual	~Filter ()

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 void	apply (core::io::serialization::PipeMap &pmap)

virtual void	score (core::io::serialization::PipeMap &pmap)

virtual core::Real	score (core::pose::Pose &pose)

virtual void	parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks)

virtual std::string	name () const

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

References filters.

Referenced by clone(), and fresh_instance().

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

virtual

Member Function Documentation

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

virtual

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

Implements protocols::filters::Filter.

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

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

inlinevirtual

Implements protocols::filters::Filter.

References PoseComment().

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 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(), get_all_comments(), and get_comment().

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

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

inlinevirtual

Implements protocols::filters::Filter.

References PoseComment().

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 &
	)