protocols::simple_filters::AveragePathLengthFilter Class Reference

#include <AveragePathLengthFilter.hh>

Inheritance diagram for protocols::simple_filters::AveragePathLengthFilter:

Public Member Functions
	AveragePathLengthFilter ()
	AveragePathLengthFilter (core::Real path_tightness, core::Real max_path_length)
	AveragePathLengthFilter (AveragePathLengthFilter const &src)
	~AveragePathLengthFilter () override
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
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	max_path_length () const
void	max_path_length (core::Real value)
core::Real	path_tightness () const
void	path_tightness (core::Real value)
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::Real	path_tightness_
core::Real	max_path_length_

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

Constructor & Destructor Documentation

AveragePathLengthFilter() [1/3]

protocols::simple_filters::AveragePathLengthFilter::AveragePathLengthFilter

(

)

AveragePathLengthFilter() [2/3]

protocols::simple_filters::AveragePathLengthFilter::AveragePathLengthFilter	(	core::Real	path_tightness,
		core::Real	max_path_length
	)

AveragePathLengthFilter() [3/3]

protocols::simple_filters::AveragePathLengthFilter::AveragePathLengthFilter

(

AveragePathLengthFilter const &

src

)

~AveragePathLengthFilter()

protocols::simple_filters::AveragePathLengthFilter::~AveragePathLengthFilter ( )

overridedefault

Member Function Documentation

apply()

bool protocols::simple_filters::AveragePathLengthFilter::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(), max_path_length_, path_tightness_, core::pose::Pose::size(), and protocols::simple_filters::TR().

class_name()

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

static

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

clone()

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

overridevirtual

Implements protocols::filters::Filter.

compute()

core::Real protocols::simple_filters::AveragePathLengthFilter::compute

(

core::pose::Pose const &

pose

)

const

References protocols::toolbox::ResidueNetwork::average_shortest_path_length(), and protocols::toolbox::ResidueNetwork::create_from_pose().

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

fresh_instance()

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

overridevirtual

Implements protocols::filters::Filter.

max_path_length() [1/2]

core::Real protocols::simple_filters::AveragePathLengthFilter::max_path_length

(

)

const

References max_path_length_.

Referenced by parse_my_tag().

max_path_length() [2/2]

void protocols::simple_filters::AveragePathLengthFilter::max_path_length

(

core::Real

value

)

References max_path_length_.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

parse_my_tag()

void protocols::simple_filters::AveragePathLengthFilter::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 max_path_length(), path_tightness(), and protocols::simple_filters::TR().

path_tightness() [1/2]

core::Real protocols::simple_filters::AveragePathLengthFilter::path_tightness

(

)

const

References path_tightness_.

Referenced by parse_my_tag().

path_tightness() [2/2]

void protocols::simple_filters::AveragePathLengthFilter::path_tightness

(

core::Real

value

)

References path_tightness_.

provide_xml_schema()

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

static

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

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

report()

void protocols::simple_filters::AveragePathLengthFilter::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::AveragePathLengthFilter::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

max_path_length_

core::Real protocols::simple_filters::AveragePathLengthFilter::max_path_length_

private

Referenced by apply(), and max_path_length().

path_tightness_

core::Real protocols::simple_filters::AveragePathLengthFilter::path_tightness_

private

Referenced by apply(), and path_tightness().

---

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

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