Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::residue_selectors::NativeSelector Class Reference

#include <NativeSelector.hh>

Inheritance diagram for protocols::residue_selectors::NativeSelector:
Inheritance graph
[legend]

Public Member Functions

 NativeSelector ()
 Constructor. More...
 
 NativeSelector (NativeSelector const &src)
 
 NativeSelector (core::select::residue_selector::ResidueSelectorCOP inner_selector)
 Constructor that calls set_residue_selector() More...
 
 ~NativeSelector () override
 Destructor. More...
 
core::select::residue_selector::ResidueSelectorOP clone () const override
 Clone function. More...
 
core::select::residue_selector::ResidueSubset apply (core::pose::Pose const &pose) const override
 Calls apply on the inner residue selector but passes the native pose instead of pose. 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
 Get the mover class name. More...
 
void set_native_pose (core::pose::PoseCOP native)
 set the pose that will be passed to the inner residue selector More...
 
void set_residue_selector (core::select::residue_selector::ResidueSelectorCOP selector)
 set the inner residue selector. This selector's apply function will be called with the native pose 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

core::select::residue_selector::ResidueSelectorCOP selector_
 This selector's apply function will be called with the native pose. More...
 
core::pose::PoseCOP native_
 the pose that will be passed to the inner residue selector More...
 

Constructor & Destructor Documentation

protocols::residue_selectors::NativeSelector::NativeSelector ( )

Constructor.

protocols::residue_selectors::NativeSelector::NativeSelector ( NativeSelector const &  src)

References native_, and selector_.

protocols::residue_selectors::NativeSelector::NativeSelector ( core::select::residue_selector::ResidueSelectorCOP  inner_selector)

Constructor that calls set_residue_selector()

protocols::residue_selectors::NativeSelector::~NativeSelector ( )
overridedefault

Destructor.

Member Function Documentation

core::select::residue_selector::ResidueSubset protocols::residue_selectors::NativeSelector::apply ( core::pose::Pose const &  pose) const
overridevirtual

Calls apply on the inner residue selector but passes the native pose instead of pose.

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

References native_, core::import_pose::pose_from_file(), selector_, core::pose::Pose::size(), and protocols::residue_selectors::TR().

std::string protocols::residue_selectors::NativeSelector::class_name ( )
static

Get the mover class name.

Static function to return class name; anything else returning the class name should call this function to avoid discrepancies

Referenced by get_name(), protocols::residue_selectors::NativeSelectorCreator::keyname(), and provide_xml_schema().

core::select::residue_selector::ResidueSelectorOP protocols::residue_selectors::NativeSelector::clone ( ) const
overridevirtual

Clone function.

Copy this object and return owning pointer to the copy.

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

std::string protocols::residue_selectors::NativeSelector::get_name ( ) const
overridevirtual

Get the mover class name.

Non-static function to return class name

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

References class_name().

void protocols::residue_selectors::NativeSelector::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 core::select::residue_selector::get_residue_selector(), core::pose::saved_native_pose(), set_native_pose(), and set_residue_selector().

void protocols::residue_selectors::NativeSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::residue_selectors::NativeSelector::set_native_pose ( core::pose::PoseCOP  native)
inline

set the pose that will be passed to the inner residue selector

References native_.

Referenced by parse_my_tag().

void protocols::residue_selectors::NativeSelector::set_residue_selector ( core::select::residue_selector::ResidueSelectorCOP  selector)
inline

set the inner residue selector. This selector's apply function will be called with the native pose

References selector_.

Referenced by parse_my_tag().

Member Data Documentation

core::pose::PoseCOP protocols::residue_selectors::NativeSelector::native_
mutableprivate

the pose that will be passed to the inner residue selector

this element is marked as mutable so that we can load it at apply-time if a value is not given

Referenced by apply(), NativeSelector(), and set_native_pose().

core::select::residue_selector::ResidueSelectorCOP protocols::residue_selectors::NativeSelector::selector_
private

This selector's apply function will be called with the native pose.

Referenced by apply(), NativeSelector(), and set_residue_selector().


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