Rosetta
Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::floppy_tail::FloppyTailMover Class Reference

FloppyTail mover. More...

#include <FloppyTailMover.hh>

Inheritance diagram for protocols::floppy_tail::FloppyTailMover:
Inheritance graph
[legend]

Public Member Functions

 FloppyTailMover ()
 ctor with no arguments More...
 
 FloppyTailMover (FloppyTailMover const &rhs)
 copy ctor More...
 
FloppyTailMoveroperator= (FloppyTailMover const &rhs)
 assignment operator More...
 
 ~FloppyTailMover () 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)
 
virtual void set_cen_scorefxn (core::scoring::ScoreFunctionOP const cen_scorefunction)
 
void apply (core::pose::Pose &pose) override
 Main Method. More...
 
virtual void low_res (core::pose::Pose &pose)
 
virtual void high_res (core::pose::Pose &pose)
 
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...
 
- 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
 
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...
 
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 void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...
 

Private Member Functions

virtual void init_on_new_input (core::pose::Pose const &pose)
 init_on_new_input system allows for initializing these details the first time apply() is called. The job distributor will reinitialize the whole mover when the input changes (a freshly constructed mover, which will re-run this on first apply()). 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::fragment::ConstantLengthFragSetOP fragset3mer_
 

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

Detailed Description

FloppyTail mover.

Constructor & Destructor Documentation

◆ FloppyTailMover() [1/2]

protocols::floppy_tail::FloppyTailMover::FloppyTailMover ( )

◆ FloppyTailMover() [2/2]

protocols::floppy_tail::FloppyTailMover::FloppyTailMover ( FloppyTailMover const &  rhs)

copy ctor

◆ ~FloppyTailMover()

protocols::floppy_tail::FloppyTailMover::~FloppyTailMover ( )
overridedefault

Member Function Documentation

◆ apply()

void protocols::floppy_tail::FloppyTailMover::apply ( core::pose::Pose )
overridevirtual

◆ fresh_instance()

protocols::moves::MoverOP protocols::floppy_tail::FloppyTailMover::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.

◆ get_name()

std::string protocols::floppy_tail::FloppyTailMover::get_name ( ) const
inlineoverridevirtual

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

Implements protocols::moves::Mover.

◆ high_res()

void protocols::floppy_tail::FloppyTailMover::high_res ( core::pose::Pose pose)
virtual

◆ init_on_new_input()

void protocols::floppy_tail::FloppyTailMover::init_on_new_input ( core::pose::Pose const &  pose)
privatevirtual

◆ low_res()

void protocols::floppy_tail::FloppyTailMover::low_res ( core::pose::Pose pose)
virtual

◆ operator=()

FloppyTailMover & protocols::floppy_tail::FloppyTailMover::operator= ( FloppyTailMover const &  rhs)

◆ reinitialize_for_each_job()

bool protocols::floppy_tail::FloppyTailMover::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.

◆ reinitialize_for_new_input()

bool protocols::floppy_tail::FloppyTailMover::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.

◆ set_cen_scorefxn()

void protocols::floppy_tail::FloppyTailMover::set_cen_scorefxn ( core::scoring::ScoreFunctionOP const  cen_scorefunction)
virtual

◆ set_fa_scorefxn()

void protocols::floppy_tail::FloppyTailMover::set_fa_scorefxn ( core::scoring::ScoreFunctionOP const  fa_scorefxn)
virtual

◆ set_movemap()

void protocols::floppy_tail::FloppyTailMover::set_movemap ( core::kinematics::MoveMapOP const  movemap)
virtual

set the movemap instead of initializing it from cmd-line

References movemap_.

Member Data Documentation

◆ centroid_scorefunction_

core::scoring::ScoreFunctionOP protocols::floppy_tail::FloppyTailMover::centroid_scorefunction_
private

◆ foldtree_

core::kinematics::FoldTreeOP protocols::floppy_tail::FloppyTailMover::foldtree_
private

stored so that it can be generated in the init_on_new_input function

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

◆ fragset3mer_

core::fragment::ConstantLengthFragSetOP protocols::floppy_tail::FloppyTailMover::fragset3mer_
private

Referenced by FloppyTailMover(), low_res(), and operator=().

◆ fullatom_scorefunction_

core::scoring::ScoreFunctionOP protocols::floppy_tail::FloppyTailMover::fullatom_scorefunction_
private

◆ init_for_input_yet_

bool protocols::floppy_tail::FloppyTailMover::init_for_input_yet_
private

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

◆ movemap_

core::kinematics::MoveMapOP protocols::floppy_tail::FloppyTailMover::movemap_
private

◆ movemap_lesstail_

core::kinematics::MoveMapOP protocols::floppy_tail::FloppyTailMover::movemap_lesstail_
private

◆ start_

core::Size protocols::floppy_tail::FloppyTailMover::start_
private

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

◆ stop_

core::Size protocols::floppy_tail::FloppyTailMover::stop_
private

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

◆ task_factory_

core::pack::task::TaskFactoryOP protocols::floppy_tail::FloppyTailMover::task_factory_
private

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