Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::simple_moves::AddChainMover Class Reference

#include <AddChainMover.hh>

Inheritance diagram for protocols::simple_moves::AddChainMover:
Inheritance graph
[legend]

Public Member Functions

 AddChainMover ()
 
void apply (core::pose::Pose &pose) override
 Main Method. More...
 
moves::MoverOP clone () const override
 Return a clone of the Mover object. More...
 
moves::MoverOP fresh_instance () const override
 Generates a new Mover object freshly created with the default ctor. More...
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
void fname (std::string const &f)
 
std::string fname () const
 
void new_chain (bool const n)
 
bool new_chain () const
 
void swap_chain_number (core::Size const wc)
 
core::Size swap_chain_number () const
 
void scorefxn (core::scoring::ScoreFunctionOP s)
 
core::scoring::ScoreFunctionOP scorefxn () const
 
bool random_access () const
 
void random_access (bool const b)
 
void update_PDBInfo (bool const n)
 
bool update_PDBInfo () const
 
void add_new_chain (core::pose::Pose &pose) const
 
void swap_chain (core::pose::Pose &pose) const
 
std::string spm_reference_name () const
 
std::string get_name () const override
 Each derived class must specify its name. The class name. 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 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...
 
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...
 
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
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 
virtual void set_current_tag (std::string const &new_tag)
 
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 utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. 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...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Static Public Member Functions

static std::string mover_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
- 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...
 

Private Member Functions

void load_pose (core::pose::Pose &pose, std::string &name) const
 

Private Attributes

std::string fname_
 
bool new_chain_
 
bool random_access_
 
bool update_PDBInfo_
 
core::Size swap_chain_number_
 
core::scoring::ScoreFunctionOP scorefxn_
 
std::string spm_reference_name_
 
core::pose::PoseCOP spm_reference_pose_
 

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
 
- 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::simple_moves::AddChainMover::AddChainMover ( )

Member Function Documentation

void protocols::simple_moves::AddChainMover::add_new_chain ( core::pose::Pose pose) const
void protocols::simple_moves::AddChainMover::apply ( core::pose::Pose )
overridevirtual
moves::MoverOP protocols::simple_moves::AddChainMover::clone ( ) const
overridevirtual

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.

void protocols::simple_moves::AddChainMover::fname ( std::string const &  f)
inline

References fname_.

std::string protocols::simple_moves::AddChainMover::fname ( ) const
inline

References fname_.

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

moves::MoverOP protocols::simple_moves::AddChainMover::fresh_instance ( ) const
overridevirtual

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.

std::string protocols::simple_moves::AddChainMover::get_name ( ) const
overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

void protocols::simple_moves::AddChainMover::load_pose ( core::pose::Pose pose,
std::string &  name 
) const
private
std::string protocols::simple_moves::AddChainMover::mover_name ( )
static
void protocols::simple_moves::AddChainMover::new_chain ( bool const  n)
inline

References new_chain_.

bool protocols::simple_moves::AddChainMover::new_chain ( ) const
inline

References new_chain_.

Referenced by add_new_chain(), parse_my_tag(), and swap_chain().

void protocols::simple_moves::AddChainMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual

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 force people to reimplement this method. However, we should be chatty about the fact that someone is using a RosettaScripts interface to a mover which didn't define parse_my_tag()

Reimplemented from protocols::moves::Mover.

References fname(), new_chain(), core::scoring::parse_score_function(), random_access(), protocols::rosetta_scripts::saved_reference_pose(), scorefxn(), spm_reference_name_, spm_reference_pose_, swap_chain_number(), protocols::simple_moves::TR(), and update_PDBInfo().

void protocols::simple_moves::AddChainMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
bool protocols::simple_moves::AddChainMover::random_access ( ) const
inline

References random_access_.

Referenced by parse_my_tag().

void protocols::simple_moves::AddChainMover::random_access ( bool const  b)
inline
void protocols::simple_moves::AddChainMover::scorefxn ( core::scoring::ScoreFunctionOP  s)

References scorefxn_.

core::scoring::ScoreFunctionOP protocols::simple_moves::AddChainMover::scorefxn ( ) const

References scorefxn_.

Referenced by add_new_chain(), parse_my_tag(), and swap_chain().

std::string protocols::simple_moves::AddChainMover::spm_reference_name ( ) const
inline

References spm_reference_name_.

Referenced by apply(), and load_pose().

void protocols::simple_moves::AddChainMover::swap_chain ( core::pose::Pose pose) const
void protocols::simple_moves::AddChainMover::swap_chain_number ( core::Size const  wc)
inline

References swap_chain_number_.

core::Size protocols::simple_moves::AddChainMover::swap_chain_number ( ) const
inline
void protocols::simple_moves::AddChainMover::update_PDBInfo ( bool const  n)
inline

References update_PDBInfo_.

bool protocols::simple_moves::AddChainMover::update_PDBInfo ( ) const
inline

References update_PDBInfo_.

Referenced by parse_my_tag().

Member Data Documentation

std::string protocols::simple_moves::AddChainMover::fname_
private

Referenced by fname().

bool protocols::simple_moves::AddChainMover::new_chain_
private

Referenced by new_chain().

bool protocols::simple_moves::AddChainMover::random_access_
private

Referenced by AddChainMover(), and random_access().

core::scoring::ScoreFunctionOP protocols::simple_moves::AddChainMover::scorefxn_
private

Referenced by scorefxn().

std::string protocols::simple_moves::AddChainMover::spm_reference_name_
private
core::pose::PoseCOP protocols::simple_moves::AddChainMover::spm_reference_pose_
private

Referenced by load_pose(), and parse_my_tag().

core::Size protocols::simple_moves::AddChainMover::swap_chain_number_
private

Referenced by AddChainMover(), and swap_chain_number().

bool protocols::simple_moves::AddChainMover::update_PDBInfo_
private

Referenced by add_new_chain(), and update_PDBInfo().


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