RestrictToLoopsAndNeighbors.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file   protocols/toolbox/task_operations/RestrictToLoopsAndNeighbors.hh
/// @brief  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.
/// @author Brian D. Weitzner (brian.weitzner@gmail.com)

#ifndef INCLUDED_protocols_toolbox_task_operations_RestrictToLoopsAndNeighbors_HH
#define INCLUDED_protocols_toolbox_task_operations_RestrictToLoopsAndNeighbors_HH

// Unit headers
#include <protocols/toolbox/task_operations/RestrictToLoopsAndNeighbors.fwd.hh>
#include <core/pack/task/operation/TaskOperation.hh>

// Package headers
#include <protocols/loops/Loops.fwd.hh>

// Project headers
#include <core/pack/task/PackerTask.fwd.hh>
#include <core/pose/Pose.fwd.hh>
#include <core/types.hh>

// Utility headers
#include <utility/tag/Tag.fwd.hh>

// C++ headers

namespace protocols {
namespace toolbox {
namespace task_operations {

class RestrictToLoopsAndNeighbors : public core::pack::task::operation::TaskOperation
{
public:
  typedef core::pack::task::operation::TaskOperation parent;

public:
  // default constructor
  RestrictToLoopsAndNeighbors();

  // copy constructor
  RestrictToLoopsAndNeighbors(RestrictToLoopsAndNeighbors const & src);

  // destructor
  virtual ~RestrictToLoopsAndNeighbors();

  // assignment operator
  RestrictToLoopsAndNeighbors & operator=( RestrictToLoopsAndNeighbors const & rhs );

  virtual core::pack::task::operation::TaskOperationOP clone() const;

  virtual
  void
  apply(core::pose::Pose const & pose, core::pack::task::PackerTask & task) const;

  bool design_loop() const;
  void set_design_loop( bool design_loop );

  bool include_neighbors() const;
  void set_include_neighbors( bool include_neighbors );

  core::Real cutoff_distance() const;
  void set_cutoff_distance( core::Real cutoff_distance );

  loops::LoopsCOP loops() const;
  void set_loops( loops::LoopsCOP loops );
private:
  void init();
  void init_for_equal_operator_and_copy_constructor( RestrictToLoopsAndNeighbors & lhs, RestrictToLoopsAndNeighbors const & rhs);
  
private:
  bool design_loop_;
  bool include_neighbors_;
  core::Real cutoff_distance_;
  loops::LoopsCOP loops_;

};

} //namespace task_operations
} //namespace toolbox
} //namespace protocols

#endif // INCLUDED_protocols_toolbox_task_operations_RestrictToLoopsAndNeighbors_HH