Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::membrane::TranslationMover Class Reference

Translation vector can be defined in -mp:setup center flag to translate the new pose to. The mover is a general mover but used mainly on membrane proteins, that's why we use this flag here The default jump is going to be the membrane jump, but you can also specify your own. More...

#include <TranslationRotationMover.hh>

Inheritance diagram for protocols::membrane::TranslationMover:
Inheritance graph
[legend]

Public Member Functions

 TranslationMover ()
 Constructors ///. More...
 
 TranslationMover (core::Vector translation_vector)
 Custom Constructor. More...
 
 TranslationMover (core::Vector translation_vector, core::Size jumpnum)
 Custom Constructor. More...
 
protocols::moves::MoverOP clone () const override
 Rosetta Scripts Methods ///. More...
 
protocols::moves::MoverOP fresh_instance () const override
 Create a Fresh Instance of this Mover. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Pase Rosetta Scripts Options for this Mover. More...
 
std::string get_name () const override
 Mover Methods ///. More...
 
void apply (core::pose::Pose &pose) override
 Translate the pose along the defined vector. 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...
 

Private Member Functions

void register_options ()
 Setup Methods ///. More...
 
void init_from_cmd ()
 Initialize Mover options from the commandline. More...
 

Private Attributes

core::Vector translation_vector_
 
core::Size jumpnum_
 

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
 
- 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

Translation vector can be defined in -mp:setup center flag to translate the new pose to. The mover is a general mover but used mainly on membrane proteins, that's why we use this flag here The default jump is going to be the membrane jump, but you can also specify your own.

Constructor & Destructor Documentation

protocols::membrane::TranslationMover::TranslationMover ( )

Constructors ///.

Default Constructor, assumes old center = (0, 0, 0)

Translation vector can be defined in -mp:setup center flag to translate the new pose to. The mover is a general mover but used mainly on membrane proteins, that's why we use this flag here The default jump is going to be the membrane jump, but you can also specify your own

References init_from_cmd(), and register_options().

protocols::membrane::TranslationMover::TranslationMover ( core::Vector  translation_vector)

Custom Constructor.

User can specify a translation vector

References init_from_cmd(), and register_options().

protocols::membrane::TranslationMover::TranslationMover ( core::Vector  translation_vector,
core::Size  jumpnum 
)

Custom Constructor.

User can specify a translation vector and a jump number; operation happens on the downstream stub

User can specify a translation vector and jumpnum

References init_from_cmd(), and register_options().

Member Function Documentation

void protocols::membrane::TranslationMover::apply ( core::pose::Pose pose)
overridevirtual
protocols::moves::MoverOP protocols::membrane::TranslationMover::clone ( ) const
overridevirtual

Rosetta Scripts Methods ///.

Create a Clone of this mover

Reimplemented from protocols::moves::Mover.

protocols::moves::MoverOP protocols::membrane::TranslationMover::fresh_instance ( ) const
overridevirtual

Create a Fresh Instance of this Mover.

Reimplemented from protocols::moves::Mover.

std::string protocols::membrane::TranslationMover::get_name ( ) const
overridevirtual

Mover Methods ///.

Get the name of this Mover (TranslationMover)

Get the name of this Mover

Implements protocols::moves::Mover.

void protocols::membrane::TranslationMover::init_from_cmd ( )
private

Initialize Mover options from the commandline.

Initialize mover settings from the commandline using the mp:setup center flag

References core::conformation::membrane::center, and translation_vector_.

Referenced by TranslationMover().

void protocols::membrane::TranslationMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &   
)
overridevirtual

Pase Rosetta Scripts Options for this Mover.

Reimplemented from protocols::moves::Mover.

References core::conformation::membrane::center, and translation_vector_.

void protocols::membrane::TranslationMover::register_options ( )
private

Setup Methods ///.

Register Options from Command Line

Register mover-relevant options with JD2 - includes mp:setup options: center

References core::conformation::membrane::center.

Referenced by TranslationMover().

Member Data Documentation

core::Size protocols::membrane::TranslationMover::jumpnum_
private

Referenced by apply().

core::Vector protocols::membrane::TranslationMover::translation_vector_
private

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


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