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

FloppyTail mover. More...

#include <TailSegmentMover.hh>

Inheritance diagram for protocols::splice::TailSegmentMover:
Inheritance graph
[legend]

Public Member Functions

 TailSegmentMover ()
 ctor with no arguments More...
 
 TailSegmentMover (TailSegmentMover const &rhs)
 copy ctor More...
 
TailSegmentMoveroperator= (TailSegmentMover const &rhs)
 assignment operator More...
 
 ~TailSegmentMover () override
 
virtual void set_movemap (core::kinematics::MoveMapOP const movemap)
 set the movemap instead of initializing it from cmd-line More...
 
virtual void set_fa_scorefxn (core::scoring::ScoreFunctionOP const fa_scorefxn)
 
void apply (core::pose::Pose &pose) override
 Main Method. More...
 
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
 
protocols::moves::MoverOP fresh_instance () const override
 Generates a new Mover object freshly created with the default ctor. More...
 
bool reinitialize_for_each_job () const override
 Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...
 
bool reinitialize_for_new_input () const override
 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 temp_initial (core::Real value)
 
void temp_final (core::Real value)
 
void set_task_factory (core::pack::task::TaskFactoryCOP task_factory_in)
 
void fullatom_scorefunction (core::scoring::ScoreFunctionOP SF_in)
 
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &data) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
core::scoring::ScoreFunctionOP get_scorefunction ()
 
- 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...
 
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 void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
static std::string mover_name ()
 
- 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 Attributes

core::Size start_
 
core::Size stop_
 
bool init_for_input_yet_
 
core::scoring::ScoreFunctionOP centroid_scorefunction_
 
core::scoring::ScoreFunctionOP fullatom_scorefunction_
 
core::pack::task::TaskFactoryOP task_factory_
 
core::kinematics::MoveMapOP movemap_
 
core::kinematics::MoveMapOP movemap_lesstail_
 
core::kinematics::FoldTreeOP foldtree_
 stored so that it can be generated in the init_on_new_input function More...
 
core::Real temp_initial_
 
core::Real temp_final_
 

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

Detailed Description

FloppyTail mover.

Constructor & Destructor Documentation

protocols::splice::TailSegmentMover::TailSegmentMover ( )

ctor with no arguments

References protocols::moves::Mover::type().

protocols::splice::TailSegmentMover::TailSegmentMover ( TailSegmentMover const &  rhs)

copy ctor

protocols::splice::TailSegmentMover::~TailSegmentMover ( )
overridedefault

Member Function Documentation

void protocols::splice::TailSegmentMover::apply ( core::pose::Pose )
overridevirtual
protocols::moves::MoverOP protocols::splice::TailSegmentMover::fresh_instance ( ) const
inlineoverridevirtual

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.

void protocols::splice::TailSegmentMover::fullatom_scorefunction ( core::scoring::ScoreFunctionOP  SF_in)
inline

References fullatom_scorefunction_.

Referenced by parse_my_tag().

std::string protocols::splice::TailSegmentMover::get_name ( ) const
inlineoverridevirtual

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

Implements protocols::moves::Mover.

core::scoring::ScoreFunctionOP protocols::splice::TailSegmentMover::get_scorefunction ( )
inline
std::string protocols::splice::TailSegmentMover::mover_name ( )
static

Referenced by provide_xml_schema().

TailSegmentMover & protocols::splice::TailSegmentMover::operator= ( TailSegmentMover const &  rhs)
void protocols::splice::TailSegmentMover::parse_my_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 fullatom_scorefunction(), core::scoring::parse_score_function(), core::pack::task::parse_task_operations(), and set_task_factory().

void protocols::splice::TailSegmentMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
bool protocols::splice::TailSegmentMover::reinitialize_for_each_job ( ) const
inlineoverridevirtual

Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use.

Movers default to not regenerating

Reimplemented from protocols::moves::Mover.

bool protocols::splice::TailSegmentMover::reinitialize_for_new_input ( ) const
inlineoverridevirtual

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

Movers default to not regenerating

Reimplemented from protocols::moves::Mover.

void protocols::splice::TailSegmentMover::set_fa_scorefxn ( core::scoring::ScoreFunctionOP const  fa_scorefxn)
virtual
void protocols::splice::TailSegmentMover::set_movemap ( core::kinematics::MoveMapOP const  movemap)
virtual

set the movemap instead of initializing it from cmd-line

References movemap_.

Referenced by protocols::splice::SpliceOut::tail_mover().

void protocols::splice::TailSegmentMover::set_task_factory ( core::pack::task::TaskFactoryCOP  task_factory_in)
void protocols::splice::TailSegmentMover::temp_final ( core::Real  value)
inline

References temp_final_.

void protocols::splice::TailSegmentMover::temp_initial ( core::Real  value)
inline

Member Data Documentation

core::scoring::ScoreFunctionOP protocols::splice::TailSegmentMover::centroid_scorefunction_
private

Referenced by operator=().

core::kinematics::FoldTreeOP protocols::splice::TailSegmentMover::foldtree_
private

stored so that it can be generated in the init_on_new_input function

Referenced by operator=().

core::scoring::ScoreFunctionOP protocols::splice::TailSegmentMover::fullatom_scorefunction_
private
bool protocols::splice::TailSegmentMover::init_for_input_yet_
private

Referenced by operator=().

core::kinematics::MoveMapOP protocols::splice::TailSegmentMover::movemap_
private

Referenced by apply(), operator=(), and set_movemap().

core::kinematics::MoveMapOP protocols::splice::TailSegmentMover::movemap_lesstail_
private

Referenced by operator=().

core::Size protocols::splice::TailSegmentMover::start_
private

Referenced by apply(), and operator=().

core::Size protocols::splice::TailSegmentMover::stop_
private

Referenced by apply(), and operator=().

core::pack::task::TaskFactoryOP protocols::splice::TailSegmentMover::task_factory_
private

Referenced by apply(), operator=(), and set_task_factory().

core::Real protocols::splice::TailSegmentMover::temp_final_
private

Referenced by temp_final().

core::Real protocols::splice::TailSegmentMover::temp_initial_
private

Referenced by apply(), and temp_initial().


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