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

#include <MultiplePoseMover.hh>

Public Member Functions

 MultiplePoseMover ()
 No-argument constructor. More...
 
virtual ~MultiplePoseMover ()
 Virtual destructor. More...
 
protocols::moves::MoverOP clone () const
 Return a clone of the Mover object. More...
 
protocols::moves::MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. More...
 
void apply (core::pose::Pose &pose)
 Process input pose. More...
 
core::pose::PoseOP get_additional_output ()
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
virtual std::string get_name () const
 Each derived class must specify its name. The class name. 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 &)
 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...
 
- 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 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

bool fill_input_cache ()
 
core::pose::PoseOP generate_pose ()
 
bool process_pose (core::pose::Pose &, utility::vector1< core::pose::PoseOP > &)
 Process a single input pose by the RosettaScripts mover. More...
 
std::deque< core::pose::PoseOPselect_poses (std::deque< core::pose::PoseOP > &poses)
 Select poses from set using specified selectors. More...
 
std::deque< core::pose::PoseOPprocess_poses (std::deque< core::pose::PoseOP > &poses)
 Rub sub-protocol on set of poses. More...
 

Private Attributes

bool cached_
 
core::Size max_input_poses_
 
core::Size max_output_poses_
 
utility::tag::TagCOP rosetta_scripts_tag_
 
utility::tag::TagCOP selector_tag_
 
protocols::moves::MoverOP previous_mover_
 
utility::vector1< PoseSelectorOPselectors_
 
std::deque< core::pose::PoseOPpose_input_cache_
 
std::deque< core::pose::PoseOPpose_output_cache_
 
core::Size poses_input_
 
core::Size poses_output_
 
protocols::filters::Filters_map selector_filters_
 

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

Constructor & Destructor Documentation

protocols::rosetta_scripts::MultiplePoseMover::MultiplePoseMover ( )

No-argument constructor.

Referenced by clone(), and fresh_instance().

virtual protocols::rosetta_scripts::MultiplePoseMover::~MultiplePoseMover ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

void protocols::rosetta_scripts::MultiplePoseMover::apply ( core::pose::Pose pose)
virtual
protocols::moves::MoverOP protocols::rosetta_scripts::MultiplePoseMover::clone ( ) const
inlinevirtual

Return a clone of the Mover object.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

References MultiplePoseMover().

bool protocols::rosetta_scripts::MultiplePoseMover::fill_input_cache ( )
private
protocols::moves::MoverOP protocols::rosetta_scripts::MultiplePoseMover::fresh_instance ( ) const
inlinevirtual

Generates a new Mover object freshly created with the default ctor.

fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.

Reimplemented from protocols::moves::Mover.

References MultiplePoseMover().

core::pose::PoseOP protocols::rosetta_scripts::MultiplePoseMover::generate_pose ( )
private
core::pose::PoseOP protocols::rosetta_scripts::MultiplePoseMover::get_additional_output ( )
virtual

Mechanism by which a mover may return multiple output poses from a single input pose.

fpd

Mechanism by which a mover may return multiple output poses from a single input pose. After apply is called, calling this function will return subsequent output poses. NULL is returned if the mover has no more output poses remaining. The base class implementation returns NULL always; multi-output movers must override this. RosettaScripts uses this interface to produce a 'branched' protocol.

Reimplemented from protocols::moves::Mover.

References generate_pose().

std::string protocols::rosetta_scripts::MultiplePoseMover::get_name ( ) const
virtual

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

Implements protocols::moves::Mover.

References protocols::rosetta_scripts::MultiplePoseMoverCreator::mover_name().

void protocols::rosetta_scripts::MultiplePoseMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data,
protocols::filters::Filters_map const &  ,
protocols::moves::Movers_map const &  movers,
core::pose::Pose const &  pose 
)
virtual
bool protocols::rosetta_scripts::MultiplePoseMover::process_pose ( core::pose::Pose pose,
utility::vector1< core::pose::PoseOP > &  additional_poses 
)
private
std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::process_poses ( std::deque< core::pose::PoseOP > &  poses)
private

Rub sub-protocol on set of poses.

References process_pose(), rosetta_scripts_tag_, core::pose::Pose::sequence(), and protocols::rosetta_scripts::TR.

Referenced by generate_pose().

std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::select_poses ( std::deque< core::pose::PoseOP > &  poses)
private

Select poses from set using specified selectors.

References selectors_, core::pose::Pose::sequence(), and protocols::rosetta_scripts::TR.

Referenced by generate_pose().

void protocols::rosetta_scripts::MultiplePoseMover::set_previous_mover ( protocols::moves::MoverOP const  m)
inline

Used by RosettaScripts to set the previous mover to pull poses from.

References previous_mover_.

Member Data Documentation

bool protocols::rosetta_scripts::MultiplePoseMover::cached_
private

Referenced by apply(), generate_pose(), and parse_my_tag().

core::Size protocols::rosetta_scripts::MultiplePoseMover::max_input_poses_
private

Referenced by fill_input_cache(), and parse_my_tag().

core::Size protocols::rosetta_scripts::MultiplePoseMover::max_output_poses_
private

Referenced by generate_pose(), and parse_my_tag().

std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::pose_input_cache_
private
std::deque< core::pose::PoseOP > protocols::rosetta_scripts::MultiplePoseMover::pose_output_cache_
private

Referenced by apply(), and generate_pose().

core::Size protocols::rosetta_scripts::MultiplePoseMover::poses_input_
private

Referenced by apply(), and fill_input_cache().

core::Size protocols::rosetta_scripts::MultiplePoseMover::poses_output_
private

Referenced by apply(), and generate_pose().

protocols::moves::MoverOP protocols::rosetta_scripts::MultiplePoseMover::previous_mover_
private
utility::tag::TagCOP protocols::rosetta_scripts::MultiplePoseMover::rosetta_scripts_tag_
private
protocols::filters::Filters_map protocols::rosetta_scripts::MultiplePoseMover::selector_filters_
private

Referenced by parse_my_tag().

utility::tag::TagCOP protocols::rosetta_scripts::MultiplePoseMover::selector_tag_
private
utility::vector1< PoseSelectorOP > protocols::rosetta_scripts::MultiplePoseMover::selectors_
private

Referenced by parse_my_tag(), and select_poses().


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