Rosetta  2021.16
 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
protocols::simple_task_operations::RestrictToLoopsAndNeighbors Class Reference

This class allows the selection for packing (and possibly design) of residues contained in a Loops object as well as the neighbors within a specified cutoff distance, with the default and maximum cutoff at 10.0 A. More...

#include <RestrictToLoopsAndNeighbors.hh>

Inheritance diagram for protocols::simple_task_operations::RestrictToLoopsAndNeighbors:
Inheritance graph

Public Types

typedef RestrictToLoops parent
- Public Types inherited from protocols::simple_task_operations::RestrictToLoops
- 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

 RestrictToLoopsAndNeighbors ()=default
 Default constructor. More...
core::pack::task::operation::TaskOperationOP clone () const override
 Return a deep-copied OP. More...
void parse_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Configure from a RosettaScripts XML tag. More...
void apply (core::pose::Pose const &pose, core::pack::task::PackerTask &task) const override
 Apply this operation to the packer task. More...
bool include_neighbors () const
void set_include_neighbors (bool include_neighbors)
bool design_neighbors () const
void set_design_neighbors (bool design_neighbors)
core::Real cutoff_distance () const
void set_cutoff_distance (core::Real cutoff_distance)
- Public Member Functions inherited from protocols::simple_task_operations::RestrictToLoops
 RestrictToLoops ()=default
 Default constructor. More...
bool design_loop () const
 Return true if design is allowed. More...
void set_design_loop (bool design_loop)
 Specify whether or not design is allowed. More...
loops::LoopsCOP loops () const
 Return the loops allowed to pack. More...
void set_loops (loops::LoopsCOP loops)
 Specify the loops that will be allowed to pack. More...
void set_loops_from_file (std::string loops_file)
 Specify the loops that will be allowed to pack. More...
bool restrict_only_design_to_loops () const
 Return true if we are restricting to only design. AKA RestrictDesignToLoops. More...
void set_restrict_only_design_to_loops (bool restrict_only_design)
 Specify whether to restrict only design to loops/neighbors AKA RestrictDesignToLoops. Does not disable packing for any residue. Implies and sets design_loop to true. More...
- Public Member Functions inherited from core::pack::task::operation::TaskOperation
 ~TaskOperation () override
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 void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
static std::string keyname ()
- Static Public Member Functions inherited from protocols::simple_task_operations::RestrictToLoops
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
static void provide_attributes (utility::tag::AttributeList &attributes)
static std::string keyname ()

Private Attributes

bool include_neighbors_ = true
bool design_neighbors_ = false
core::Real cutoff_distance_ = 10.0

Additional Inherited Members

- Protected Member Functions inherited from protocols::simple_task_operations::RestrictToLoops
void apply_helper (core::pose::Pose const &pose, core::pack::task::PackerTask &task, bool include_neighbors, core::Real cutoff_distance, bool design_neighbors) const
 Helper function to prevent code duplication in subclasses. More...

Detailed Description

This class allows the selection for packing (and possibly design) of residues contained in a Loops object as well as the neighbors within a specified cutoff distance, with the default and maximum cutoff at 10.0 A.

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::simple_task_operations::RestrictToLoopsAndNeighbors::RestrictToLoopsAndNeighbors ( )

Default constructor.

Member Function Documentation

void protocols::simple_task_operations::RestrictToLoopsAndNeighbors::apply ( core::pose::Pose const &  pose,
core::pack::task::PackerTask task 
) const

Apply this operation to the packer task.

Reimplemented from protocols::simple_task_operations::RestrictToLoops.

TaskOperationOP protocols::simple_task_operations::RestrictToLoopsAndNeighbors::clone ( ) const

Return a deep-copied OP.

Reimplemented from protocols::simple_task_operations::RestrictToLoops.

core::Real protocols::simple_task_operations::RestrictToLoopsAndNeighbors::cutoff_distance ( ) const
bool protocols::simple_task_operations::RestrictToLoopsAndNeighbors::design_neighbors ( ) const
bool protocols::simple_task_operations::RestrictToLoopsAndNeighbors::include_neighbors ( ) const
static std::string protocols::simple_task_operations::RestrictToLoopsAndNeighbors::keyname ( )
void protocols::simple_task_operations::RestrictToLoopsAndNeighbors::parse_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 

Configure from a RosettaScripts XML tag.

Reimplemented from protocols::simple_task_operations::RestrictToLoops.

void protocols::simple_task_operations::RestrictToLoopsAndNeighbors::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
void protocols::simple_task_operations::RestrictToLoopsAndNeighbors::set_cutoff_distance ( core::Real  cutoff_distance)
void protocols::simple_task_operations::RestrictToLoopsAndNeighbors::set_design_neighbors ( bool  design_neighbors)
void protocols::simple_task_operations::RestrictToLoopsAndNeighbors::set_include_neighbors ( bool  include_neighbors)

Member Data Documentation

core::Real protocols::simple_task_operations::RestrictToLoopsAndNeighbors::cutoff_distance_ = 10.0
bool protocols::simple_task_operations::RestrictToLoopsAndNeighbors::design_neighbors_ = false
bool protocols::simple_task_operations::RestrictToLoopsAndNeighbors::include_neighbors_ = true

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