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

Compute the initial position of the membrane based upon sequence or structure. More...

#include <MembranePositionFromTopologyMover.hh>

Public Member Functions

 MembranePositionFromTopologyMover ()
 Constructors ///. More...
 
 MembranePositionFromTopologyMover (bool structure_based)
 Custom Constructor - for Pyrosetta. More...
 
 MembranePositionFromTopologyMover (MembranePositionFromTopologyMover const &src)
 Copy Constructor. More...
 
 ~MembranePositionFromTopologyMover ()
 Destructor. More...
 
virtual protocols::moves::MoverOP clone () const
 Rosetta Scripts Methods ///. More...
 
virtual protocols::moves::MoverOP fresh_instance () const
 Create a Fresh Instance of this Mover. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)
 Pase Rosetta Scripts Options for this Mover. More...
 
virtual void apply (Pose &pose)
 Mover Methods ///. More...
 
virtual std::string get_name () const
 Get the name of this mover. More...
 
- 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 parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, MoverCacheSP cache)
 
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 Member Functions

void compute_structure_based_membrane_position (Pose &pose, Vector &center, Vector &normal)
 Compute Membrane Center/Normal from Membrane Spanning topology. More...
 

Private Attributes

bool structure_based_
 

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

Compute the initial position of the membrane based upon sequence or structure.

Constructor & Destructor Documentation

protocols::membrane::MembranePositionFromTopologyMover::MembranePositionFromTopologyMover ( )

Constructors ///.

Defualt Constructor.

Defualt Constructor

Compute the embedding of the pose based on xyz coordinates and spanning topology provided in MembraneInfo

Compute the embedding of the pose based on xyz coordinates and spanning topology provided in MembraneInfo

Referenced by clone(), and fresh_instance().

protocols::membrane::MembranePositionFromTopologyMover::MembranePositionFromTopologyMover ( bool  structure_based)

Custom Constructor - for Pyrosetta.

Compute the embedding of the pose - if structure_based is true do this based on xyz coordinates. If structure_based is false, compute based on sequence.

protocols::membrane::MembranePositionFromTopologyMover::MembranePositionFromTopologyMover ( MembranePositionFromTopologyMover const &  src)

Copy Constructor.

Make a deep copy of this mover

protocols::membrane::MembranePositionFromTopologyMover::~MembranePositionFromTopologyMover ( )

Destructor.

Member Function Documentation

void protocols::membrane::MembranePositionFromTopologyMover::apply ( Pose pose)
virtual

Mover Methods ///.

Update Membrane position in pose

Compute membrane posiiton based on sequence or structure and then call pose.update_membrane_position() to update the membrane position

Implements protocols::moves::Mover.

References center, compute_structure_based_membrane_position(), core::pose::Pose::conformation(), core::conformation::Conformation::is_membrane(), normal, protocols::TR, core::conformation::Conformation::update_membrane_position(), and utility_exit_with_message.

protocols::moves::MoverOP protocols::membrane::MembranePositionFromTopologyMover::clone ( ) const
virtual

Rosetta Scripts Methods ///.

Create a Clone of this mover

Reimplemented from protocols::moves::Mover.

References MembranePositionFromTopologyMover().

void protocols::membrane::MembranePositionFromTopologyMover::compute_structure_based_membrane_position ( Pose pose,
Vector center,
Vector normal 
)
private
protocols::moves::MoverOP protocols::membrane::MembranePositionFromTopologyMover::fresh_instance ( ) const
virtual

Create a Fresh Instance of this Mover.

Reimplemented from protocols::moves::Mover.

References MembranePositionFromTopologyMover().

std::string protocols::membrane::MembranePositionFromTopologyMover::get_name ( ) const
virtual

Get the name of this mover.

Implements protocols::moves::Mover.

void protocols::membrane::MembranePositionFromTopologyMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap ,
protocols::filters::Filters_map const &  ,
protocols::moves::Movers_map const &  ,
core::pose::Pose const &   
)
virtual

Pase Rosetta Scripts Options for this Mover.

Reimplemented from protocols::moves::Mover.

References structure_based_.

Member Data Documentation

bool protocols::membrane::MembranePositionFromTopologyMover::structure_based_
private

Referenced by parse_my_tag().


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