Rosetta  2020.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
core::pack::task::operation::RestrictToResidueProperties Class Reference

Restrict the palette of ResidueTypes to those with the given properties. More...

#include <TaskOperations.hh>

Inheritance diagram for core::pack::task::operation::RestrictToResidueProperties:
Inheritance graph
[legend]

Public Types

typedef TaskOperation parent
 
- Public Types inherited from core::pack::task::operation::TaskOperation
typedef utility::tag::TagCOP TagCOP
 
typedef basic::datacache::DataMap DataMap
 
typedef pose::Pose Pose
 

Public Member Functions

 RestrictToResidueProperties ()
 BEGIN RestrictToResidueProperties. More...
 
 RestrictToResidueProperties (RestrictToResidueProperties const &object_to_copy)
 
 RestrictToResidueProperties (utility::vector1< core::chemical::ResidueProperty > const &properties)
 
 RestrictToResidueProperties (utility::vector1< core::chemical::ResidueProperty > const &properties, core::select::residue_selector::ResidueSelectorCOP selector)
 
 ~RestrictToResidueProperties () override=default
 
TaskOperationOP clone () const override
 Create another task operation of the type matching the most-derived version of the class. More...
 
void apply (pose::Pose const &pose, PackerTask &task) const override
 Change a packer task in some way. The input pose is the one to which the input task will be later applied. More...
 
void parse_tag (TagCOP tag, DataMap &map) override
 Used to parse an xml-like tag to load parameters and properties. More...
 
void set_properties (utility::vector1< core::chemical::ResidueProperty > const &properties)
 
utility::vector1
< core::chemical::ResidueProperty >
const & 
properties () const
 
void set_selector (core::select::residue_selector::ResidueSelectorCOP selector)
 
core::select::residue_selector::ResidueSelectorCOP selector () const
 
- Public Member Functions inherited from core::pack::task::operation::TaskOperation
 ~TaskOperation () override
 
virtual bool task_operation_provides_citation_info () const
 Does this task operation provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool task_operation_is_unpublished () const
 Does this task_operation indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Static Public Member Functions

static std::string keyname ()
 
static utility::tag::AttributeList xml_schema_attributes ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Attributes

utility::vector1
< core::chemical::ResidueProperty
properties_
 
core::select::residue_selector::ResidueSelectorCOP selector_
 

Detailed Description

Restrict the palette of ResidueTypes to those with the given properties.

Author
Labonte JWLab.nosp@m.onte.nosp@m.@jhu..nosp@m.edu

Member Typedef Documentation

Constructor & Destructor Documentation

core::pack::task::operation::RestrictToResidueProperties::RestrictToResidueProperties ( )
core::pack::task::operation::RestrictToResidueProperties::RestrictToResidueProperties ( RestrictToResidueProperties const &  object_to_copy)

References properties_, and selector_.

core::pack::task::operation::RestrictToResidueProperties::RestrictToResidueProperties ( utility::vector1< core::chemical::ResidueProperty > const &  properties)
core::pack::task::operation::RestrictToResidueProperties::RestrictToResidueProperties ( utility::vector1< core::chemical::ResidueProperty > const &  properties,
core::select::residue_selector::ResidueSelectorCOP  selector 
)
core::pack::task::operation::RestrictToResidueProperties::~RestrictToResidueProperties ( )
overridedefault

Member Function Documentation

void core::pack::task::operation::RestrictToResidueProperties::apply ( pose::Pose const &  ,
PackerTask  
) const
overridevirtual

Change a packer task in some way. The input pose is the one to which the input task will be later applied.

Implements core::pack::task::operation::TaskOperation.

References core::pack::task::PackerTask::nonconst_residue_task(), properties_, core::pack::task::ResidueLevelTask::restrict_to_restypes_with_all_properties(), selector_, and core::pose::Pose::size().

TaskOperationOP core::pack::task::operation::RestrictToResidueProperties::clone ( ) const
overridevirtual

Create another task operation of the type matching the most-derived version of the class.

Implements core::pack::task::operation::TaskOperation.

std::string core::pack::task::operation::RestrictToResidueProperties::keyname ( )
static
void core::pack::task::operation::RestrictToResidueProperties::parse_tag ( TagCOP  tag,
DataMap  
)
overridevirtual
utility::vector1< core::chemical::ResidueProperty > const& core::pack::task::operation::RestrictToResidueProperties::properties ( ) const
inline

References properties_.

Referenced by set_properties().

void core::pack::task::operation::RestrictToResidueProperties::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
core::select::residue_selector::ResidueSelectorCOP core::pack::task::operation::RestrictToResidueProperties::selector ( ) const
inline

References selector_.

void core::pack::task::operation::RestrictToResidueProperties::set_properties ( utility::vector1< core::chemical::ResidueProperty > const &  properties)
inline

References properties(), and properties_.

void core::pack::task::operation::RestrictToResidueProperties::set_selector ( core::select::residue_selector::ResidueSelectorCOP  selector)

References selector_.

Referenced by parse_tag().

utility::tag::AttributeList core::pack::task::operation::RestrictToResidueProperties::xml_schema_attributes ( )
static

Referenced by provide_xml_schema().

Member Data Documentation

utility::vector1< core::chemical::ResidueProperty > core::pack::task::operation::RestrictToResidueProperties::properties_
private
core::select::residue_selector::ResidueSelectorCOP core::pack::task::operation::RestrictToResidueProperties::selector_
private

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