Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
protocols::match::MatcherMover Class Reference

#include <MatcherMover.hh>

Inheritance diagram for protocols::match::MatcherMover:
Inheritance graph
[legend]

Public Types

typedef core::Real Real
 
typedef core::Size Size
 
typedef protocols::moves::MoverOP MoverOP
 
typedef utility::tag::TagCOP TagCOP
 
typedef basic::datacache::DataMap DataMap
 
- 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
 

Public Member Functions

 MatcherMover (bool incorporate_matches_into_pose=true)
 Construction and Destruction. More...
 
 ~MatcherMover () override
 
 MatcherMover (MatcherMover const &rval)
 copy constructor More...
 
MoverOP clone () const override
 clone this object More...
 
MoverOP fresh_instance () const override
 create this type of object More...
 
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
void apply (core::pose::Pose &pose) override
 Main Method. More...
 
void set_ligres (core::conformation::ResidueCOP ligres)
 
void set_match_positions (utility::vector1< core::Size > const &match_positions)
 
void set_return_single_random_match (bool const single_random)
 if set to true, a single random match will be returned. More...
 
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
 
- Public Member Functions inherited from protocols::rosetta_scripts::MultiplePoseMover
 MultiplePoseMover ()
 No-argument constructor. More...
 
 ~MultiplePoseMover () override=default
 Virtual destructor. 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 apply (core::pose::Pose &pose) override
 Process input pose. More...
 
core::pose::PoseOP get_additional_output () override
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 Parse settings in tag. More...
 
void set_previous_mover (protocols::moves::MoverOP const m)
 Used by RosettaScripts to set the previous mover to pull poses from. More...
 
void set_rosetta_scripts_tag (utility::tag::TagCOP tag)
 sets rosettascripts tag More...
 
std::string get_name () const override
 Each derived class must specify its name. The class name. 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...
 
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 bool mover_provides_citation_info () const
 Does this mover provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool mover_is_unpublished () const
 Does this mover indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. 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::rosetta_scripts::MultiplePoseMover
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

bool process_pose (core::pose::Pose &, utility::vector1< core::pose::PoseOP > &) override
 Process a single input pose by the RosettaScripts mover. More...
 
void setup_seqpos_from_selectors (protocols::match::MatcherTask &mtask, core::pose::Pose const &pose) const
 
- 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

bool incorporate_matches_into_pose_
 
bool return_single_random_match_
 
core::conformation::ResidueCOP ligres_
 
utility::vector1< core::Sizematch_positions_
 
utility::vector1
< core::select::residue_selector::ResidueSelectorCOP
selectors_
 
utility::vector1
< toolbox::match_enzdes_util::MatchConstraintFileInfoListOP
mcfi_list_vec_
 

Member Typedef Documentation

typedef basic::datacache::DataMap protocols::match::MatcherMover::DataMap
typedef utility::tag::TagCOP protocols::match::MatcherMover::TagCOP

Constructor & Destructor Documentation

protocols::match::MatcherMover::MatcherMover ( bool  incorporate_matches_into_pose = true)

Construction and Destruction.

protocols::match::MatcherMover::~MatcherMover ( )
overridedefault
protocols::match::MatcherMover::MatcherMover ( MatcherMover const &  rval)
default

copy constructor

Member Function Documentation

void protocols::match::MatcherMover::apply ( core::pose::Pose )
overridevirtual
MatcherMover::MoverOP protocols::match::MatcherMover::clone ( ) const
overridevirtual

clone this object

Reimplemented from protocols::moves::Mover.

MatcherMover::MoverOP protocols::match::MatcherMover::fresh_instance ( ) const
overridevirtual

create this type of object

Reimplemented from protocols::moves::Mover.

std::string protocols::match::MatcherMover::get_name ( ) const
overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

std::string protocols::match::MatcherMover::mover_name ( )
static
void protocols::match::MatcherMover::parse_my_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 core::chemical::FA_STANDARD, core::select::residue_selector::get_residue_selector(), incorporate_matches_into_pose_, mcfi_list_vec_, selectors_, and protocols::match::tr().

bool protocols::match::MatcherMover::process_pose ( core::pose::Pose pose,
utility::vector1< core::pose::PoseOP > &  additional_poses 
)
overrideprotectedvirtual
void protocols::match::MatcherMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::match::MatcherMover::set_ligres ( core::conformation::ResidueCOP  ligres)

References ligres_.

void protocols::match::MatcherMover::set_match_positions ( utility::vector1< core::Size > const &  match_positions)

References match_positions_.

void protocols::match::MatcherMover::set_return_single_random_match ( bool const  single_random)

if set to true, a single random match will be returned.

The default behavior is to use the MultiplePoseMover framework to return all matches

References return_single_random_match_.

void protocols::match::MatcherMover::setup_seqpos_from_selectors ( protocols::match::MatcherTask mtask,
core::pose::Pose const &  pose 
) const
protected

Member Data Documentation

bool protocols::match::MatcherMover::incorporate_matches_into_pose_
private

Referenced by parse_my_tag(), and process_pose().

core::conformation::ResidueCOP protocols::match::MatcherMover::ligres_
private

Referenced by process_pose(), and set_ligres().

utility::vector1< core::Size > protocols::match::MatcherMover::match_positions_
private
utility::vector1< toolbox::match_enzdes_util::MatchConstraintFileInfoListOP > protocols::match::MatcherMover::mcfi_list_vec_
private

Referenced by parse_my_tag(), and process_pose().

bool protocols::match::MatcherMover::return_single_random_match_
private
utility::vector1< core::select::residue_selector::ResidueSelectorCOP > protocols::match::MatcherMover::selectors_
private

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