Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
core::select::residue_selector::SliceResidueSelector Class Reference

The SliceResidueSelector allows slicing of the returned values of other residue selectors. More...

#include <SliceResidueSelector.hh>

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

Public Member Functions

 SliceResidueSelector ()
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
 SliceResidueSelector (ResidueSelectorCOP const &selector, slice_enums::SliceMode slice_mode, int from, int to, slice_enums::OutOfBoundsMode oob_mode=slice_enums::ERROR)
 
 SliceResidueSelector (ResidueSelectorCOP selector, slice_enums::SliceMode slice_mode, utility::vector1< int > const &indices, slice_enums::OutOfBoundsMode oob_mode=slice_enums::ERROR)
 
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
 
void set_residue_selector (ResidueSelectorCOP selector)
 
void set_slice_mode (slice_enums::SliceMode slice_mode)
 
void set_from (int from)
 
void set_to (int to)
 
void set_indices (utility::vector1< int > const &indices)
 
void set_out_of_bounds_behavior (slice_enums::OutOfBoundsMode oob_mode)
 
void provide_citation_info (basic::citation_manager::CitationCollectionList &) const override
 Provide the citation. More...
 
- Public Member Functions inherited from core::select::residue_selector::ResidueSelector
 ResidueSelector ()
 Constructor. More...
 
 ~ResidueSelector () override
 Destructor. More...
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Member Functions

int wrap_index (int index, int elements, utility::vector1< std::string > &error_messages) const
 
void show_selection_logic (ResidueSubset const &initial, ResidueSubset const &final) const
 

Private Attributes

ResidueSelectorCOP selector_
 
slice_enums::SliceMode slice_mode_
 
int from_
 
int to_
 
utility::vector1< int > indices_
 
slice_enums::OutOfBoundsMode oob_mode_
 

Detailed Description

The SliceResidueSelector allows slicing of the returned values of other residue selectors.

Constructor & Destructor Documentation

core::select::residue_selector::SliceResidueSelector::SliceResidueSelector ( )
core::select::residue_selector::SliceResidueSelector::SliceResidueSelector ( ResidueSelectorCOP const &  selector,
slice_enums::SliceMode  slice_mode,
int  from,
int  to,
slice_enums::OutOfBoundsMode  oob_mode = slice_enums::ERROR 
)
core::select::residue_selector::SliceResidueSelector::SliceResidueSelector ( ResidueSelectorCOP  selector,
slice_enums::SliceMode  slice_mode,
utility::vector1< int > const &  indices,
slice_enums::OutOfBoundsMode  oob_mode = slice_enums::ERROR 
)

Member Function Documentation

ResidueSubset core::select::residue_selector::SliceResidueSelector::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 core::select::residue_selector::slice_enums::CONTIGUOUS, core::select::residue_selector::slice_enums::ERROR, from_, core::select::get_residues_from_subset(), indices_, oob_mode_, selector_, show_selection_logic(), core::pose::Pose::size(), slice_mode_, core::select::residue_selector::slice_enums::SPARSE, to_, core::id::to_string(), core::select::residue_selector::TR(), core::select::residue_selector::slice_enums::WARN, and wrap_index().

std::string core::select::residue_selector::SliceResidueSelector::class_name ( )
static
ResidueSelectorOP core::select::residue_selector::SliceResidueSelector::clone ( ) const
overridevirtual

Clone operator.

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

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

std::string core::select::residue_selector::SliceResidueSelector::get_name ( ) const
overridevirtual
void core::select::residue_selector::SliceResidueSelector::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  datacache 
)
overridevirtual
void core::select::residue_selector::SliceResidueSelector::provide_citation_info ( basic::citation_manager::CitationCollectionList &  citations) const
overridevirtual

Provide the citation.

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

References selector_.

void core::select::residue_selector::SliceResidueSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::select::residue_selector::SliceResidueSelector::set_from ( int  from)

References from_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_indices ( utility::vector1< int > const &  indices)

References indices_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_out_of_bounds_behavior ( slice_enums::OutOfBoundsMode  oob_mode)

References oob_mode_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_residue_selector ( ResidueSelectorCOP  selector)

References selector_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_slice_mode ( slice_enums::SliceMode  slice_mode)

References slice_mode_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::set_to ( int  to)

References to_.

Referenced by parse_my_tag().

void core::select::residue_selector::SliceResidueSelector::show_selection_logic ( ResidueSubset const &  initial,
ResidueSubset const &  final 
) const
private
int core::select::residue_selector::SliceResidueSelector::wrap_index ( int  index,
int  elements,
utility::vector1< std::string > &  error_messages 
) const
private

Member Data Documentation

int core::select::residue_selector::SliceResidueSelector::from_
private

Referenced by apply(), and set_from().

utility::vector1< int > core::select::residue_selector::SliceResidueSelector::indices_
private

Referenced by apply(), and set_indices().

slice_enums::OutOfBoundsMode core::select::residue_selector::SliceResidueSelector::oob_mode_
private
ResidueSelectorCOP core::select::residue_selector::SliceResidueSelector::selector_
private
slice_enums::SliceMode core::select::residue_selector::SliceResidueSelector::slice_mode_
private

Referenced by apply(), and set_slice_mode().

int core::select::residue_selector::SliceResidueSelector::to_
private

Referenced by apply(), and set_to().


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