Rosetta: protocols::drug_design::NChiFilter Class Reference

Rosetta

#include <NChiFilter.hh>

Inheritance diagram for protocols::drug_design::NChiFilter:

Inheritance graph

[legend]

Public Member Functions
	NChiFilter ()

	NChiFilter (std::string const &residue, core::Size threshold, bool exclude_proton=true)

void	residue (std::string const &residue)

std::string const &	residue () const

void	threshold (core::Size setting)

core::Size	threshold () const

void	exclude_proton (bool setting)

bool	exclude_proton () const

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

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 std::string	name () const

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	residue_

core::Size	threshold_

bool	exclude_proton_

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

Constructor & Destructor Documentation

◆ NChiFilter() [1/2]

protocols::drug_design::NChiFilter::NChiFilter ( )

inline

Referenced by clone(), and fresh_instance().

◆ NChiFilter() [2/2]

protocols::drug_design::NChiFilter::NChiFilter	(	std::string const &	residue,
		core::Size	threshold,
		bool	exclude_proton = `true`
	)

inline

Member Function Documentation

◆ apply()

bool protocols::drug_design::NChiFilter::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(), residue_, threshold_, and protocols::drug_design::TR().

◆ class_name()

std::string protocols::drug_design::NChiFilter::class_name ( )

static

Referenced by protocols::drug_design::NChiFilterCreator::keyname(), and provide_xml_schema().

◆ clone()

filters::FilterOP protocols::drug_design::NChiFilter::clone ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

References NChiFilter().

◆ compute()

core::Size protocols::drug_design::NChiFilter::compute ( core::pose::Pose const & pose ) const

References exclude_proton_, core::chemical::ResidueType::n_proton_chi(), core::chemical::ResidueTypeBase::name(), core::chemical::ResidueType::nchi(), core::pose::parse_resnum(), core::pose::Pose::residue(), residue_, core::pose::Pose::total_residue(), protocols::drug_design::TR(), and core::conformation::Residue::type().

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

◆ exclude_proton() [1/2]

bool protocols::drug_design::NChiFilter::exclude_proton ( ) const

inline

References exclude_proton_.

◆ exclude_proton() [2/2]

void protocols::drug_design::NChiFilter::exclude_proton ( bool setting )

inline

References exclude_proton_.

◆ fresh_instance()

filters::FilterOP protocols::drug_design::NChiFilter::fresh_instance ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

References NChiFilter().

◆ parse_my_tag()

void protocols::drug_design::NChiFilter::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 exclude_proton_, residue_, threshold_, and protocols::drug_design::TR().

◆ provide_xml_schema()

void protocols::drug_design::NChiFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

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

Referenced by protocols::drug_design::NChiFilterCreator::provide_xml_schema().

◆ report()

void protocols::drug_design::NChiFilter::report	(	std::ostream &	out,
		core::pose::Pose const &	pose
	)		const

overridevirtual

Reimplemented from protocols::filters::Filter.

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

◆ report_sm()

core::Real protocols::drug_design::NChiFilter::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().

◆ residue() [1/2]

std::string const& protocols::drug_design::NChiFilter::residue ( ) const

inline

References residue_.

◆ residue() [2/2]

void protocols::drug_design::NChiFilter::residue ( std::string const & residue )

inline

References residue(), and residue_.

Referenced by residue().

◆ threshold() [1/2]

core::Size protocols::drug_design::NChiFilter::threshold ( ) const

inline

References threshold_.

◆ threshold() [2/2]

void protocols::drug_design::NChiFilter::threshold ( core::Size setting )

inline

References threshold_.

Member Data Documentation

◆ exclude_proton_

bool protocols::drug_design::NChiFilter::exclude_proton_

private

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

◆ residue_

std::string protocols::drug_design::NChiFilter::residue_

private

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

◆ threshold_

core::Size protocols::drug_design::NChiFilter::threshold_

private

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

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

src/protocols/drug_design/NChiFilter.hh
src/protocols/drug_design/NChiFilter.cc