Rosetta
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::protein_interface_design::movers::PrepackMover Class Reference

#include <PrepackMover.hh>

Inheritance diagram for protocols::protein_interface_design::movers::PrepackMover:
Inheritance graph
[legend]

Public Member Functions

 PrepackMover ()
 
 PrepackMover (core::scoring::ScoreFunctionCOP scorefxn, core::Size jump_num)
 
 ~PrepackMover () override
 
protocols::moves::MoverOP clone () const override
 required in the context of the parser/scripting scheme More...
 
protocols::moves::MoverOP fresh_instance () const override
 required in the context of the parser/scripting scheme More...
 
void apply (core::pose::Pose &pose) override
 
void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
 parse XML (specifically in the context of the parser/scripting scheme) More...
 
bool min_bb () const
 
void min_bb (bool const m)
 
core::kinematics::MoveMapOP mm (core::pose::Pose const &pose) const
 
void mmf (core::select::movemap::MoveMapFactoryCOP mmf)
 
void mm (core::kinematics::MoveMapOP mm)
 
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
 
- Public Member Functions inherited from protocols::minimization_packing::PackRotamersMover
 PackRotamersMover ()
 default constructor; reads the nloop_ value from the global options system. More...
 
 PackRotamersMover (utility::options::OptionCollection const &options)
 constructor that reads from the (possibly local) options collection object More...
 
 PackRotamersMover (std::string const &)
 constructor with typename; reads the nloop_ value from the global options system. More...
 
 PackRotamersMover (ScoreFunctionCOP scorefxn, PackerTaskCOP task=nullptr, core::Size nloop=1)
 Constructs a PackRotamersMover with PackerTask <task> evaluated using <scorefxn> More...
 
 ~PackRotamersMover () override
 
 PackRotamersMover (PackRotamersMover const &other)
 
void show (std::ostream &output=std::cout) const override
 Outputs details about the Mover, including current settings. More...
 
bool task_is_valid (Pose const &pose) const
 when the PackerTask was not generated locally, verify compatibility with pose More...
 
virtual void parse_score_function (TagCOP, basic::datacache::DataMap const &)
 parse "scorefxn" XML option (can be employed virtually by derived Packing movers) More...
 
virtual void parse_task_operations (TagCOP, basic::datacache::DataMap const &)
 parse "task_operations" XML option (can be employed virtually by derived Packing movers) More...
 
void initialize_task_factory_with_operations (std::list< core::pack::task::operation::TaskOperationCOP > const &)
 
void score_function (ScoreFunctionCOP sf)
 Sets the ScoreFunction to <sf> More...
 
virtual void task_factory (TaskFactoryCOP tf)
 Sets the TaskFactory to <tf> More...
 
void task (PackerTaskCOP t)
 Sets the PackerTask to <t> More...
 
void nloop (core::Size nloop_in)
 
ScoreFunctionCOP score_function () const
 Returns the ScoreFunction. More...
 
PackerTaskCOP task () const
 Returns the PackerTask. More...
 
core::Size nloop () const
 
TaskFactoryCOP task_factory () const
 Returns the TaskFactory. More...
 
RotamerSetsCOP rotamer_sets () const
 Returns the RotamerSets object being used for packing. More...
 
void set_annealer_observer (core::pack::annealer::AnnealerObserverOP observer)
 
- 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 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...
 

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::minimization_packing::PackRotamersMover
static std::string mover_name ()
 
static utility::tag::XMLSchemaComplexTypeGeneratorOP complex_type_generator_for_pack_rotamers_mover (utility::tag::XMLSchemaDefinition &xsd)
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
static void list_options_read (utility::options::OptionKeyList &opts)
 
- 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::scoring::ScoreFunctionCOP scorefxn_
 
core::Size jump_num_
 
bool min_bb_
 
core::select::movemap::MoveMapFactoryCOP mmf_
 
core::kinematics::MoveMapOP mm_
 

Additional Inherited Members

- Public Types inherited from protocols::minimization_packing::PackRotamersMover
typedef core::pack::interaction_graph::AnnealableGraphBaseOP AnnealableGraphBaseOP
 
typedef core::pack::interaction_graph::AnnealableGraphBaseCOP AnnealableGraphBaseCOP
 
typedef core::pack::rotamer_set::RotamerSetsOP RotamerSetsOP
 
typedef core::pack::rotamer_set::RotamerSetsCOP RotamerSetsCOP
 
typedef core::pack::task::PackerTaskCOP PackerTaskCOP
 
typedef core::pack::task::TaskFactoryCOP TaskFactoryCOP
 
typedef core::scoring::ScoreFunctionCOP ScoreFunctionCOP
 
- 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::minimization_packing::PackRotamersMover
virtual void setup (Pose &pose)
 get rotamers, energies. Also performs lazy initialization of ScoreFunction, PackerTask. More...
 
virtual core::PackerEnergy run (Pose &pose, utility::vector0< int > rot_to_pack=utility::vector0< int >()) const
 
virtual void cleanup (core::pose::Pose &pose)
 Clean up cached pose and mover data after the fact. More...
 
virtual void note_packertask_settings (Pose const &)
 note PackerTask's packable and designable residues as string info 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

◆ PrepackMover() [1/2]

protocols::protein_interface_design::movers::PrepackMover::PrepackMover ( )

◆ PrepackMover() [2/2]

protocols::protein_interface_design::movers::PrepackMover::PrepackMover ( core::scoring::ScoreFunctionCOP  scorefxn,
core::Size  jump_num 
)

◆ ~PrepackMover()

protocols::protein_interface_design::movers::PrepackMover::~PrepackMover ( )
overridedefault

Member Function Documentation

◆ apply()

void protocols::protein_interface_design::movers::PrepackMover::apply ( core::pose::Pose pose)
overridevirtual

◆ clone()

protocols::moves::MoverOP protocols::protein_interface_design::movers::PrepackMover::clone ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::minimization_packing::PackRotamersMover.

◆ fresh_instance()

protocols::moves::MoverOP protocols::protein_interface_design::movers::PrepackMover::fresh_instance ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::minimization_packing::PackRotamersMover.

◆ get_name()

std::string protocols::protein_interface_design::movers::PrepackMover::get_name ( ) const
overridevirtual

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

Reimplemented from protocols::minimization_packing::PackRotamersMover.

References mover_name().

◆ min_bb() [1/2]

bool protocols::protein_interface_design::movers::PrepackMover::min_bb ( ) const

References min_bb_.

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

◆ min_bb() [2/2]

void protocols::protein_interface_design::movers::PrepackMover::min_bb ( bool const  m)

References min_bb_.

◆ mm() [1/2]

void protocols::protein_interface_design::movers::PrepackMover::mm ( core::kinematics::MoveMapOP  mm)

References mm(), and mm_.

◆ mm() [2/2]

core::kinematics::MoveMapOP protocols::protein_interface_design::movers::PrepackMover::mm ( core::pose::Pose const &  pose) const

◆ mmf()

void protocols::protein_interface_design::movers::PrepackMover::mmf ( core::select::movemap::MoveMapFactoryCOP  mmf)

References mmf_.

◆ mover_name()

std::string protocols::protein_interface_design::movers::PrepackMover::mover_name ( )
static

◆ parse_my_tag()

void protocols::protein_interface_design::movers::PrepackMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap datamap 
)
overridevirtual

◆ provide_xml_schema()

void protocols::protein_interface_design::movers::PrepackMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

Member Data Documentation

◆ jump_num_

core::Size protocols::protein_interface_design::movers::PrepackMover::jump_num_
private

Referenced by apply(), and parse_my_tag().

◆ min_bb_

bool protocols::protein_interface_design::movers::PrepackMover::min_bb_
private

Referenced by min_bb().

◆ mm_

core::kinematics::MoveMapOP protocols::protein_interface_design::movers::PrepackMover::mm_
private

Referenced by mm().

◆ mmf_

core::select::movemap::MoveMapFactoryCOP protocols::protein_interface_design::movers::PrepackMover::mmf_
private

Referenced by mm(), mmf(), and parse_my_tag().

◆ scorefxn_

core::scoring::ScoreFunctionCOP protocols::protein_interface_design::movers::PrepackMover::scorefxn_
private

Referenced by apply(), and parse_my_tag().


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