Rosetta Protocols  2014.35
Public Member Functions | Private Attributes | List of all members
protocols::simple_moves::TaskAwareMinMover Class Reference

#include <TaskAwareMinMover.hh>

Public Member Functions

 TaskAwareMinMover ()
 
 TaskAwareMinMover (protocols::simple_moves::MinMoverOP minmover_in, core::pack::task::TaskFactoryCOP factory_in)
 constructor with TaskFactory More...
 
virtual ~TaskAwareMinMover ()
 
virtual void apply (core::pose::Pose &pose)
 
virtual std::string get_name () const
 Each derived class must specify its name. The class name. More...
 
virtual protocols::moves::MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. More...
 
virtual protocols::moves::MoverOP clone () const
 Return a clone of the Mover object. More...
 
virtual void parse_my_tag (TagCOP, basic::datacache::DataMap &, Filters_map const &, protocols::moves::Movers_map const &, Pose const &)
 parse XML (specifically in the context of the parser/scripting scheme) More...
 
virtual void parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, protocols::moves::MoverCacheSP cache)
 
virtual void parse_task_operations (TagCOP, basic::datacache::DataMap const &, Filters_map const &, protocols::moves::Movers_map const &, Pose const &)
 parse "task_operations" XML option More...
 
void chi (bool val)
 
void bb (bool val)
 
void jump (bool const j)
 
bool chi () const
 
bool bb () const
 
bool jump () const
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual ~Mover ()
 
virtual MoverSP create ()
 
virtual void apply (core::io::serialization::PipeMap &pmap)
 
virtual void parse_state (SerializableState const &state)
 
virtual void save_state (SerializableState &state)
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
 Mover (Mover const &other)
 
Moveroperator= (Mover const &other)
 assignment operator More...
 
virtual core::Real last_proposal_density_ratio ()
 
std::string const & type () const
 
void set_type (std::string const &setting)
 
std::string get_current_tag () const
 A tag is a unique identifier used to identify structures produced by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor. More...
 
void set_current_tag (std::string const &new_tag)
 
virtual void set_input_pose (PoseCOP pose)
 setter for poses contained for rms More...
 
virtual void set_native_pose (PoseCOP pose)
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
virtual void test_move (Pose &pose)
 : Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...
 
void type (const std::string &type_in)
 
std::string get_type () const
 
MoverStatus get_last_move_status () const
 end parser interface, start Job Distributor interface///////////// More...
 
void reset_status ()
 resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s. More...
 
virtual core::pose::PoseOP get_additional_output ()
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
virtual void clear_info ()
 Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file. More...
 
virtual Stringsinfo ()
 non-const accessor More...
 
virtual Strings const & info () const
 const accessor More...
 
virtual bool reinitialize_for_each_job () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...
 
virtual bool reinitialize_for_new_input () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be regenerated when the input pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose). More...
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 
virtual void show (std::ostream &output=std::cout) const
 Outputs details about the Mover, including current settings. More...
 

Private Attributes

protocols::simple_moves::MinMoverOP minmover_
 OP for MinMover. More...
 
core::pack::task::TaskFactoryCOP factory_
 OP for constant task factory for nonconstant tasks, if present. More...
 
bool chi_
 
bool bb_
 
bool jump_
 

Additional Inherited Members

- Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP TagCOP
 
typedef core::pose::Pose Pose
 
typedef core::pose::PoseCOP PoseCOP
 
typedef
protocols::filters::Filters_map 
Filters_map
 
typedef std::list< std::stringStrings
 
- Static Public Member Functions inherited from protocols::moves::Mover
static std::string name ()
 
static void register_options ()
 Overload this static method if you access options within the mover. More...
 
- Protected Member Functions inherited from protocols::moves::Mover
void set_last_move_status (MoverStatus status)
 nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...
 

Detailed Description

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().

Constructor & Destructor Documentation

protocols::simple_moves::TaskAwareMinMover::TaskAwareMinMover ( )

Referenced by fresh_instance().

protocols::simple_moves::TaskAwareMinMover::TaskAwareMinMover ( protocols::simple_moves::MinMoverOP  minmover_in,
core::pack::task::TaskFactoryCOP  factory_in 
)

constructor with TaskFactory

References protocols::moves::Mover::type().

protocols::simple_moves::TaskAwareMinMover::~TaskAwareMinMover ( )
virtual

Member Function Documentation

void protocols::simple_moves::TaskAwareMinMover::apply ( core::pose::Pose pose)
virtual

apply will extract the movemap from your minmover, modify it to include sidechain DOFs that are packable according to some TaskFactory, run the minmover with this movemap, and revert the minmover to its original movemap.

Implements protocols::moves::Mover.

References protocols::simple_moves::MinMover::apply(), bb_, chi_, factory_, jump_, minmover_, protocols::simple_moves::MinMover::movemap(), nres, runtime_assert, core::kinematics::MoveMap::set_bb(), core::kinematics::MoveMap::set_chi(), and core::kinematics::MoveMap::set_jump().

void protocols::simple_moves::TaskAwareMinMover::bb ( bool  val)
inline

References bb_.

bool protocols::simple_moves::TaskAwareMinMover::bb ( ) const
inline

References bb_.

void protocols::simple_moves::TaskAwareMinMover::chi ( bool  val)
inline

References chi_.

bool protocols::simple_moves::TaskAwareMinMover::chi ( ) const
inline

References chi_.

protocols::moves::MoverOP protocols::simple_moves::TaskAwareMinMover::clone ( ) const
virtual

Return a clone of the Mover object.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

Referenced by parse_def().

protocols::moves::MoverOP protocols::simple_moves::TaskAwareMinMover::fresh_instance ( ) const
virtual

Generates a new Mover object freshly created with the default ctor.

fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.

Reimplemented from protocols::moves::Mover.

References TaskAwareMinMover().

std::string protocols::simple_moves::TaskAwareMinMover::get_name ( ) const
virtual

Each derived class must specify its name. The class name.

Implements protocols::moves::Mover.

References protocols::simple_moves::TaskAwareMinMoverCreator::mover_name().

void protocols::simple_moves::TaskAwareMinMover::jump ( bool const  j)
inline

References jump_.

bool protocols::simple_moves::TaskAwareMinMover::jump ( ) const
inline

References jump_.

Referenced by parse_my_tag().

void protocols::simple_moves::TaskAwareMinMover::parse_def ( utility::lua::LuaObject const &  def,
utility::lua::LuaObject const &  score_fxns,
utility::lua::LuaObject const &  tasks,
protocols::moves::MoverCacheSP  cache 
)
virtual
void protocols::simple_moves::TaskAwareMinMover::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap datamap,
Filters_map const &  filters,
protocols::moves::Movers_map const &  movers,
Pose const &  pose 
)
virtual

parse XML (specifically in the context of the parser/scripting scheme)

Reimplemented from protocols::moves::Mover.

References bb_, chi_, jump(), jump_, minmover_, protocols::rosetta_scripts::parse_score_function(), parse_task_operations(), protocols::simple_moves::TR, and utility_exit_with_message.

void protocols::simple_moves::TaskAwareMinMover::parse_task_operations ( TagCOP  tag,
basic::datacache::DataMap const &  datamap,
Filters_map const &  ,
protocols::moves::Movers_map const &  ,
Pose const &   
)
virtual

parse "task_operations" XML option

parse "task_operations" XML option (can be employed virtually by derived Packing movers)

References factory_, and protocols::rosetta_scripts::parse_task_operations().

Referenced by parse_my_tag().

Member Data Documentation

bool protocols::simple_moves::TaskAwareMinMover::bb_
private

Referenced by apply(), bb(), parse_def(), and parse_my_tag().

bool protocols::simple_moves::TaskAwareMinMover::chi_
private

Referenced by apply(), chi(), parse_def(), and parse_my_tag().

core::pack::task::TaskFactoryCOP protocols::simple_moves::TaskAwareMinMover::factory_
private

OP for constant task factory for nonconstant tasks, if present.

Referenced by apply(), parse_def(), and parse_task_operations().

bool protocols::simple_moves::TaskAwareMinMover::jump_
private

Referenced by apply(), jump(), parse_def(), and parse_my_tag().

protocols::simple_moves::MinMoverOP protocols::simple_moves::TaskAwareMinMover::minmover_
private

OP for MinMover.

Referenced by apply(), parse_def(), and parse_my_tag().


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