Rosetta
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
core::select::residue_selector::FractionSelector Class Reference

Selects only either the first or the last residue selected by a provided ResidueSelector. More...

#include <FractionSelector.hh>

Inheritance diagram for core::select::residue_selector::FractionSelector:
Inheritance graph
[legend]

Public Types

typedef core::select::residue_selector::ResidueSelectorOP ResidueSelectorOP
 
typedef core::select::residue_selector::ResidueSubset ResidueSubset
 

Public Member Functions

 FractionSelector ()
 Constructor. More...
 
 ~FractionSelector () override
 Copy Constructor. Usually not necessary unless you need deep copying (e.g. OPs) More...
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
ResidueSubset apply (core::pose::Pose const &pose) const override
 "Apply" function. More...
 
void set_first (bool first)
 
void set_N (core::Size N)
 
void set_fraction (core::Real fraction)
 
void set_selector (core::select::residue_selector::ResidueSelectorCOP selector)
 
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...
 
- Public Member Functions inherited from core::select::residue_selector::ResidueSelector
 ResidueSelector ()
 Constructor. More...
 
 ~ResidueSelector () override
 Destructor. More...
 
utility::vector1< core::Sizeselection_positions (core::pose::Pose const &pose) const
 Calls apply and returns the Rosetta numbering corresponding to the selected residues. 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, enabling mechanical validation of input XML. More...
 

Private Attributes

bool first_ = true
 
core::Size N_ = 1
 
core::Real fraction_ = 1
 
core::select::residue_selector::ResidueSelectorCOP selector_
 

Detailed Description

Selects only either the first or the last residue selected by a provided ResidueSelector.

Member Typedef Documentation

◆ ResidueSelectorOP

◆ ResidueSubset

Constructor & Destructor Documentation

◆ FractionSelector()

core::select::residue_selector::FractionSelector::FractionSelector ( )

Constructor.

Referenced by clone().

◆ ~FractionSelector()

core::select::residue_selector::FractionSelector::~FractionSelector ( )
override

Copy Constructor. Usually not necessary unless you need deep copying (e.g. OPs)

Destructor.

Member Function Documentation

◆ apply()

FractionSelector::ResidueSubset core::select::residue_selector::FractionSelector::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 first_, fraction_, N_, selector_, core::pose::Pose::size(), and core::pose::Pose::total_residue().

◆ class_name()

std::string core::select::residue_selector::FractionSelector::class_name ( )
static

◆ clone()

core::select::residue_selector::ResidueSelectorOP core::select::residue_selector::FractionSelector::clone ( ) const
overridevirtual

Clone operator.

Copy Constructor. Usually not necessary unless you need deep copying (e.g. OPs)

Copy the current object (creating the copy on the heap) and return an owning pointer to the copy. All ResidueSelectors must implement this.

Clone function.

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

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

References FractionSelector().

◆ get_name()

std::string core::select::residue_selector::FractionSelector::get_name ( ) const
overridevirtual

Get the mover class name.

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

References class_name().

◆ parse_my_tag()

void core::select::residue_selector::FractionSelector::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 first_, fraction_, core::select::residue_selector::get_residue_selector(), N_, and selector_.

◆ provide_xml_schema()

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

◆ set_first()

void core::select::residue_selector::FractionSelector::set_first ( bool  first)

References first_.

◆ set_fraction()

void core::select::residue_selector::FractionSelector::set_fraction ( core::Real  fraction)

References fraction_.

◆ set_N()

void core::select::residue_selector::FractionSelector::set_N ( core::Size  N)

References core::chemical::element::N, and N_.

◆ set_selector()

void core::select::residue_selector::FractionSelector::set_selector ( core::select::residue_selector::ResidueSelectorCOP  selector)

References selector_.

Member Data Documentation

◆ first_

bool core::select::residue_selector::FractionSelector::first_ = true
private

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

◆ fraction_

core::Real core::select::residue_selector::FractionSelector::fraction_ = 1
private

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

◆ N_

core::Size core::select::residue_selector::FractionSelector::N_ = 1
private

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

◆ selector_

core::select::residue_selector::ResidueSelectorCOP core::select::residue_selector::FractionSelector::selector_
private

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


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