Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | List of all members
protocols::moves::FilterMover Class Reference

#include <FilterMover.hh>

Inheritance diagram for protocols::moves::FilterMover:
Inheritance graph
[legend]
Collaboration diagram for protocols::moves::FilterMover:
Collaboration graph
[legend]

Public Types

typedef core::Size Size
 
typedef core::pose::Pose Pose
 
typedef protocols::moves::MoverOP MoverOP
 
typedef
protocols::filters::FilterOP 
FilterOP
 
- Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagPtr TagPtr
 
typedef core::pose::Pose Pose
 
typedef core::pose::PoseCOP PoseCOP
 
typedef
protocols::filters::Filters_map 
Filters_map
 
typedef std::list< std::string > Strings
 

Public Member Functions

 FilterMover ()
 
 FilterMover (MoverOP const &my_mover, FilterOP const &my_filter, Size const max_tries, MoverStatus const mover_status=FAIL_DO_NOT_RETRY)
 
 ~FilterMover ()
 
virtual void apply (core::pose::Pose &pose)
 
virtual std::string get_name () const
 Each derived class must specify its name. The class name. More...
 
void add_filter (FilterOP const &my_filter)
 
void set_mover (MoverOP const &my_mover)
 set mover More...
 
void max_tries (Size const mt)
 set MoverStatus when the mover failed 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
 
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)
 
virtual MoverOP clone () const
 clone has to be overridden only if clone invocation is expected. More...
 
virtual void parse_my_tag (TagPtr const tag, 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. More...
 
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
 this function informs 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
 this function informs 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
 this is like clone(), except it generates a new mover object freshly created with the default ctor. This function should be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage). More...
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 

Private Attributes

MoverOP my_mover_
 
FilterOP my_filter_
 
Size max_tries_
 
MoverStatus ms_whenfail_
 

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. these options will end up in -help of your application if users of this mover call register_options. do this recursively! if you use movers within your mover, call their register_options in your register_options() method. 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::moves::FilterMover::FilterMover ( )
protocols::moves::FilterMover::FilterMover ( MoverOP const &  my_mover,
FilterOP const &  my_filter,
Size const  max_tries,
MoverStatus const  mover_status = FAIL_DO_NOT_RETRY 
)
protocols::moves::FilterMover::~FilterMover ( )

Member Function Documentation

void protocols::moves::FilterMover::add_filter ( FilterOP const &  my_filter)

References my_filter_.

void protocols::moves::FilterMover::apply ( core::pose::Pose pose)
virtual

Keep trying to make a move with my_mover until my_filter return true or max_tries is exceeded

Note
At the expense of a few additional pose copies we could save the pose with the best and use that if we exceed max_tries

Implements protocols::moves::Mover.

References max_tries_, protocols::moves::MS_SUCCESS, ms_whenfail_, my_filter_, my_mover_, protocols::moves::Mover::set_last_move_status(), and protocols::moves::TR().

std::string protocols::moves::FilterMover::get_name ( ) const
virtual

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

Implements protocols::moves::Mover.

void protocols::moves::FilterMover::max_tries ( Size const  mt)

set MoverStatus when the mover failed

set maximum tries of making a move with my_mover

References max_tries_, and protocols::motifs::mt().

void protocols::moves::FilterMover::set_mover ( MoverOP const &  my_mover)

set mover

References my_mover_.

Member Data Documentation

Size protocols::moves::FilterMover::max_tries_
private

Referenced by apply(), and max_tries().

MoverStatus protocols::moves::FilterMover::ms_whenfail_
private

Referenced by apply().

FilterOP protocols::moves::FilterMover::my_filter_
private

Referenced by add_filter(), and apply().

MoverOP protocols::moves::FilterMover::my_mover_
private

Referenced by apply(), and set_mover().


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