Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::stepwise::monte_carlo::mover::DeleteMover Class Reference

#include <DeleteMover.hh>

Inheritance diagram for protocols::stepwise::monte_carlo::mover::DeleteMover:
Inheritance graph

Public Member Functions

 DeleteMover ()
 ~DeleteMover () override
void apply (core::pose::Pose &pose, core::Size const res_to_delete_in_full_model_numbering)
void apply (core::pose::Pose &pose, utility::vector1< core::Size > const &residues_to_delete_in_full_model_numbering)
void apply (core::pose::Pose &pose_to_visualize) override
 Apply the minimizer to one pose. More...
protocols::moves::MoverOP fresh_instance () const override
 Generates a new Mover object freshly created with the default ctor. More...
protocols::moves::MoverOP clone () const override
 Return a clone of the Mover object. More...
void parse_my_tag (utility::tag::TagCOP, basic::datacache::DataMap &) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
bool decide_to_keep_pose (core::pose::Pose const &pose) const
void remove_singletons_and_update_pose_focus (core::pose::Pose &pose, core::pose::PoseOP sliced_out_pose_op, bool &keep_remainder_pose, bool &keep_sliced_out_pose) const
void wipe_out_moving_residues (core::pose::Pose &pose)
void minimize_after_delete (core::pose::Pose &pose) const
void set_minimize_after_delete (bool const setting)
void set_stepwise_modeler (protocols::stepwise::modeler::StepWiseModelerOP stepwise_modeler)
void set_options (protocols::stepwise::monte_carlo::options::StepWiseMonteCarloOptionsCOP options)
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
virtual MoverOP create ()
MoverCOP get_self_ptr () const
MoverOP get_self_ptr ()
MoverCAP get_self_weak_ptr () const
MoverAP get_self_weak_ptr ()
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
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...
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...
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...
void set_type (std::string const &setting)
 Set the 'type' string. More...
std::string get_type () const
void type (const std::string &type_in)
 Set the 'type' string. More...
std::string const & type () const
 Get the set 'type' string. More...
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
void set_current_job (protocols::jobdist::BasicJobCOP job)
jobdist::BasicJobCOP get_current_job () const
virtual void set_current_tag (std::string const &new_tag)
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...
virtual void show (std::ostream &output=std::cout) const
 Outputs details about the Mover, including current settings. More...
virtual core::Real last_proposal_density_ratio ()
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 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 std::string mover_name ()
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
- 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...

Private Attributes

protocols::stepwise::modeler::StepWiseModelerOP stepwise_modeler_
protocols::stepwise::monte_carlo::options::StepWiseMonteCarloOptionsCOP options_
bool minimize_after_delete_
utility::vector1< core::Sizeinterface_res_
std::string move_str_

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 std::list< std::string > Strings
- 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...

Constructor & Destructor Documentation

◆ DeleteMover()

protocols::stepwise::monte_carlo::mover::DeleteMover::DeleteMover ( )

◆ ~DeleteMover()

protocols::stepwise::monte_carlo::mover::DeleteMover::~DeleteMover ( )

Member Function Documentation

◆ apply() [1/3]

void protocols::stepwise::monte_carlo::mover::DeleteMover::apply ( core::pose::Pose pose,
core::Size const  res_to_delete_in_full_model_numbering 

Referenced by apply(), and wipe_out_moving_residues().

◆ apply() [2/3]

void protocols::stepwise::monte_carlo::mover::DeleteMover::apply ( core::pose::Pose pose,
utility::vector1< core::Size > const &  residues_to_delete_in_full_model_numbering 

◆ apply() [3/3]

void protocols::stepwise::monte_carlo::mover::DeleteMover::apply ( core::pose::Pose pose_to_visualize)

◆ clone()

protocols::moves::MoverOP protocols::stepwise::monte_carlo::mover::DeleteMover::clone ( ) const

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.

◆ decide_to_keep_pose()

bool protocols::stepwise::monte_carlo::mover::DeleteMover::decide_to_keep_pose ( core::pose::Pose const &  pose) const

◆ fresh_instance()

protocols::moves::MoverOP protocols::stepwise::monte_carlo::mover::DeleteMover::fresh_instance ( ) const

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.

◆ get_name()

std::string protocols::stepwise::monte_carlo::mover::DeleteMover::get_name ( ) const

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

Implements protocols::moves::Mover.

References mover_name().

◆ minimize_after_delete()

void protocols::stepwise::monte_carlo::mover::DeleteMover::minimize_after_delete ( core::pose::Pose pose) const

◆ mover_name()

std::string protocols::stepwise::monte_carlo::mover::DeleteMover::mover_name ( )

◆ parse_my_tag()

void protocols::stepwise::monte_carlo::mover::DeleteMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data 

Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.

Some movers need not be parsed, so we shouldn't force people to reimplement this method. However, we should be chatty about the fact that someone is using a RosettaScripts interface to a mover which didn't define parse_my_tag()

Reimplemented from protocols::moves::Mover.

References minimize_after_delete_, and move_str_.

◆ provide_xml_schema()

void protocols::stepwise::monte_carlo::mover::DeleteMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)

◆ remove_singletons_and_update_pose_focus()

void protocols::stepwise::monte_carlo::mover::DeleteMover::remove_singletons_and_update_pose_focus ( core::pose::Pose pose,
core::pose::PoseOP  sliced_out_pose_op,
bool &  keep_remainder_pose,
bool &  keep_sliced_out_pose 
) const

◆ set_minimize_after_delete()

void protocols::stepwise::monte_carlo::mover::DeleteMover::set_minimize_after_delete ( bool const  setting)

◆ set_options()

void protocols::stepwise::monte_carlo::mover::DeleteMover::set_options ( protocols::stepwise::monte_carlo::options::StepWiseMonteCarloOptionsCOP  options)

References options_.

◆ set_stepwise_modeler()

void protocols::stepwise::monte_carlo::mover::DeleteMover::set_stepwise_modeler ( protocols::stepwise::modeler::StepWiseModelerOP  stepwise_modeler)

References stepwise_modeler_.

◆ wipe_out_moving_residues()

void protocols::stepwise::monte_carlo::mover::DeleteMover::wipe_out_moving_residues ( core::pose::Pose pose)

Member Data Documentation

◆ interface_res_

utility::vector1< core::Size > protocols::stepwise::monte_carlo::mover::DeleteMover::interface_res_

Referenced by apply(), and minimize_after_delete().

◆ minimize_after_delete_

bool protocols::stepwise::monte_carlo::mover::DeleteMover::minimize_after_delete_

◆ move_str_

std::string protocols::stepwise::monte_carlo::mover::DeleteMover::move_str_

Referenced by apply(), and parse_my_tag().

◆ options_

protocols::stepwise::monte_carlo::options::StepWiseMonteCarloOptionsCOP protocols::stepwise::monte_carlo::mover::DeleteMover::options_

◆ stepwise_modeler_

protocols::stepwise::modeler::StepWiseModelerOP protocols::stepwise::monte_carlo::mover::DeleteMover::stepwise_modeler_

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