Rosetta: protocols::fldsgn::filters::NcontactsFilter Class Reference

Rosetta

#include <NcontactsFilter.hh>

Inheritance diagram for protocols::fldsgn::filters::NcontactsFilter:

Inheritance graph

[legend]

Public Types
typedef protocols::filters::Filter	Super

typedef std::string	String

typedef core::Size	Size

typedef core::Real	Real

typedef protocols::filters::Filter	Filter

typedef protocols::filters::FilterOP	FilterOP

typedef core::pose::Pose	Pose

typedef utility::tag::TagCOP	TagCOP

typedef basic::datacache::DataMap	DataMap

Public Member Functions
	NcontactsFilter ()
	default constructor More...

	NcontactsFilter (String const &report_type, Real const filter_value)
	default constructor More...

	NcontactsFilter (NcontactsFilter const &rval)
	copy constructor More...

	~NcontactsFilter () override
	destructor More...

FilterOP	clone () const override
	make clone More...

FilterOP	fresh_instance () const override
	make fresh instance More...

Real	compute (Pose const &pose) const
	get name of this filter More...

Real	report_sm (Pose const &pose) const override
	used to report score More...

void	report (std::ostream &out, Pose const &pose) const override
	used to report score More...

bool	apply (Pose const &pose) const override
	returns true if the given pose passes the filter, false otherwise. In this case, the test is whether the give pose is the topology we want. More...

void	parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
	parse xml More...

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
String	report_type_

Real	filter_value_

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

Member Typedef Documentation

◆ DataMap

typedef basic::datacache::DataMap protocols::fldsgn::filters::NcontactsFilter::DataMap

◆ Filter

typedef protocols::filters::Filter protocols::fldsgn::filters::NcontactsFilter::Filter

◆ FilterOP

typedef protocols::filters::FilterOP protocols::fldsgn::filters::NcontactsFilter::FilterOP

◆ Pose

typedef core::pose::Pose protocols::fldsgn::filters::NcontactsFilter::Pose

◆ Real

typedef core::Real protocols::fldsgn::filters::NcontactsFilter::Real

◆ Size

typedef core::Size protocols::fldsgn::filters::NcontactsFilter::Size

◆ String

typedef std::string protocols::fldsgn::filters::NcontactsFilter::String

◆ Super

typedef protocols::filters::Filter protocols::fldsgn::filters::NcontactsFilter::Super

◆ TagCOP

typedef utility::tag::TagCOP protocols::fldsgn::filters::NcontactsFilter::TagCOP

Constructor & Destructor Documentation

◆ NcontactsFilter() [1/3]

protocols::fldsgn::filters::NcontactsFilter::NcontactsFilter ( )

default constructor

◆ NcontactsFilter() [2/3]

protocols::fldsgn::filters::NcontactsFilter::NcontactsFilter	(	String const &	report_type,
		Real const	filter_value
	)

default constructor

◆ NcontactsFilter() [3/3]

protocols::fldsgn::filters::NcontactsFilter::NcontactsFilter ( NcontactsFilter const & rval )

default

copy constructor

◆ ~NcontactsFilter()

protocols::fldsgn::filters::NcontactsFilter::~NcontactsFilter ( )

overridedefault

destructor

Member Function Documentation

◆ apply()

bool protocols::fldsgn::filters::NcontactsFilter::apply ( Pose const & pose ) const

overridevirtual

returns true if the given pose passes the filter, false otherwise. In this case, the test is whether the give pose is the topology we want.

Implements protocols::filters::Filter.

References compute(), filter_value_, and protocols::filters::Filter::score().

◆ class_name()

std::string protocols::fldsgn::filters::NcontactsFilter::class_name ( )

static

Referenced by protocols::fldsgn::filters::NcontactsFilterCreator::keyname(), name(), and provide_xml_schema().

◆ clone()

FilterOP protocols::fldsgn::filters::NcontactsFilter::clone ( ) const

inlineoverridevirtual

make clone

Implements protocols::filters::Filter.

◆ compute()

NcontactsFilter::Real protocols::fldsgn::filters::NcontactsFilter::compute ( Pose const & pose ) const

get name of this filter

comute ncontacts

compute number of contacts

References core::pose::metrics::StructureDependentCalculator::get(), and report_type_.

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

◆ fresh_instance()

FilterOP protocols::fldsgn::filters::NcontactsFilter::fresh_instance ( ) const

inlineoverridevirtual

make fresh instance

Implements protocols::filters::Filter.

◆ name()

std::string protocols::fldsgn::filters::NcontactsFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::fldsgn::filters::NcontactsFilter::parse_my_tag	(	TagCOP	tag,
		basic::datacache::DataMap &
	)

overridevirtual

parse xml

Reimplemented from protocols::filters::Filter.

References filter_value_, and report_type_.

◆ provide_xml_schema()

void protocols::fldsgn::filters::NcontactsFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

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

Referenced by protocols::fldsgn::filters::NcontactsFilterCreator::provide_xml_schema().

◆ report()

void protocols::fldsgn::filters::NcontactsFilter::report	(	std::ostream &	out,
		Pose const &	pose
	)		const

overridevirtual

used to report score

Reimplemented from protocols::filters::Filter.

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

◆ report_sm()

NcontactsFilter::Real protocols::fldsgn::filters::NcontactsFilter::report_sm ( Pose const & pose ) const

overridevirtual

used to report score

Reimplemented from protocols::filters::Filter.

References compute().

Member Data Documentation

◆ filter_value_

Real protocols::fldsgn::filters::NcontactsFilter::filter_value_

private

Referenced by apply(), and parse_my_tag().

◆ report_type_

String protocols::fldsgn::filters::NcontactsFilter::report_type_

private

Referenced by compute(), and parse_my_tag().

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

src/protocols/fldsgn/filters/NcontactsFilter.hh
src/protocols/fldsgn/filters/NcontactsFilter.cc