constraint_movers¶
Bindings for protocols::constraint_movers namespace
- class pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover¶
Bases:
Mover
- class AtomSelector¶
Bases:
pybind11_object
Members:
ALL
CA_ONLY
BB_ONLY
SC_TIP_ONLY
- ALL = <AtomSelector.ALL: 0>¶
- BB_ONLY = <AtomSelector.BB_ONLY: 2>¶
- CA_ONLY = <AtomSelector.CA_ONLY: 1>¶
- SC_TIP_ONLY = <AtomSelector.SC_TIP_ONLY: 3>¶
- property name¶
- property value¶
- CA_only(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) bool ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::CA_only() const –> bool
- apply(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::apply(class core::pose::Pose &) –> void
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover, : pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::operator=(const class protocols::constraint_movers::AddConstraintsToCurrentConformationMover &) –> class protocols::constraint_movers::AddConstraintsToCurrentConformationMover &
- atom_selector(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover.AtomSelector ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::atom_selector() const –> enum protocols::constraint_movers::AddConstraintsToCurrentConformationMover::AtomSelector
- bb_only(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) bool ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::bb_only() const –> bool
- bound_width(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) float ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::bound_width() –> double &
- clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
clear_info is called by jd2 before calling apply
C++: protocols::moves::Mover::clear_info() –> void
- clone(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>
- coord_dev(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) float ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::coord_dev() –> double &
- create(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>
- cst_weight(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) float ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::cst_weight() –> double &
- fresh_instance(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>
- generate_constraints(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover, pose: pyrosetta.rosetta.core.pose.Pose) pyrosetta.rosetta.utility.vector1_std_shared_ptr_const_core_scoring_constraints_Constraint_t ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::generate_constraints(const class core::pose::Pose &) –> class utility::vector1<class std::shared_ptr<const class core::scoring::constraints::Constraint>, class std::allocator<class std::shared_ptr<const class core::scoring::constraints::Constraint> > >
- get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
fpd
Mechanism by which a mover may return multiple output poses from a single input pose.
Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.
C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>
- get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) protocols::jobdist::BasicJob ¶
C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>
- get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
- 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.
C++: protocols::moves::Mover::get_current_tag() const –> std::string
- get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.MoverStatus ¶
returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.
C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus
- get_name(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) str ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::get_name() const –> std::string
- get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>
- get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t ¶
C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>
- get_type(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
C++: protocols::moves::Mover::get_type() const –> std::string
- info(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.list_std_string_t ¶
non-const accessor
C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &
- inter_chain(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) bool ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::inter_chain() –> bool &
- last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) float ¶
C++: protocols::moves::Mover::last_proposal_density_ratio() –> double
- max_distance(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) float ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::max_distance() –> double &
- min_seq_sep(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) int ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::min_seq_sep() –> unsigned long &
- static mover_name() str ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::mover_name() –> std::string
- static name() str ¶
C++: protocols::moves::Mover::name() –> std::string
- parse_my_tag(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) None ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void
- provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) None ¶
- Provide citations to the passed CitationCollectionList
Subclasses should add the info for themselves and any other classes they use.
The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.
C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void
- static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) None ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void
- static register_options() None ¶
Overload this static method if you access options within the mover.
These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.
C++: protocols::moves::Mover::register_options() –> void
- reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on
each use.
C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool
- reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- 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).
C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool
- reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
C++: protocols::moves::Mover::reset_status() –> void
- residue_selector(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover, selector: pyrosetta.rosetta.core.select.residue_selector.ResidueSelector) None ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::residue_selector(class std::shared_ptr<const class core::select::residue_selector::ResidueSelector>) –> void
- sc_tip_only(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) bool ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::sc_tip_only() const –> bool
- set_atom_selector(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover, setting: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover.AtomSelector) None ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::set_atom_selector(const enum protocols::constraint_movers::AddConstraintsToCurrentConformationMover::AtomSelector) –> void
- set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) None ¶
C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void
- set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) None ¶
C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void
- set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for poses contained for rms
C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe
C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) None ¶
Set the ‘type’ string
C++: protocols::moves::Mover::set_type(const std::string &) –> void
- show(*args, **kwargs)¶
Overloaded function.
show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None
Outputs details about the Mover, including current settings.
C++: protocols::moves::Mover::show(std::ostream &) const –> void
- task_factory(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover, tf: pyrosetta.rosetta.core.pack.task.TaskFactory) None ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::task_factory(class std::shared_ptr<class core::pack::task::TaskFactory>) –> void
- test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
- : Unit test support function. Apply one move to a given pose.
Allows extra test specific functions to be called before applying
C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void
- type(*args, **kwargs)¶
Overloaded function.
type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None
Set the ‘type’ string
C++: protocols::moves::Mover::type(const std::string &) –> void
type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str
Get the set ‘type’ string
C++: protocols::moves::Mover::type() const –> const std::string &
- use_bounded_func(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) bool ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::use_bounded_func() –> bool &
- use_distance_cst(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) bool ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::use_distance_cst() –> bool &
- use_harmonic_func(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMover) bool ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMover::use_harmonic_func() –> bool &
- class pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMoverCreator¶
Bases:
MoverCreator
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMoverCreator, : pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMoverCreator) pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMoverCreator ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMoverCreator::operator=(const class protocols::constraint_movers::AddConstraintsToCurrentConformationMoverCreator &) –> class protocols::constraint_movers::AddConstraintsToCurrentConformationMoverCreator &
- create_mover(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMoverCreator) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>
- keyname(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMoverCreator) str ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMoverCreator::keyname() const –> std::string
- provide_xml_schema(self: pyrosetta.rosetta.protocols.constraint_movers.AddConstraintsToCurrentConformationMoverCreator, xsd: utility::tag::XMLSchemaDefinition) None ¶
C++: protocols::constraint_movers::AddConstraintsToCurrentConformationMoverCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void
- class pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover¶
Bases:
Mover
- apply(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover, : pyrosetta.rosetta.core.pose.Pose) None ¶
C++: protocols::constraint_movers::ClearConstraintsMover::apply(class core::pose::Pose &) –> void
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover, : pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover) pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover ¶
C++: protocols::constraint_movers::ClearConstraintsMover::operator=(const class protocols::constraint_movers::ClearConstraintsMover &) –> class protocols::constraint_movers::ClearConstraintsMover &
- clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
clear_info is called by jd2 before calling apply
C++: protocols::moves::Mover::clear_info() –> void
- clone(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ClearConstraintsMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>
- create(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>
- fresh_instance(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ClearConstraintsMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>
- get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
fpd
Mechanism by which a mover may return multiple output poses from a single input pose.
Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.
C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>
- get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) protocols::jobdist::BasicJob ¶
C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>
- get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
- 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.
C++: protocols::moves::Mover::get_current_tag() const –> std::string
- get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.MoverStatus ¶
returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.
C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus
- get_name(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover) str ¶
C++: protocols::constraint_movers::ClearConstraintsMover::get_name() const –> std::string
- get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>
- get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t ¶
C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>
- get_type(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
C++: protocols::moves::Mover::get_type() const –> std::string
- info(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.list_std_string_t ¶
non-const accessor
C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &
- last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) float ¶
C++: protocols::moves::Mover::last_proposal_density_ratio() –> double
- static mover_name() str ¶
C++: protocols::constraint_movers::ClearConstraintsMover::mover_name() –> std::string
- static name() str ¶
C++: protocols::moves::Mover::name() –> std::string
- parse_my_tag(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMover, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) None ¶
C++: protocols::constraint_movers::ClearConstraintsMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void
- provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) None ¶
- Provide citations to the passed CitationCollectionList
Subclasses should add the info for themselves and any other classes they use.
The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.
C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void
- static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) None ¶
C++: protocols::constraint_movers::ClearConstraintsMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void
- static register_options() None ¶
Overload this static method if you access options within the mover.
These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.
C++: protocols::moves::Mover::register_options() –> void
- reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on
each use.
C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool
- reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- 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).
C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool
- reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
C++: protocols::moves::Mover::reset_status() –> void
- set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) None ¶
C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void
- set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) None ¶
C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void
- set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for poses contained for rms
C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe
C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) None ¶
Set the ‘type’ string
C++: protocols::moves::Mover::set_type(const std::string &) –> void
- show(*args, **kwargs)¶
Overloaded function.
show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None
Outputs details about the Mover, including current settings.
C++: protocols::moves::Mover::show(std::ostream &) const –> void
- test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
- : Unit test support function. Apply one move to a given pose.
Allows extra test specific functions to be called before applying
C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void
- type(*args, **kwargs)¶
Overloaded function.
type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None
Set the ‘type’ string
C++: protocols::moves::Mover::type(const std::string &) –> void
type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str
Get the set ‘type’ string
C++: protocols::moves::Mover::type() const –> const std::string &
- class pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMoverCreator¶
Bases:
MoverCreator
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMoverCreator, : pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMoverCreator) pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMoverCreator ¶
C++: protocols::constraint_movers::ClearConstraintsMoverCreator::operator=(const class protocols::constraint_movers::ClearConstraintsMoverCreator &) –> class protocols::constraint_movers::ClearConstraintsMoverCreator &
- create_mover(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMoverCreator) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ClearConstraintsMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>
- keyname(self: pyrosetta.rosetta.protocols.constraint_movers.ClearConstraintsMoverCreator) str ¶
C++: protocols::constraint_movers::ClearConstraintsMoverCreator::keyname() const –> std::string
- class pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover¶
Bases:
Mover
- add_constraints(*args, **kwargs)¶
Overloaded function.
add_constraints(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, a: bool) -> None
C++: protocols::constraint_movers::ConstraintSetMover::add_constraints(const bool) –> void
add_constraints(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover) -> bool
C++: protocols::constraint_movers::ConstraintSetMover::add_constraints() const –> bool
- apply(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, : pyrosetta.rosetta.core.pose.Pose) None ¶
C++: protocols::constraint_movers::ConstraintSetMover::apply(class core::pose::Pose &) –> void
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, : pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover) pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover ¶
C++: protocols::constraint_movers::ConstraintSetMover::operator=(const class protocols::constraint_movers::ConstraintSetMover &) –> class protocols::constraint_movers::ConstraintSetMover &
- clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
clear_info is called by jd2 before calling apply
C++: protocols::moves::Mover::clear_info() –> void
- clone(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ConstraintSetMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>
- constraint_file(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, : str) None ¶
C++: protocols::constraint_movers::ConstraintSetMover::constraint_file(const std::string &) –> void
- constraint_set(*args, **kwargs)¶
Overloaded function.
constraint_set(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, : pyrosetta.rosetta.core.scoring.constraints.ConstraintSet) -> None
C++: protocols::constraint_movers::ConstraintSetMover::constraint_set(class std::shared_ptr<const class core::scoring::constraints::ConstraintSet>) –> void
constraint_set(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover) -> pyrosetta.rosetta.core.scoring.constraints.ConstraintSet
C++: protocols::constraint_movers::ConstraintSetMover::constraint_set() –> class std::shared_ptr<class core::scoring::constraints::ConstraintSet>
- create(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>
- fresh_instance(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ConstraintSetMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>
- get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
fpd
Mechanism by which a mover may return multiple output poses from a single input pose.
Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.
C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>
- get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) protocols::jobdist::BasicJob ¶
C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>
- get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
- 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.
C++: protocols::moves::Mover::get_current_tag() const –> std::string
- get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.MoverStatus ¶
returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.
C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus
- get_name(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover) str ¶
C++: protocols::constraint_movers::ConstraintSetMover::get_name() const –> std::string
- get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>
- get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t ¶
C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>
- get_type(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
C++: protocols::moves::Mover::get_type() const –> std::string
- info(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.list_std_string_t ¶
non-const accessor
C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &
- last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) float ¶
C++: protocols::moves::Mover::last_proposal_density_ratio() –> double
- static mover_name() str ¶
C++: protocols::constraint_movers::ConstraintSetMover::mover_name() –> std::string
- static name() str ¶
C++: protocols::moves::Mover::name() –> std::string
- parse_my_tag(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) None ¶
C++: protocols::constraint_movers::ConstraintSetMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void
- provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) None ¶
- Provide citations to the passed CitationCollectionList
Subclasses should add the info for themselves and any other classes they use.
The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.
C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void
- static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) None ¶
C++: protocols::constraint_movers::ConstraintSetMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void
- read_options(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover) None ¶
C++: protocols::constraint_movers::ConstraintSetMover::read_options() –> void
- static register_options() None ¶
Associates relevant options with the ConstraintSetMover class
C++: protocols::constraint_movers::ConstraintSetMover::register_options() –> void
- reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on
each use.
C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool
- reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- 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).
C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool
- reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
C++: protocols::moves::Mover::reset_status() –> void
- set_cst_fa_file(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, file_name: str) None ¶
Set the (full-atom) constraint file name.
Vikram K. Mulligan (vmulligan.org).
C++: protocols::constraint_movers::ConstraintSetMover::set_cst_fa_file(const std::string &) –> void
- set_cst_file(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, file_name: str) None ¶
Set the (centroid) constraint file name.
Vikram K. Mulligan (vmulligan.org).
C++: protocols::constraint_movers::ConstraintSetMover::set_cst_file(const std::string &) –> void
- set_cst_map_file(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, file_name: str) None ¶
Set the constraint map file name.
C++: protocols::constraint_movers::ConstraintSetMover::set_cst_map_file(const std::string &) –> void
- set_cst_map_file_contents(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMover, file_contents: str) None ¶
Set the constraint map file from previously loaded file contents in memory.
C++: protocols::constraint_movers::ConstraintSetMover::set_cst_map_file_contents(const std::string &) –> void
- set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) None ¶
C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void
- set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) None ¶
C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void
- set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for poses contained for rms
C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe
C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) None ¶
Set the ‘type’ string
C++: protocols::moves::Mover::set_type(const std::string &) –> void
- show(*args, **kwargs)¶
Overloaded function.
show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None
Outputs details about the Mover, including current settings.
C++: protocols::moves::Mover::show(std::ostream &) const –> void
- test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
- : Unit test support function. Apply one move to a given pose.
Allows extra test specific functions to be called before applying
C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void
- type(*args, **kwargs)¶
Overloaded function.
type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None
Set the ‘type’ string
C++: protocols::moves::Mover::type(const std::string &) –> void
type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str
Get the set ‘type’ string
C++: protocols::moves::Mover::type() const –> const std::string &
- class pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMoverCreator¶
Bases:
MoverCreator
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMoverCreator, : pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMoverCreator) pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMoverCreator ¶
C++: protocols::constraint_movers::ConstraintSetMoverCreator::operator=(const class protocols::constraint_movers::ConstraintSetMoverCreator &) –> class protocols::constraint_movers::ConstraintSetMoverCreator &
- create_mover(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMoverCreator) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ConstraintSetMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>
- keyname(self: pyrosetta.rosetta.protocols.constraint_movers.ConstraintSetMoverCreator) str ¶
C++: protocols::constraint_movers::ConstraintSetMoverCreator::keyname() const –> std::string
- class pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover¶
Bases:
Mover
A Mover to output information about constraints
- add_info_for_csts(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, cstlist: pyrosetta.rosetta.utility.vector1_std_shared_ptr_const_core_scoring_constraints_Constraint_t, pose: pyrosetta.rosetta.core.pose.Pose, tag: str) None ¶
C++: protocols::constraint_movers::CstInfoMover::add_info_for_csts(const class utility::vector1<class std::shared_ptr<const class core::scoring::constraints::Constraint>, class std::allocator<class std::shared_ptr<const class core::scoring::constraints::Constraint> > > &, class core::pose::Pose &, const std::string &) const –> void
- apply(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
C++: protocols::constraint_movers::CstInfoMover::apply(class core::pose::Pose &) –> void
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, : pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover ¶
C++: protocols::constraint_movers::CstInfoMover::operator=(const class protocols::constraint_movers::CstInfoMover &) –> class protocols::constraint_movers::CstInfoMover &
- clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
clear_info is called by jd2 before calling apply
C++: protocols::moves::Mover::clear_info() –> void
- clone(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) pyrosetta.rosetta.protocols.moves.Mover ¶
required in the context of the parser/scripting scheme
C++: protocols::constraint_movers::CstInfoMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>
- create(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>
- cst_file(*args, **kwargs)¶
Overloaded function.
cst_file(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, setting: str) -> None
C++: protocols::constraint_movers::CstInfoMover::cst_file(const std::string &) –> void
cst_file(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) -> str
C++: protocols::constraint_movers::CstInfoMover::cst_file() const –> const std::string &
- dump_cst_file(*args, **kwargs)¶
Overloaded function.
dump_cst_file(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, setting: str) -> None
C++: protocols::constraint_movers::CstInfoMover::dump_cst_file(const std::string &) –> void
dump_cst_file(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) -> str
C++: protocols::constraint_movers::CstInfoMover::dump_cst_file() const –> const std::string &
- fresh_instance(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) pyrosetta.rosetta.protocols.moves.Mover ¶
required in the context of the parser/scripting scheme
C++: protocols::constraint_movers::CstInfoMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>
- get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
fpd
Mechanism by which a mover may return multiple output poses from a single input pose.
Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.
C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>
- get_constraints_from_file(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, filename: str, pose: pyrosetta.rosetta.core.pose.Pose) pyrosetta.rosetta.utility.vector1_std_shared_ptr_const_core_scoring_constraints_Constraint_t ¶
C++: protocols::constraint_movers::CstInfoMover::get_constraints_from_file(const std::string &, const class core::pose::Pose &) const –> class utility::vector1<class std::shared_ptr<const class core::scoring::constraints::Constraint>, class std::allocator<class std::shared_ptr<const class core::scoring::constraints::Constraint> > >
- get_constraints_from_pose(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, pose: pyrosetta.rosetta.core.pose.Pose) pyrosetta.rosetta.utility.vector1_std_shared_ptr_const_core_scoring_constraints_Constraint_t ¶
C++: protocols::constraint_movers::CstInfoMover::get_constraints_from_pose(const class core::pose::Pose &) const –> class utility::vector1<class std::shared_ptr<const class core::scoring::constraints::Constraint>, class std::allocator<class std::shared_ptr<const class core::scoring::constraints::Constraint> > >
- get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) protocols::jobdist::BasicJob ¶
C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>
- get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
- 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.
C++: protocols::moves::Mover::get_current_tag() const –> std::string
- get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.MoverStatus ¶
returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.
C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus
- get_name(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) str ¶
C++: protocols::constraint_movers::CstInfoMover::get_name() const –> std::string
- get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>
- get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t ¶
C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>
- get_type(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
C++: protocols::moves::Mover::get_type() const –> std::string
- info(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.list_std_string_t ¶
non-const accessor
C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &
- last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) float ¶
C++: protocols::moves::Mover::last_proposal_density_ratio() –> double
- static mover_name() str ¶
C++: protocols::constraint_movers::CstInfoMover::mover_name() –> std::string
- static name() str ¶
C++: protocols::moves::Mover::name() –> std::string
- parse_my_tag(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) None ¶
parse XML tag (to use this Mover in Rosetta Scripts)
C++: protocols::constraint_movers::CstInfoMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void
- prefix(*args, **kwargs)¶
Overloaded function.
prefix(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, setting: str) -> None
C++: protocols::constraint_movers::CstInfoMover::prefix(const std::string &) –> void
prefix(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) -> str
C++: protocols::constraint_movers::CstInfoMover::prefix() const –> const std::string &
- provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) None ¶
- Provide citations to the passed CitationCollectionList
Subclasses should add the info for themselves and any other classes they use.
The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.
C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void
- static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) None ¶
C++: protocols::constraint_movers::CstInfoMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void
- recursive(*args, **kwargs)¶
Overloaded function.
recursive(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, setting: bool) -> None
C++: protocols::constraint_movers::CstInfoMover::recursive(bool) –> void
recursive(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) -> bool
C++: protocols::constraint_movers::CstInfoMover::recursive() const –> bool
- static register_options() None ¶
Overload this static method if you access options within the mover.
These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.
C++: protocols::moves::Mover::register_options() –> void
- reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on
each use.
C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool
- reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- 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).
C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool
- reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
C++: protocols::moves::Mover::reset_status() –> void
- set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) None ¶
C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void
- set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) None ¶
C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void
- set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for poses contained for rms
C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe
C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) None ¶
Set the ‘type’ string
C++: protocols::moves::Mover::set_type(const std::string &) –> void
- show(*args, **kwargs)¶
Overloaded function.
show(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover) -> None
show(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMover, output: pyrosetta.rosetta.std.ostream) -> None
C++: protocols::constraint_movers::CstInfoMover::show(std::ostream &) const –> void
- test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
- : Unit test support function. Apply one move to a given pose.
Allows extra test specific functions to be called before applying
C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void
- type(*args, **kwargs)¶
Overloaded function.
type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None
Set the ‘type’ string
C++: protocols::moves::Mover::type(const std::string &) –> void
type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str
Get the set ‘type’ string
C++: protocols::moves::Mover::type() const –> const std::string &
- class pyrosetta.rosetta.protocols.constraint_movers.CstInfoMoverCreator¶
Bases:
MoverCreator
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMoverCreator, : pyrosetta.rosetta.protocols.constraint_movers.CstInfoMoverCreator) pyrosetta.rosetta.protocols.constraint_movers.CstInfoMoverCreator ¶
C++: protocols::constraint_movers::CstInfoMoverCreator::operator=(const class protocols::constraint_movers::CstInfoMoverCreator &) –> class protocols::constraint_movers::CstInfoMoverCreator &
- create_mover(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMoverCreator) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::CstInfoMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>
- keyname(self: pyrosetta.rosetta.protocols.constraint_movers.CstInfoMoverCreator) str ¶
C++: protocols::constraint_movers::CstInfoMoverCreator::keyname() const –> std::string
- class pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover¶
Bases:
Mover
- apply(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover, : pyrosetta.rosetta.core.pose.Pose) None ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::apply(class core::pose::Pose &) –> void
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover, : pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover) pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::operator=(const class protocols::constraint_movers::ResidueTypeConstraintMover &) –> class protocols::constraint_movers::ResidueTypeConstraintMover &
- clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
clear_info is called by jd2 before calling apply
C++: protocols::moves::Mover::clear_info() –> void
- clone(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>
- create(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>
- fresh_instance(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>
- get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
fpd
Mechanism by which a mover may return multiple output poses from a single input pose.
Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.
C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>
- get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) protocols::jobdist::BasicJob ¶
C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>
- get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
- 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.
C++: protocols::moves::Mover::get_current_tag() const –> std::string
- get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.MoverStatus ¶
returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.
C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus
- get_name(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover) str ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::get_name() const –> std::string
- get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.core.pose.Pose ¶
C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>
- get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>
- get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t ¶
C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>
- get_type(self: pyrosetta.rosetta.protocols.moves.Mover) str ¶
C++: protocols::moves::Mover::get_type() const –> std::string
- info(self: pyrosetta.rosetta.protocols.moves.Mover) pyrosetta.rosetta.std.list_std_string_t ¶
non-const accessor
C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &
- last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) float ¶
C++: protocols::moves::Mover::last_proposal_density_ratio() –> double
- static mover_name() str ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::mover_name() –> std::string
- static name() str ¶
C++: protocols::moves::Mover::name() –> std::string
- parse_my_tag(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) None ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void
- provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) None ¶
- Provide citations to the passed CitationCollectionList
Subclasses should add the info for themselves and any other classes they use.
The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.
C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void
- static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) None ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void
- static register_options() None ¶
Overload this static method if you access options within the mover.
These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.
C++: protocols::moves::Mover::register_options() –> void
- reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on
each use.
C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool
- reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) bool ¶
- 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).
C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool
- reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) None ¶
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.
C++: protocols::moves::Mover::reset_status() –> void
- set_AA_name3(*args, **kwargs)¶
Overloaded function.
set_AA_name3(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover, setting: pyrosetta.rosetta.utility.vector1_std_string) -> None
C++: protocols::constraint_movers::ResidueTypeConstraintMover::set_AA_name3(const class utility::vector1<std::string, class std::allocator<std::string > > &) –> void
set_AA_name3(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover, setting: str) -> None
C++: protocols::constraint_movers::ResidueTypeConstraintMover::set_AA_name3(const std::string &) –> void
- set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) None ¶
C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void
- set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) None ¶
C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void
- set_favor_bonus(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMover, setting: float) None ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMover::set_favor_bonus(const double) –> void
- set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for poses contained for rms
C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe
C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void
- set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) None ¶
Set the ‘type’ string
C++: protocols::moves::Mover::set_type(const std::string &) –> void
- show(*args, **kwargs)¶
Overloaded function.
show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None
Outputs details about the Mover, including current settings.
C++: protocols::moves::Mover::show(std::ostream &) const –> void
- test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) None ¶
- : Unit test support function. Apply one move to a given pose.
Allows extra test specific functions to be called before applying
C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void
- type(*args, **kwargs)¶
Overloaded function.
type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None
Set the ‘type’ string
C++: protocols::moves::Mover::type(const std::string &) –> void
type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str
Get the set ‘type’ string
C++: protocols::moves::Mover::type() const –> const std::string &
- class pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMoverCreator¶
Bases:
MoverCreator
- assign(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMoverCreator, : pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMoverCreator) pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMoverCreator ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMoverCreator::operator=(const class protocols::constraint_movers::ResidueTypeConstraintMoverCreator &) –> class protocols::constraint_movers::ResidueTypeConstraintMoverCreator &
- create_mover(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMoverCreator) pyrosetta.rosetta.protocols.moves.Mover ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>
- keyname(self: pyrosetta.rosetta.protocols.constraint_movers.ResidueTypeConstraintMoverCreator) str ¶
C++: protocols::constraint_movers::ResidueTypeConstraintMoverCreator::keyname() const –> std::string