Rosetta  2020.37
 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
core::select::residue_selector::NotResidueSelector Class Reference

The NotResidueSelector negates the input of one loaded ResidueSelector, i.e., it is a logical NOT - it selects all unselected residues and deselects the selected ones. True becomes false, false becomes true. The ResidueSelector to be negated can be pulled in through RosettaScipt using the selector option, subtags for ResidueSelectors known to the ResidueSelectorFactory or programmatically using set_residue_selector. Note that since most ResidueSelectors clear the input ResidueSubset, NOT can be thought of as simply selecting the opposite of the passed in selector. More...

#include <NotResidueSelector.hh>

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

Public Member Functions

 NotResidueSelector ()
 
 NotResidueSelector (NotResidueSelector const &src)
 Copy constructor. More...
 
ResidueSelectorOP clone () const override
 Clone operator. More...
 
 NotResidueSelector (ResidueSelectorCOP selector)
 
 ~NotResidueSelector () override
 
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)
 sets a ResidueSelector More...
 
utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const override
 Provide the citation. More...
 
utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const override
 Provide a list of authors and their e-mail addresses, as strings. More...
 
- Public Member Functions inherited from core::select::residue_selector::ResidueSelector
 ResidueSelector ()
 Constructor. More...
 
 ~ResidueSelector () override
 Destructor. More...
 
virtual bool residue_selector_provides_citation_info () const
 Does this residue selector provide information about how to cite it? More...
 
virtual bool residue_selector_is_unpublished () const
 Does this residue selector indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 

Static Public Member Functions

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

Private Attributes

ResidueSelectorCOP selector_
 

Detailed Description

The NotResidueSelector negates the input of one loaded ResidueSelector, i.e., it is a logical NOT - it selects all unselected residues and deselects the selected ones. True becomes false, false becomes true. The ResidueSelector to be negated can be pulled in through RosettaScipt using the selector option, subtags for ResidueSelectors known to the ResidueSelectorFactory or programmatically using set_residue_selector. Note that since most ResidueSelectors clear the input ResidueSubset, NOT can be thought of as simply selecting the opposite of the passed in selector.

Constructor & Destructor Documentation

core::select::residue_selector::NotResidueSelector::NotResidueSelector ( )
default
core::select::residue_selector::NotResidueSelector::NotResidueSelector ( NotResidueSelector const &  src)

Copy constructor.

core::select::residue_selector::NotResidueSelector::NotResidueSelector ( ResidueSelectorCOP  selector)
core::select::residue_selector::NotResidueSelector::~NotResidueSelector ( )
overridedefault

Member Function Documentation

ResidueSubset core::select::residue_selector::NotResidueSelector::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 selector_.

std::string core::select::residue_selector::NotResidueSelector::class_name ( )
static
ResidueSelectorOP core::select::residue_selector::NotResidueSelector::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::NotResidueSelector::get_name ( ) const
overridevirtual
void core::select::residue_selector::NotResidueSelector::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(), selector_, and set_residue_selector().

utility::vector1< basic::citation_manager::UnpublishedModuleInfoCOP > core::select::residue_selector::NotResidueSelector::provide_authorship_info_for_unpublished ( ) const
overridevirtual

Provide a list of authors and their e-mail addresses, as strings.

Returns
An empty list for this residue selector. Unpublished information for residue selectors that it contains.
Author
Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

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

References selector_.

utility::vector1< basic::citation_manager::CitationCollectionCOP > core::select::residue_selector::NotResidueSelector::provide_citation_info ( ) const
overridevirtual

Provide the citation.

Returns
A vector of citation collections. This allows the residue selector to provide citations for itself and for any modules that it invokes.

This residue selector provides no citation information of its own, but it can provide citation information for the residue selectors that it contains.

Author
Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

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

References selector_.

void core::select::residue_selector::NotResidueSelector::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void core::select::residue_selector::NotResidueSelector::set_residue_selector ( ResidueSelectorCOP  selector)

sets a ResidueSelector

References selector_.

Referenced by NotResidueSelector(), and parse_my_tag().

Member Data Documentation

ResidueSelectorCOP core::select::residue_selector::NotResidueSelector::selector_
private

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