core::select::residue_selector::NumNeighborsSelector Class Reference

#include <NumNeighborsSelector.hh>

Inheritance diagram for core::select::residue_selector::NumNeighborsSelector:

Public Member Functions
	NumNeighborsSelector ()
	NumNeighborsSelector (NumNeighborsSelector const &src)
	Copy constructor. More...
ResidueSelectorOP	clone () const override
	Clone operator. More...
	NumNeighborsSelector (Size threshold, core::Real distance_cutoff)
	~NumNeighborsSelector () override
ResidueSubset	apply (core::pose::Pose const &pose) const override
	Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not. More...
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) override
	Initialize any data members of this instance from an input tag and a DataMap object. More...
std::string	get_name () const override
bool	count_water () const
Size	threshold () const
Real	distance_cutoff () const
void	count_water (bool setting)
void	threshold (Size setting)
void	distance_cutoff (Size setting)
Public Member Functions inherited from core::select::residue_selector::ResidueSelector
	ResidueSelector ()
	Constructor. More...
	~ResidueSelector () override
	Destructor. More...
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
bool	count_water_
Size	threshold_
Real	distance_cutoff_

Constructor & Destructor Documentation

core::select::residue_selector::NumNeighborsSelector::NumNeighborsSelector

(

)

core::select::residue_selector::NumNeighborsSelector::NumNeighborsSelector

(

NumNeighborsSelector const &

src

)

Copy constructor.

core::select::residue_selector::NumNeighborsSelector::NumNeighborsSelector	(	Size	threshold,
		core::Real	distance_cutoff
	)

core::select::residue_selector::NumNeighborsSelector::~NumNeighborsSelector ( )

overridedefault

Member Function Documentation

ResidueSubset core::select::residue_selector::NumNeighborsSelector::apply ( core::pose::Pose const &  pose ) const

overridevirtual

Return a ResidueSubset indicating a selection of Residues from the input Pose; the ResidueSubset is an array of booleans where a value of "true" for position i indicates that residue i is a part of the selected subset – and a value of "false" would indicate that it is not.

Implements core::select::residue_selector::ResidueSelector.

References protocols::cluster::calibur::aa, core::chemical::ResidueTypeBase::aa(), core::chemical::aa_h2o, core::pose::Pose::conformation(), count_water_, distance_cutoff_, core::conformation::find_neighbors(), core::conformation::residue_point_graph_from_conformation(), core::pose::Pose::residue_type(), core::pose::Pose::size(), and threshold_.

std::string core::select::residue_selector::NumNeighborsSelector::class_name ( )

static

Referenced by get_name(), core::select::residue_selector::NumNeighborsSelectorCreator::keyname(), and provide_xml_schema().

ResidueSelectorOP core::select::residue_selector::NumNeighborsSelector::clone ( ) const

overridevirtual

Clone operator.

Copy this object and return an owning pointer to the new object.

Implements core::select::residue_selector::ResidueSelector.

bool core::select::residue_selector::NumNeighborsSelector::count_water

(

)

const

References count_water_.

Referenced by parse_my_tag().

void core::select::residue_selector::NumNeighborsSelector::count_water

(

bool

setting

)

References count_water_.

Real core::select::residue_selector::NumNeighborsSelector::distance_cutoff

(

)

const

References distance_cutoff_.

void core::select::residue_selector::NumNeighborsSelector::distance_cutoff

(

Size

setting

)

References distance_cutoff_.

std::string core::select::residue_selector::NumNeighborsSelector::get_name ( ) const

overridevirtual

Implements core::select::residue_selector::ResidueSelector.

References class_name().

void core::select::residue_selector::NumNeighborsSelector::parse_my_tag ( utility::tag::TagCOP  tag, basic::datacache::DataMap &  datacache  )

overridevirtual

Initialize any data members of this instance from an input tag and a DataMap object.

Noop implementation in the base class in the case that a derived class has no need to read data from an input tag

Reimplemented from core::select::residue_selector::ResidueSelector.

References count_water(), distance_cutoff_, and threshold().

void core::select::residue_selector::NumNeighborsSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd )

static

References class_name(), and core::select::residue_selector::xsd_type_definition_w_attributes().

Referenced by core::select::residue_selector::NumNeighborsSelectorCreator::provide_xml_schema().

Size core::select::residue_selector::NumNeighborsSelector::threshold

(

)

const

References threshold_.

Referenced by parse_my_tag().

void core::select::residue_selector::NumNeighborsSelector::threshold

(

Size

setting

)

References threshold_.

Member Data Documentation

bool core::select::residue_selector::NumNeighborsSelector::count_water_

private

Referenced by apply(), and count_water().

Real core::select::residue_selector::NumNeighborsSelector::distance_cutoff_

private

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

Size core::select::residue_selector::NumNeighborsSelector::threshold_

private

Referenced by apply(), and threshold().

---

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

• src/core/select/residue_selector/NumNeighborsSelector.hh
• src/core/select/residue_selector/NumNeighborsSelector.cc