TaskAwareMinMover.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/simple_moves/TaskAwareMinMover.hh
/// @brief MinMover which updates MoveMap to mirror PackerTask
/// @author Steven Lewis

#ifndef INCLUDED_protocols_simple_moves_TaskAwareMinMover_hh
#define INCLUDED_protocols_simple_moves_TaskAwareMinMover_hh

// Unit Headers
#include <protocols/simple_moves/TaskAwareMinMover.fwd.hh>

// Project Headers
#include <core/pose/Pose.fwd.hh>
#include <protocols/moves/Mover.hh>
#include <protocols/simple_moves/MinMover.fwd.hh>
#include <protocols/filters/Filter.fwd.hh>

//#include <core/pack/task/PackerTask.fwd.hh>
#include <core/pack/task/TaskFactory.fwd.hh>

#include <utility/vector1.hh>


// Utility Headers

namespace protocols {
namespace simple_moves {

///@details this class wraps MinMover, but ensures that its MoveMap always contains up-to-date information about sidechain mobility.  It takes its base movemap, allows sidechain freedom at any position mobile in a Factory-generated PackerTask, and passes the new movemap to MinMover.  The MinMover's MoveMap does not accumulate state over many calls to apply().
class TaskAwareMinMover : public protocols::moves::Mover {

public:

  TaskAwareMinMover();

  ///@brief constructor with TaskFactory
  TaskAwareMinMover(
    protocols::simple_moves::MinMoverOP minmover_in,
    core::pack::task::TaskFactoryCOP factory_in
    );

  virtual ~TaskAwareMinMover();

  virtual void apply( core::pose::Pose & pose );
  virtual std::string get_name() const;

  virtual protocols::moves::MoverOP fresh_instance() const;
  virtual protocols::moves::MoverOP clone() const;

  ///@brief parse XML (specifically in the context of the parser/scripting scheme)
  virtual void parse_my_tag(
    TagPtr const,
    protocols::moves::DataMap &,
    Filters_map const &,
    protocols::moves::Movers_map const &,
    Pose const & );

  virtual void parse_def( utility::lua::LuaObject const & def,
    utility::lua::LuaObject const & score_fxns,
    utility::lua::LuaObject const & tasks,
    protocols::moves::MoverCacheSP cache );

  ///@brief parse "task_operations" XML option
  virtual void parse_task_operations(
    TagPtr const,
    protocols::moves::DataMap const &,
    Filters_map const &,
    protocols::moves::Movers_map const &,
    Pose const & );

  void chi( bool val ) { chi_ = val; }
  void bb( bool val ) { bb_ = val; }
  void jump( bool const j ){ jump_ = j; }
  bool chi() const { return chi_; }
  bool bb() const { return bb_; }
  bool jump() const{ return jump_;}

private:
  ///@brief OP for MinMover
  protocols::simple_moves::MinMoverOP minmover_;
  ///@brief OP for constant task factory for nonconstant tasks, if present
  core::pack::task::TaskFactoryCOP factory_;
  bool chi_, bb_, jump_;

};//end TaskAwareMinMover

}//namespace moves
}//namespace protocols

#endif // INCLUDED_protocols_simple_moves_TaskAwareMinMover_HH