Rosetta
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::simple_moves::RandomOmegaFlipMover Class Reference

#include <RandomOmegaFlipMover.hh>

Inheritance diagram for protocols::simple_moves::RandomOmegaFlipMover:
Inheritance graph
[legend]

Public Member Functions

 RandomOmegaFlipMover ()
 
 RandomOmegaFlipMover (core::kinematics::MoveMapOP move_map)
 
 RandomOmegaFlipMover (RandomOmegaFlipMover const &other)
 
 ~RandomOmegaFlipMover () override
 
void apply (core::pose::Pose &pose) override
 Main Method. More...
 
protocols::moves::MoverOP clone () const override
 Return a clone of the Mover object. More...
 
protocols::moves::MoverOP fresh_instance () const override
 Generates a new Mover object freshly created with the default ctor. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
void movemap_factory (core::select::movemap::MoveMapFactoryCOP new_movemap_factory)
 
std::string get_name () const override
 RandomOmegaFlipMoverCreator interface, name of the mover. More...
 
- 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...
 

Protected Member Functions

void setup_torsion_list (core::pose::Pose &pose)
 Look at all the bb torsions, make a list of the ones that can move. More...
 
core::kinematics::MoveMapCOP movemap (core::pose::Pose const &pose)
 Get the movemap for this pose. 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...
 

Private Attributes

core::select::movemap::MoveMapFactoryCOP movemap_factory_
 
core::kinematics::MoveMapOP move_map_
 
utility::vector1< core::id::TorsionIDtorsion_id_list_
 

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
 

Detailed Description

Simple class that flips a random omega selected from a movemap 180 degrees

Constructor & Destructor Documentation

◆ RandomOmegaFlipMover() [1/3]

protocols::simple_moves::RandomOmegaFlipMover::RandomOmegaFlipMover ( )

◆ RandomOmegaFlipMover() [2/3]

protocols::simple_moves::RandomOmegaFlipMover::RandomOmegaFlipMover ( core::kinematics::MoveMapOP  move_map)

◆ RandomOmegaFlipMover() [3/3]

protocols::simple_moves::RandomOmegaFlipMover::RandomOmegaFlipMover ( RandomOmegaFlipMover const &  other)

References move_map_.

◆ ~RandomOmegaFlipMover()

protocols::simple_moves::RandomOmegaFlipMover::~RandomOmegaFlipMover ( )
overridedefault

Member Function Documentation

◆ apply()

void protocols::simple_moves::RandomOmegaFlipMover::apply ( core::pose::Pose )
overridevirtual

◆ clone()

protocols::moves::MoverOP protocols::simple_moves::RandomOmegaFlipMover::clone ( ) const
overridevirtual

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.

◆ fresh_instance()

protocols::moves::MoverOP protocols::simple_moves::RandomOmegaFlipMover::fresh_instance ( ) const
overridevirtual

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::simple_moves::RandomOmegaFlipMover::get_name ( ) const
overridevirtual

RandomOmegaFlipMoverCreator interface, name of the mover.

RandomOmegaFlipMoverCreator interface, returns a unique key name to be used in xml file

RandomOmegaFlipMoverCreator interface, return a new instance

Implements protocols::moves::Mover.

References mover_name().

◆ movemap()

core::kinematics::MoveMapCOP protocols::simple_moves::RandomOmegaFlipMover::movemap ( core::pose::Pose const &  pose)
protected

Get the movemap for this pose.

References move_map_, and movemap_factory_.

Referenced by setup_torsion_list().

◆ movemap_factory()

void protocols::simple_moves::RandomOmegaFlipMover::movemap_factory ( core::select::movemap::MoveMapFactoryCOP  new_movemap_factory)
inline

References movemap_factory_.

Referenced by parse_my_tag().

◆ mover_name()

std::string protocols::simple_moves::RandomOmegaFlipMover::mover_name ( )
static

◆ parse_my_tag()

void protocols::simple_moves::RandomOmegaFlipMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data 
)
overridevirtual

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 movemap_factory(), and protocols::rosetta_scripts::parse_movemap_factory_legacy().

◆ provide_xml_schema()

void protocols::simple_moves::RandomOmegaFlipMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ setup_torsion_list()

void protocols::simple_moves::RandomOmegaFlipMover::setup_torsion_list ( core::pose::Pose pose)
protected

Look at all the bb torsions, make a list of the ones that can move.

I feel like there should be a better way to do this rather than having to hard code so much conectivity information about the residue and the peptide/peptoid checks. It should probably iterate over the move map rather than the pose but done is better than perfect.

References core::id::BB, core::chemical::ResidueTypeBase::is_peptoid(), core::chemical::ResidueTypeBase::is_protein(), movemap(), core::id::omega_torsion(), core::pose::Pose::residue(), core::pose::Pose::size(), torsion_id_list_, and core::conformation::Residue::type().

Referenced by apply().

Member Data Documentation

◆ move_map_

core::kinematics::MoveMapOP protocols::simple_moves::RandomOmegaFlipMover::move_map_
private

Referenced by movemap(), and RandomOmegaFlipMover().

◆ movemap_factory_

core::select::movemap::MoveMapFactoryCOP protocols::simple_moves::RandomOmegaFlipMover::movemap_factory_
private

Referenced by movemap(), and movemap_factory().

◆ torsion_id_list_

utility::vector1< core::id::TorsionID > protocols::simple_moves::RandomOmegaFlipMover::torsion_id_list_
private

Referenced by apply(), and setup_torsion_list().


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