Rosetta Protocols  2014.35
Public Member Functions | Protected Attributes | Friends | List of all members
protocols::moves::MoverContainer Class Referenceabstract

#include <MoverContainer.hh>

Public Member Functions

 MoverContainer ()
 
 MoverContainer (MoverContainer const &source)
 to be called by derived-class clone() methods; copy all data from the source MoverContainer More...
 
void add_mover (MoverOP mover_in, core::Real weight_in=1.0)
 Adds a mover to the end of this container. More...
 
std::string get_mover (core::Size index) const
 
void clear ()
 
virtual void set_input_pose (PoseCOP pose)
 Sets the input Pose for both the container and the contained movers, for rmsd. 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...
 
virtual void apply (core::pose::Pose &pose)=0
 
Size nr_moves ()
 
Size size () const
 
MoverOP front ()
 
utility::vector0< core::Real >
const & 
weights () const
 
utility::vector0< MoverOP > const & movers () const
 
- 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)
 
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
 Return a clone of the Mover object. More...
 
virtual void 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. More...
 
virtual std::string get_name () const =0
 Each derived class must specify its name. The class name. 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
 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...
 
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...
 

Protected Attributes

utility::vector0< core::Realweight_
 relative weight when part of MoverContainer. More...
 
utility::vector0< MoverOPmovers_
 

Friends

std::ostream & operator<< (std::ostream &os, MoverContainer const &mover)
 

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::moves::MoverContainer::MoverContainer ( )
inline
protocols::moves::MoverContainer::MoverContainer ( MoverContainer const &  source)

to be called by derived-class clone() methods; copy all data from the source MoverContainer

Invoke clone() on each of the movers that are contained by this MoverContainer to create deep copies.

References movers_, and weight_.

Member Function Documentation

void protocols::moves::MoverContainer::add_mover ( MoverOP  mover_in,
core::Real  weight_in = 1.0 
)

Adds a mover to the end of this container.

References movers_, and weight_.

Referenced by protocols::docking::DockingProtocol::add_additional_low_resolution_step(), protocols::loops::loop_mover::refine::LoopRefineInnerCycleContainer::add_inner_cycle_step(), protocols::canonical_sampling::CanonicalSamplingMover::add_mover(), protocols::topology_broker::FoldandDockClaimer::add_mover(), protocols::topology_broker::AsymFoldandDockClaimer::add_mover(), protocols::topology_broker::FibrilModelingClaimer::add_mover(), protocols::topology_broker::MembraneTopologyClaimer::add_mover(), protocols::topology_broker::TMHTopologySamplerClaimer::add_mover(), protocols::topology_broker::TopologyClaimer::add_mover(), protocols::rbsegment_relax::AutoRBMover::apply(), protocols::metal_interface::ZincHeterodimerMover::apply(), protocols::antibody_legacy::AntibodyModeler::apply(), protocols::floppy_tail::FloppyTailMover::apply(), protocols::antibody::LHSnugFitLegacy::apply(), protocols::rbsegment_relax::RBSegmentRelax::apply(), protocols::ncbb::NcbbDockDesignProtocol::apply(), protocols::antibody_legacy::GraftMover::apply(), protocols::ncbb::oop::OopDockDesignProtocol::apply(), protocols::relax::ClassicRelax::apply(), protocols::ncbb::oop::OopCreatorMover::apply(), protocols::hybridization::FoldTreeHybridize::apply(), protocols::antibody_legacy::LoopRlxMover::apply(), protocols::ub_e2c::ubi_e2c_modeler::calc_interaction_energy(), protocols::ub_e2c::ubi_e2c_modeler::centroid_mode_perturbation(), protocols::antibody_legacy::CloseOneMover::close_one_loop_stem(), protocols::docking::DockingLowResEnsemble::finalize_setup(), protocols::antibody::CDRsMinPackMin::finalize_setup(), protocols::antibody::GraftCDRLoopsProtocol::finalize_setup(), protocols::docking::DockingLowRes::finalize_setup(), protocols::antibody::H3RefineCCD::finalize_setup(), protocols::ub_e2c::ubi_e2c_modeler::fullatom_mode_perturbation(), protocols::ub_e2c::ubi_e2c_modeler::initial_cter_perturbation(), protocols::antibody::RefineOneCDRLoopCentroid::loop_centroid_relax(), protocols::antibody_legacy::CDRH3Modeler::loop_centroid_relax(), protocols::antibody_legacy::CDRH3Modeler::loop_fa_relax(), protocols::pmut_scan::PointMutScanDriver::make_mutant_structure(), protocols::ub_e2c::ubi_e2c_modeler::monoub_calc_interaction_energy(), protocols::ub_e2c::ubi_e2c_modeler::monoub_fullatom_mode_perturbation(), protocols::ub_e2c::ubi_e2c_modeler::monoub_initial_cter_perturbation(), protocols::topology_broker::TopologyBroker::mover(), protocols::ub_e2c::ubi_e2c_modeler::optimize_cov_bond(), protocols::moves::RandomMover::parse_my_tag(), protocols::environment::EnvMover::parse_subtag(), protocols::relax::Relax_main(), protocols::simple_moves::symmetry::SymShakeStructureMover::run_mc(), protocols::simple_moves::ShakeStructureMover::run_mc(), protocols::moves::SequenceMover::SequenceMover(), protocols::relax::ClassicRelax::set_default_moveset_phase2(), protocols::relax::ClassicRelax::set_default_moveset_phase3(), protocols::symmetric_docking::SymDockingLowRes::set_default_protocol(), protocols::symmetric_docking::SymDockingHiRes::set_dock_mcm_protocol(), protocols::docking::DockingHighResLegacy::set_dock_mcm_protocol(), protocols::symmetric_docking::SymDockingHiRes::set_dock_min_protocol(), protocols::docking::DockingHighResLegacy::set_dock_min_protocol(), protocols::symmetric_docking::SymDockingHiRes::set_dock_ppk_protocol(), protocols::docking::DockingHighResLegacy::set_dock_ppk_protocol(), protocols::surface_docking::CentroidRelaxMover::setup_movers(), protocols::surface_docking::FullatomRelaxMover::setup_movers(), protocols::docking::DockingProtocol::setup_objects(), protocols::docking::DockingEnsemblePrepackProtocol::setup_pack_operation_movers(), protocols::docking::DockingPrepackProtocol::setup_pack_operation_movers(), protocols::docking::DockMCMCycle::setup_protocol(), protocols::antibody_legacy::AntibodyModeler::snugfit_MC_min(), protocols::antibody::LHRepulsiveRampLegacy::snugfit_MC_min(), protocols::antibody_legacy::AntibodyModeler::snugfit_mcm_protocol(), protocols::symmetric_docking::SymDock_main(), protocols::flexpep_docking::FlexPepDockingLowRes::torsions_monte_carlo(), and protocols::flexpep_docking::FlexPepDockingAbInitio::torsions_monte_carlo().

virtual void protocols::moves::MoverContainer::apply ( core::pose::Pose pose)
pure virtual
void protocols::moves::MoverContainer::clear ( )
inline

References movers_.

MoverOP protocols::moves::MoverContainer::front ( )
inline

References movers_.

std::string protocols::moves::MoverContainer::get_mover ( core::Size  index) const

References movers_.

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

utility::vector0< MoverOP > const& protocols::moves::MoverContainer::movers ( ) const
inline

References movers_.

Size protocols::moves::MoverContainer::nr_moves ( )
inline

References movers_.

void protocols::moves::MoverContainer::set_input_pose ( PoseCOP  pose)
virtual

Sets the input Pose for both the container and the contained movers, for rmsd.

Reimplemented from protocols::moves::Mover.

References movers_, and protocols::moves::Mover::set_input_pose().

void protocols::moves::MoverContainer::set_native_pose ( PoseCOP  pose)
virtual

setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe

Reimplemented from protocols::moves::Mover.

References movers_, and protocols::moves::Mover::set_native_pose().

Size protocols::moves::MoverContainer::size ( ) const
inline
utility::vector0< core::Real > const& protocols::moves::MoverContainer::weights ( ) const
inline

References weight_.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
MoverContainer const &  mover 
)
friend

Member Data Documentation

utility::vector0< MoverOP > protocols::moves::MoverContainer::movers_
protected
utility::vector0< core::Real > protocols::moves::MoverContainer::weight_
protected

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