core::pack::task::residue_selector::NeighborhoodResidueSelector Class Reference

The NeighborhoodResidueSelector selects residues neighboring a defined set of residues (the focus). The focus residue set can be obtained from another ResidueSelector, from a std::set of residue positions or from a string specifying residue positions. More...

#include <NeighborhoodResidueSelector.hh>

Public Member Functions
	NeighborhoodResidueSelector ()
	NeighborhoodResidueSelector (std::set< core::Size > const &focus, Real distance)
virtual	~NeighborhoodResidueSelector ()
virtual void	apply (core::pose::Pose const &pose, ResidueSubset &subset) const
	Make modifications to the subset vector given an input pose. The input ResidueSubset should already be of size pose.total_residue() More...
virtual void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datamap)
	Initialize any data members of this instance from an input tag and a DataMap object. More...
virtual std::string	get_name () const
void	set_focus (std::set< Size > const &focus)
	adds a ResidueSelector More...
void	set_focus (std::string const &focus_str)
void	set_focus_selector (ResidueSelectorCOP rs)
void	set_distance (Real distance)
Public Member Functions inherited from core::pack::task::residue_selector::ResidueSelector
	ResidueSelector ()
virtual	~ResidueSelector ()

Static Public Member Functions
static std::string	class_name ()

Private Member Functions
void	get_focus (core::pose::Pose const &, ResidueSubset &, std::set< Size > &) const

Private Attributes
std::set< Size >	focus_
std::string	focus_str_
Real	distance_
ResidueSelectorCOP	focus_selector_
bool	focus_set_
bool	use_focus_selector_

Detailed Description

The NeighborhoodResidueSelector selects residues neighboring a defined set of residues (the focus). The focus residue set can be obtained from another ResidueSelector, from a std::set of residue positions or from a string specifying residue positions.

Constructor & Destructor Documentation

core::pack::task::residue_selector::NeighborhoodResidueSelector::NeighborhoodResidueSelector

(

)

core::pack::task::residue_selector::NeighborhoodResidueSelector::NeighborhoodResidueSelector	(	std::set< core::Size > const &	focus,
		Real	distance
	)

References set_distance(), and set_focus().

core::pack::task::residue_selector::NeighborhoodResidueSelector::~NeighborhoodResidueSelector ( )

virtual

Member Function Documentation

void core::pack::task::residue_selector::NeighborhoodResidueSelector::apply ( core::pose::Pose const &  pose, ResidueSubset &  subset  ) const

virtual

Make modifications to the subset vector given an input pose. The input ResidueSubset should already be of size pose.total_residue()

Implements core::pack::task::residue_selector::ResidueSelector.

References distance_, distance_squared(), focus_set_, get_focus(), r1, r2, core::pose::Pose::residue(), and core::pose::Pose::total_residue().

std::string core::pack::task::residue_selector::NeighborhoodResidueSelector::class_name ( )

static

Referenced by get_name(), and core::pack::task::residue_selector::NeighborhoodResidueSelectorCreator::keyname().

void core::pack::task::residue_selector::NeighborhoodResidueSelector::get_focus ( core::pose::Pose const &  pose, ResidueSubset &  subset, std::set< Size > &  focus  ) const

private

References focus_, focus_selector_, focus_str_, core::pose::get_resnum_list(), and use_focus_selector_.

Referenced by apply().

std::string core::pack::task::residue_selector::NeighborhoodResidueSelector::get_name ( ) const

virtual

Implements core::pack::task::residue_selector::ResidueSelector.

References class_name().

void core::pack::task::residue_selector::NeighborhoodResidueSelector::parse_my_tag ( utility::tag::TagCOP  tag, basic::datacache::DataMap &  datacache  )

virtual

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::pack::task::residue_selector::ResidueSelector.

References basic::datacache::DataMap::get(), core::pack::task::residue_selector::ResidueSelectorFactory::get_instance(), core::pack::task::residue_selector::ResidueSelectorFactory::new_residue_selector(), set_distance(), set_focus(), set_focus_selector(), and tags.

void core::pack::task::residue_selector::NeighborhoodResidueSelector::set_distance

(

Real

distance

)

References core::kinematics::distance(), and distance_.

Referenced by NeighborhoodResidueSelector(), and parse_my_tag().

void core::pack::task::residue_selector::NeighborhoodResidueSelector::set_focus

(

std::set< Size > const &

focus

)

adds a ResidueSelector

References focus_, focus_set_, and use_focus_selector_.

Referenced by NeighborhoodResidueSelector(), and parse_my_tag().

void core::pack::task::residue_selector::NeighborhoodResidueSelector::set_focus

(

std::string const &

focus_str

)

References focus_set_, focus_str_, and use_focus_selector_.

void core::pack::task::residue_selector::NeighborhoodResidueSelector::set_focus_selector

(

ResidueSelectorCOP

rs

)

References focus_selector_, focus_set_, and use_focus_selector_.

Referenced by parse_my_tag().

Member Data Documentation

Real core::pack::task::residue_selector::NeighborhoodResidueSelector::distance_

private

Referenced by apply(), and set_distance().

std::set< Size > core::pack::task::residue_selector::NeighborhoodResidueSelector::focus_

private

Referenced by get_focus(), and set_focus().

ResidueSelectorCOP core::pack::task::residue_selector::NeighborhoodResidueSelector::focus_selector_

private

Referenced by get_focus(), and set_focus_selector().

bool core::pack::task::residue_selector::NeighborhoodResidueSelector::focus_set_

private

Referenced by apply(), set_focus(), and set_focus_selector().

std::string core::pack::task::residue_selector::NeighborhoodResidueSelector::focus_str_

private

Referenced by get_focus(), and set_focus().

bool core::pack::task::residue_selector::NeighborhoodResidueSelector::use_focus_selector_

private

Referenced by get_focus(), set_focus(), and set_focus_selector().

---

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

• symlinks/rosetta/src/core/pack/task/residue_selector/NeighborhoodResidueSelector.hh
• symlinks/rosetta/src/core/pack/task/residue_selector/NeighborhoodResidueSelector.cc