Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | Friends | List of all members
protocols::moves::MoverContainer Class Referenceabstract

#include <MoverContainer.hh>

Inheritance diagram for protocols::moves::MoverContainer:
Inheritance graph
[legend]

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 ()
 
void set_input_pose (PoseCOP pose) override
 Sets the input Pose for both the container and the contained movers, for rmsd. More...
 
void set_native_pose (PoseCOP pose) override
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
void set_current_tag (std::string const &new_tag) override
 
void apply (core::pose::Pose &pose) override=0
 Main Method. More...
 
core::Size nr_moves ()
 
core::Size size () const
 
MoverOP front ()
 
utility::vector0< core::Real >
const & 
weights () const
 
utility::vector0< MoverOP > const & movers () const
 
utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const override
 Provide the citations for the movers contained in this MoverContainer. More...
 
utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const override
 Provide a list of authors for the movers contained in this MoverContainer. 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 MoverOP clone () const
 Return a clone of the Mover object. 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...
 
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...
 
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...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
virtual void parse_my_tag (TagCOP tag, basic::datacache::DataMap &data)
 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...
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () 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...
 
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 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...
 

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 std::list< std::string > Strings
 
- 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 
)
void protocols::moves::MoverContainer::apply ( core::pose::Pose )
overridepure 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_.

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

References movers_.

utility::vector1< basic::citation_manager::UnpublishedModuleInfoCOP > protocols::moves::MoverContainer::provide_authorship_info_for_unpublished ( ) const
overridevirtual

Provide a list of authors for the movers contained in this MoverContainer.

Author
Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

Reimplemented from protocols::moves::Mover.

References movers_.

utility::vector1< basic::citation_manager::CitationCollectionCOP > protocols::moves::MoverContainer::provide_citation_info ( ) const
overridevirtual

Provide the citations for the movers contained in this MoverContainer.

Author
Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

Reimplemented from protocols::moves::Mover.

References movers_.

void protocols::moves::MoverContainer::set_current_tag ( std::string const &  new_tag)
overridevirtual
void protocols::moves::MoverContainer::set_input_pose ( PoseCOP  pose)
overridevirtual

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)
overridevirtual

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

core::Size protocols::moves::MoverContainer::size ( ) const
inline

References movers_.

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

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: