core::select::residue_selector::PhiSelector Class Reference

A ResidueSelector that selects alpha-amino acids that are either in the positive phi or negative phi region of Ramachandran space (depending on user preferences). More...

#include <PhiSelector.hh>

Inheritance diagram for core::select::residue_selector::PhiSelector:

Public Member Functions
	PhiSelector ()
	Constructor. More...
	~PhiSelector () override
	Destructor. More...
ResidueSelectorOP	clone () const override
	Clone function. More...
core::select::residue_selector::ResidueSubset	apply (core::pose::Pose const &pose) const override
	"Apply" function. More...
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &datamap) override
	XML parse. More...
std::string	get_name () const override
	Get the mover class name. More...
bool	select_positive_phi () const
	Are we selecting the residues in the positive phi region? More...
void	set_select_positive_phi (bool const setting)
	Set whether we're selecting residues in the positive phi region. More...
bool	ignore_unconnected_upper () const
	Are we ignoring residues with no upper connection? More...
void	set_ignore_unconnected_upper (bool const setting)
	Set whether we're ignoring residues with no upper connection. More...
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 ()
	Get the mover class name. More...
static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
	Provide XSD information, allowing automatic evaluation of bad XML. More...

Private Attributes
bool	select_positive_phi_
	Are we selecting the residues in the positive phi region? More...
bool	ignore_unconnected_upper_
	Are we ignoring residues with no upper connection? More...

Detailed Description

A ResidueSelector that selects alpha-amino acids that are either in the positive phi or negative phi region of Ramachandran space (depending on user preferences).

Constructor & Destructor Documentation

core::select::residue_selector::PhiSelector::PhiSelector

(

)

Constructor.

core::select::residue_selector::PhiSelector::~PhiSelector ( )

overridedefault

Destructor.

Member Function Documentation

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

overridevirtual

"Apply" function.

Given the pose, generate a vector of bools with entries for every residue in the pose indicating whether each residue is selected ("true") or not ("false").

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

References core::conformation::Residue::connected_residue_at_resconn(), core::conformation::Residue::has_lower_connect(), core::conformation::Residue::has_upper_connect(), ignore_unconnected_upper(), core::chemical::ResidueType::is_alpha_aa(), core::chemical::ResidueType::is_beta_aa(), core::chemical::ResidueType::lower_connect_id(), core::pose::Pose::phi(), core::pose::Pose::residue(), core::pose::Pose::residue_type(), select_positive_phi(), core::pose::Pose::size(), core::select::residue_selector::TR(), core::conformation::Residue::type(), and core::chemical::ResidueType::upper_connect_id().

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

static

Get the mover class name.

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

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

overridevirtual

Clone function.

Copy this object and return owning pointer to the copy (created on the heap).

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

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

overridevirtual

Get the mover class name.

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

References class_name().

bool core::select::residue_selector::PhiSelector::ignore_unconnected_upper ( ) const

inline

Are we ignoring residues with no upper connection?

Default true.

References ignore_unconnected_upper_.

Referenced by apply(), and parse_my_tag().

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

overridevirtual

XML parse.

Parse RosettaScripts tags and set up this mover.

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

References ignore_unconnected_upper(), select_positive_phi(), set_ignore_unconnected_upper(), set_select_positive_phi(), and core::select::residue_selector::TR().

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

static

Provide XSD information, allowing automatic evaluation of bad XML.

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

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

bool core::select::residue_selector::PhiSelector::select_positive_phi ( ) const

inline

Are we selecting the residues in the positive phi region?

Default true.

References select_positive_phi_.

Referenced by apply(), and parse_my_tag().

void core::select::residue_selector::PhiSelector::set_ignore_unconnected_upper ( bool const  setting )

inline

Set whether we're ignoring residues with no upper connection.

References ignore_unconnected_upper_.

Referenced by parse_my_tag().

void core::select::residue_selector::PhiSelector::set_select_positive_phi ( bool const  setting )

inline

Set whether we're selecting residues in the positive phi region.

References select_positive_phi_.

Referenced by parse_my_tag().

Member Data Documentation

bool core::select::residue_selector::PhiSelector::ignore_unconnected_upper_

private

Are we ignoring residues with no upper connection?

Default true.

Referenced by ignore_unconnected_upper(), and set_ignore_unconnected_upper().

bool core::select::residue_selector::PhiSelector::select_positive_phi_

private

Are we selecting the residues in the positive phi region?

Default true.

Referenced by select_positive_phi(), and set_select_positive_phi().

---

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

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