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

#include <ConstraintPreparer.hh>

Inheritance diagram for protocols::abinitio::abscript::ConstraintPreparer:
Inheritance graph
[legend]

Public Member Functions

 ConstraintPreparer ()
 
void prepare (core::pose::Pose &pose, core::Real progress) override
 
void parse_my_tag (utility::tag::TagCOP, basic::datacache::DataMap &) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
 
void cst_file (std::string const &)
 
std::string const & cst_file () const
 
void combine_ratio (core::Size const &s)
 
core::Size const & combine_ratio () const
 
bool skip_redundant () const
 
void skip_redundant (bool s)
 
core::Size skip_redundant_width () const
 
void skip_redundant_width (core::Size const &s)
 
core::Real random_drop_rate () const
 
void random_drop_rate (core::Real const &s)
 
utility::vector1< bool > const & combine_exclude_res () const
 
void combine_exclude_file (std::string const &filename)
 
moves::MoverOP fresh_instance () const override
 Generates a new Mover object freshly created with the default ctor. More...
 
moves::MoverOP clone () const override
 Return a clone of the Mover object. More...
 
void apply (core::pose::Pose &) override
 Main Method. More...
 
EnvClaims yield_claims (core::pose::Pose const &, basic::datacache::WriteableCacheableMapOP) override
 Returns a list of claims for this mover. More...
 
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
 
- Public Member Functions inherited from protocols::environment::ClientMover
 ClientMover ()
 
 ClientMover (ClientMover const &)
 
 ~ClientMover () override
 
virtual void initialize (Pose &conf)
 this method is called by the broking system in response to a successful initialization claim by this mover. The passport will prevent any unauthorized changes. More...
 
virtual void yield_submovers (std::set< ClientMoverOP > &) const
 this method is used to make sure any movers contained in this mover (that want to make claims) also get registered with the environment. More...
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual MoverOP create ()
 
MoverCOP get_self_ptr () const
 
MoverOP get_self_ptr ()
 
MoverCAP get_self_weak_ptr () const
 
MoverAP get_self_weak_ptr ()
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
virtual void test_move (Pose &pose)
 : Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...
 
virtual bool reinitialize_for_each_job () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...
 
virtual bool reinitialize_for_new_input () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be regenerated when the input pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose). More...
 
MoverStatus get_last_move_status () const
 end parser interface, start Job Distributor interface///////////// More...
 
void reset_status ()
 resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s. More...
 
virtual core::pose::PoseOP get_additional_output ()
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
void set_type (std::string const &setting)
 Set the 'type' string. More...
 
std::string get_type () const
 
void type (const std::string &type_in)
 Set the 'type' string. More...
 
std::string const & type () const
 Get the set 'type' string. More...
 
virtual void set_input_pose (PoseCOP pose)
 setter for poses contained for rms More...
 
virtual void set_native_pose (PoseCOP pose)
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 
virtual void set_current_tag (std::string const &new_tag)
 
std::string get_current_tag () const
 A tag is a unique identifier used to identify structures produced by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor. More...
 
virtual void show (std::ostream &output=std::cout) const
 Outputs details about the Mover, including current settings. More...
 
virtual core::Real last_proposal_density_ratio ()
 
virtual void clear_info ()
 Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file. More...
 
virtual Stringsinfo ()
 non-const accessor More...
 
virtual Strings const & info () const
 const accessor More...
 
virtual bool mover_provides_citation_info () const
 Does this mover provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool mover_is_unpublished () const
 Does this mover indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Static Public Member Functions

static std::string mover_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
- Static Public Member Functions inherited from protocols::moves::Mover
static std::string name ()
 
static void register_options ()
 Overload this static method if you access options within the mover. More...
 

Protected Member Functions

void load_constraints (core::pose::Pose const &)
 
- Protected Member Functions inherited from protocols::environment::ClientMover
void sandboxed_copy (core::pose::Pose const &sandbox_pose, core::pose::Pose &true_pose) const
 convience method that copies all changes from an unprotected pose to a protected pose. More...
 
virtual void passport_updated ()
 hook that is called each time the passport status is updated (presumably because there's a new subenvironment, or the sub- environment has expired). More...
 
virtual void broking_finished (EnvClaimBroker::BrokerResult const &)
 hook that provides information about the final result of broking at the very end, though this BrokerResult construct. More...
 
EnvironmentCAP active_environment () const
 return a pointer the active environment More...
 
core::environment::DofPassportCOP passport () const
 read-only access to the top passport in the passport stack. More...
 
bool has_passport () const
 
bool state_check (std::string const &method_name, bool test) const
 convienence method for failing a state-set call after brokering. 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...
 

Private Types

typedef StagePreparer Parent
 
typedef
environment::claims::EnvClaims 
EnvClaims
 

Private Attributes

core::Size combine_ratio_
 
bool skip_redundant_
 
core::Size skip_redundant_width_
 
core::Real rand_drop_rate_
 
bool reprepare_
 
utility::vector1< boolcombine_exclude_res_
 
std::string filename_
 
core::scoring::constraints::ConstraintSetOP constraints_
 

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
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::abinitio::abscript::ConstraintPreparer::ConstraintPreparer ( )

Member Function Documentation

void protocols::abinitio::abscript::ConstraintPreparer::apply ( core::pose::Pose )
inlineoverridevirtual

Main Method.

Implements protocols::moves::Mover.

moves::MoverOP protocols::abinitio::abscript::ConstraintPreparer::clone ( ) const
inlineoverridevirtual

Return a clone of the Mover object.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

void protocols::abinitio::abscript::ConstraintPreparer::combine_exclude_file ( std::string const &  filename)
utility::vector1< bool > const& protocols::abinitio::abscript::ConstraintPreparer::combine_exclude_res ( ) const
inline

References combine_exclude_res_.

void protocols::abinitio::abscript::ConstraintPreparer::combine_ratio ( core::Size const &  s)
inline

References combine_ratio_.

core::Size const& protocols::abinitio::abscript::ConstraintPreparer::combine_ratio ( ) const
inline

References combine_ratio_.

Referenced by parse_my_tag(), and prepare().

void protocols::abinitio::abscript::ConstraintPreparer::cst_file ( std::string const &  filename)
std::string const& protocols::abinitio::abscript::ConstraintPreparer::cst_file ( ) const
inline

References filename_.

Referenced by parse_my_tag(), and prepare().

moves::MoverOP protocols::abinitio::abscript::ConstraintPreparer::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.

std::string protocols::abinitio::abscript::ConstraintPreparer::get_name ( ) const
overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

Referenced by parse_my_tag(), and prepare().

void protocols::abinitio::abscript::ConstraintPreparer::load_constraints ( core::pose::Pose const &  )
protected
std::string protocols::abinitio::abscript::ConstraintPreparer::mover_name ( )
static
void protocols::abinitio::abscript::ConstraintPreparer::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual

Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.

Some movers need not be parsed, so we shouldn't force people to reimplement this method. However, we should be chatty about the fact that someone is using a RosettaScripts interface to a mover which didn't define parse_my_tag()

Reimplemented from protocols::moves::Mover.

References combine_ratio(), cst_file(), get_name(), reprepare_, skip_redundant(), skip_redundant_width(), and tr().

void protocols::abinitio::abscript::ConstraintPreparer::prepare ( core::pose::Pose pose,
core::Real  progress 
)
overridevirtual
void protocols::abinitio::abscript::ConstraintPreparer::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
core::Real protocols::abinitio::abscript::ConstraintPreparer::random_drop_rate ( ) const
inline

References rand_drop_rate_.

Referenced by prepare().

void protocols::abinitio::abscript::ConstraintPreparer::random_drop_rate ( core::Real const &  s)
inline

References rand_drop_rate_.

bool protocols::abinitio::abscript::ConstraintPreparer::skip_redundant ( ) const
inline

References skip_redundant_.

Referenced by parse_my_tag(), and prepare().

void protocols::abinitio::abscript::ConstraintPreparer::skip_redundant ( bool  s)
inline

References skip_redundant_.

core::Size protocols::abinitio::abscript::ConstraintPreparer::skip_redundant_width ( ) const
inline

References skip_redundant_width_.

Referenced by parse_my_tag(), and prepare().

void protocols::abinitio::abscript::ConstraintPreparer::skip_redundant_width ( core::Size const &  s)
inline

References skip_redundant_width_.

claims::EnvClaims protocols::abinitio::abscript::ConstraintPreparer::yield_claims ( core::pose::Pose const &  ,
basic::datacache::WriteableCacheableMapOP   
)
overridevirtual

Returns a list of claims for this mover.

The pose passed as an argument is used for reference informational purposes only (for example, you want to know the sequence) or access the pose cache. Any changes to the conformation will get overwritten!

Implements protocols::environment::ClientMover.

Member Data Documentation

utility::vector1< bool > protocols::abinitio::abscript::ConstraintPreparer::combine_exclude_res_
private
core::Size protocols::abinitio::abscript::ConstraintPreparer::combine_ratio_
private

Referenced by combine_ratio().

core::scoring::constraints::ConstraintSetOP protocols::abinitio::abscript::ConstraintPreparer::constraints_
private

Referenced by cst_file(), and prepare().

std::string protocols::abinitio::abscript::ConstraintPreparer::filename_
private

Referenced by cst_file().

core::Real protocols::abinitio::abscript::ConstraintPreparer::rand_drop_rate_
private

Referenced by random_drop_rate().

bool protocols::abinitio::abscript::ConstraintPreparer::reprepare_
private

Referenced by parse_my_tag(), and prepare().

bool protocols::abinitio::abscript::ConstraintPreparer::skip_redundant_
private

Referenced by skip_redundant().

core::Size protocols::abinitio::abscript::ConstraintPreparer::skip_redundant_width_
private

Referenced by skip_redundant_width().


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