Rosetta Protocols  2014.35
Public Types | Public Member Functions | Private Attributes | List of all members
protocols::match::MatcherMover Class Reference

#include <MatcherMover.hh>

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

Public Member Functions

 MatcherMover (bool incorporate_matches_into_pose=true)
 Construction and Destruction. More...
virtual ~MatcherMover ()
 MatcherMover (MatcherMover const &rval)
 copy constructor More...
virtual MoverOP clone () const
 clone this object More...
virtual MoverOP fresh_instance () const
 create this type of object More...
virtual void parse_my_tag (TagCOP tag, basic::datacache::DataMap &, Filters_map const &, Movers_map const &, Pose const &)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
void apply (core::pose::Pose &pose)
std::string get_name () const
 Each derived class must specify its name. The class name. More...
void set_ligres (core::conformation::ResidueCOP ligres)
void set_match_positions (utility::vector1< core::Size > const &match_positions)
- 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 Attributes

bool incorporate_matches_into_pose_
core::conformation::ResidueCOP ligres_
utility::vector1< core::Sizematch_positions_

Additional Inherited Members

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

Member Typedef Documentation

Constructor & Destructor Documentation

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

Construction and Destruction.

References basic::options::option, and basic::options::OptionKeys::run::preserve_header.

Referenced by clone(), and fresh_instance().

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

copy constructor

Member Function Documentation

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

clone this object

Reimplemented from protocols::moves::Mover.

References MatcherMover().

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

create this type of object

Reimplemented from protocols::moves::Mover.

References MatcherMover().

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

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

Implements protocols::moves::Mover.

void protocols::match::MatcherMover::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap data,
Filters_map const &  filters,
Movers_map const &  movers,
Pose const &  pose 

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 stop executions. This, however, calls attention to the lack of this method, which could be due to something as silly as a wrong parameters definition.

Reimplemented from protocols::moves::Mover.

References incorporate_matches_into_pose_.

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

Member Data Documentation

bool protocols::match::MatcherMover::incorporate_matches_into_pose_

Referenced by apply(), and parse_my_tag().

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

Referenced by apply(), and set_ligres().

utility::vector1< core::Size > protocols::match::MatcherMover::match_positions_

Referenced by apply(), and set_match_positions().

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