Public Member Functions | Private Attributes | List of all members
protocols::docking::FaDockingSlideIntoContact Class Reference

Slides docking partners together by monitoring fa_rep. More...

#include <DockingInitialPerturbation.hh>

Inheritance diagram for protocols::docking::FaDockingSlideIntoContact:
Inheritance graph

Public Member Functions

 FaDockingSlideIntoContact ()
 FaDockingSlideIntoContact (core::Size const rb_jump)
 FaDockingSlideIntoContact (utility::vector1< core::Size > const &rb_jumps)
 FaDockingSlideIntoContact (core::Size const rb_jump, core::Vector const &slide_axis)
 ~FaDockingSlideIntoContact () override
void apply (core::pose::Pose &pose) override
 Main Method. More...
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
void show (std::ostream &output=std::cout) const override
 Outputs details about the Mover, including current settings. More...
core::Size get_jump_num () const
core::Real get_tolerance () const
- 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 MoverOP clone () const
 Return a clone of the Mover object. 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...
virtual MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. 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
virtual void parse_my_tag (TagCOP tag, basic::datacache::DataMap &data)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
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 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 Attributes

core::Size rb_jump_
utility::vector1< core::Sizerb_jumps_
core::scoring::ScoreFunctionOP scorefxn_
core::Real tolerance_
 how accurate do you want to be? More...
core::Vector slide_axis_

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

Slides docking partners together by monitoring fa_rep.

If partners are already touching, no change is made. Separation will be 1A or less after calling this function.

Constructor & Destructor Documentation

◆ FaDockingSlideIntoContact() [1/4]

protocols::docking::FaDockingSlideIntoContact::FaDockingSlideIntoContact ( )

◆ FaDockingSlideIntoContact() [2/4]

protocols::docking::FaDockingSlideIntoContact::FaDockingSlideIntoContact ( core::Size const  rb_jump)

References core::scoring::fa_rep, and scorefxn_.

◆ FaDockingSlideIntoContact() [3/4]

protocols::docking::FaDockingSlideIntoContact::FaDockingSlideIntoContact ( utility::vector1< core::Size > const &  rb_jumps)

References core::scoring::fa_rep, and scorefxn_.

◆ FaDockingSlideIntoContact() [4/4]

protocols::docking::FaDockingSlideIntoContact::FaDockingSlideIntoContact ( core::Size const  rb_jump,
core::Vector const &  slide_axis 

References core::scoring::fa_rep, and scorefxn_.

◆ ~FaDockingSlideIntoContact()

protocols::docking::FaDockingSlideIntoContact::~FaDockingSlideIntoContact ( )

Member Function Documentation

◆ apply()

void protocols::docking::FaDockingSlideIntoContact::apply ( core::pose::Pose )

◆ get_jump_num()

core::Size protocols::docking::FaDockingSlideIntoContact::get_jump_num ( ) const

References rb_jump_.

Referenced by show().

◆ get_name()

std::string protocols::docking::FaDockingSlideIntoContact::get_name ( ) const

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

Implements protocols::moves::Mover.

◆ get_tolerance()

core::Real protocols::docking::FaDockingSlideIntoContact::get_tolerance ( ) const

References tolerance_.

Referenced by show().

◆ show()

void protocols::docking::FaDockingSlideIntoContact::show ( std::ostream &  output = std::cout) const

Outputs details about the Mover, including current settings.

Ideally, a child Mover should call and add additional information particular to that Mover.

Reimplemented from protocols::moves::Mover.

References get_jump_num(), and get_tolerance().

Referenced by protocols::docking::operator<<().

Member Data Documentation

◆ rb_jump_

core::Size protocols::docking::FaDockingSlideIntoContact::rb_jump_

Referenced by apply(), and get_jump_num().

◆ rb_jumps_

utility::vector1<core::Size> protocols::docking::FaDockingSlideIntoContact::rb_jumps_

Referenced by apply().

◆ scorefxn_

core::scoring::ScoreFunctionOP protocols::docking::FaDockingSlideIntoContact::scorefxn_

◆ slide_axis_

core::Vector protocols::docking::FaDockingSlideIntoContact::slide_axis_

Referenced by apply().

◆ tolerance_

core::Real protocols::docking::FaDockingSlideIntoContact::tolerance_

how accurate do you want to be?

Referenced by apply(), and get_tolerance().

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