Rosetta Protocols  2014.35
Public Types | Public Member Functions | Private Attributes | List of all members
protocols::simple_moves::AddConstraintsToCurrentConformationMover Class Reference

#include <AddConstraintsToCurrentConformationMover.hh>

Public Types

typedef
core::pack::task::TaskFactoryCOP 
TaskFactoryCOP
 
- Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP TagCOP
 
typedef core::pose::Pose Pose
 
typedef core::pose::PoseCOP PoseCOP
 
typedef
protocols::filters::Filters_map 
Filters_map
 
typedef std::list< std::stringStrings
 

Public Member Functions

 AddConstraintsToCurrentConformationMover ()
 
virtual ~AddConstraintsToCurrentConformationMover ()
 
virtual void apply (core::pose::Pose &)
 
virtual std::string get_name () const
 Each derived class must specify its name. The class name. More...
 
bool residue_to_constrain (Size const &i) const
 
void task_factory (TaskFactoryCOP tf)
 
virtual moves::MoverOP clone () const
 Return a clone of the Mover object. More...
 
virtual moves::MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. More...
 
virtual void parse_my_tag (TagCOP, basic::datacache::DataMap &, Filters_map const &, moves::Movers_map const &, Pose const &)
 parse XML (specifically in the context of the parser/scripting scheme) More...
 
virtual void parse_task_operations (TagCOP, basic::datacache::DataMap const &, Filters_map const &, moves::Movers_map const &, Pose const &)
 parse "task_operations" XML option (can be employed virtually by derived movers) More...
 
booluse_distance_cst ()
 
boolCA_only ()
 
boolbb_only ()
 
boolinter_chain ()
 
core::Realcst_weight ()
 
core::Realmax_distance ()
 
core::Realcoord_dev ()
 
core::Realbound_width ()
 
core::Sizemin_seq_sep ()
 
bool const & use_distance_cst () const
 
bool const & CA_only () const
 
bool const & bb_only () const
 
bool const & inter_chain () const
 
core::Real const & cst_weight () const
 
core::Real const & max_distance () const
 
core::Real const & coord_dev () const
 
core::Real const & bound_width () const
 
core::Size const & min_seq_sep () const
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual ~Mover ()
 
virtual MoverSP create ()
 
virtual void apply (core::io::serialization::PipeMap &pmap)
 
virtual void parse_state (SerializableState const &state)
 
virtual void parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, MoverCacheSP cache)
 
virtual void save_state (SerializableState &state)
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
 Mover (Mover const &other)
 
Moveroperator= (Mover const &other)
 assignment operator More...
 
virtual core::Real last_proposal_density_ratio ()
 
std::string const & type () const
 
void set_type (std::string const &setting)
 
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...
 
void set_current_tag (std::string const &new_tag)
 
virtual void set_input_pose (PoseCOP pose)
 setter for poses contained for rms More...
 
virtual void set_native_pose (PoseCOP pose)
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
virtual void 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...
 
void type (const std::string &type_in)
 
std::string get_type () const
 
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...
 
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 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...
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 
virtual void show (std::ostream &output=std::cout) const
 Outputs details about the Mover, including current settings. More...
 

Private Attributes

core::pack::task::TaskFactoryCOP task_factory_
 
core::pack::task::PackerTaskOP task_
 
bool has_task_factory_
 
bool use_distance_cst_
 
bool CA_only_
 
bool bb_only_
 
bool inter_chain_
 
core::Real cst_weight_
 
core::Real max_distance_
 
core::Real coord_dev_
 
core::Real bound_width_
 
core::Size min_seq_sep_
 
core::scoring::func::FuncOP cc_func_
 

Additional Inherited Members

- Static Public Member Functions inherited from protocols::moves::Mover
static std::string name ()
 
static void register_options ()
 Overload this static method if you access options within the mover. More...
 
- Protected Member Functions inherited from protocols::moves::Mover
void set_last_move_status (MoverStatus status)
 nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::simple_moves::AddConstraintsToCurrentConformationMover::AddConstraintsToCurrentConformationMover ( )
protocols::simple_moves::AddConstraintsToCurrentConformationMover::~AddConstraintsToCurrentConformationMover ( )
virtual

Member Function Documentation

void protocols::simple_moves::AddConstraintsToCurrentConformationMover::apply ( core::pose::Pose pose)
virtual
bool& protocols::simple_moves::AddConstraintsToCurrentConformationMover::bb_only ( )
inline

References bb_only_.

bool const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::bb_only ( ) const
inline

References bb_only_.

core::Real& protocols::simple_moves::AddConstraintsToCurrentConformationMover::bound_width ( )
inline

References bound_width_.

core::Real const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::bound_width ( ) const
inline

References bound_width_.

bool& protocols::simple_moves::AddConstraintsToCurrentConformationMover::CA_only ( )
inline

References CA_only_.

bool const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::CA_only ( ) const
inline

References CA_only_.

moves::MoverOP protocols::simple_moves::AddConstraintsToCurrentConformationMover::clone ( ) const
virtual

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.

core::Real& protocols::simple_moves::AddConstraintsToCurrentConformationMover::coord_dev ( )
inline

References coord_dev_.

core::Real const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::coord_dev ( ) const
inline

References coord_dev_.

core::Real& protocols::simple_moves::AddConstraintsToCurrentConformationMover::cst_weight ( )
inline

References cst_weight_.

core::Real const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::cst_weight ( ) const
inline

References cst_weight_.

moves::MoverOP protocols::simple_moves::AddConstraintsToCurrentConformationMover::fresh_instance ( ) const
virtual

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::simple_moves::AddConstraintsToCurrentConformationMover::get_name ( ) const
virtual

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

Implements protocols::moves::Mover.

bool& protocols::simple_moves::AddConstraintsToCurrentConformationMover::inter_chain ( )
inline

References inter_chain_.

bool const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::inter_chain ( ) const
inline

References inter_chain_.

core::Real& protocols::simple_moves::AddConstraintsToCurrentConformationMover::max_distance ( )
inline

References max_distance_.

core::Real const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::max_distance ( ) const
inline

References max_distance_.

core::Size& protocols::simple_moves::AddConstraintsToCurrentConformationMover::min_seq_sep ( )
inline

References min_seq_sep_.

core::Size const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::min_seq_sep ( ) const
inline

References min_seq_sep_.

void protocols::simple_moves::AddConstraintsToCurrentConformationMover::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap datamap,
Filters_map const &  filters,
moves::Movers_map const &  movers,
Pose const &  pose 
)
virtual

parse XML (specifically in the context of the parser/scripting scheme)

Reimplemented from protocols::moves::Mover.

References protocols::rosetta_scripts::parse_task_operations(), and protocols::simple_moves::TR.

void protocols::simple_moves::AddConstraintsToCurrentConformationMover::parse_task_operations ( TagCOP  tag,
basic::datacache::DataMap const &  datamap,
Filters_map const &  ,
moves::Movers_map const &  ,
Pose const &   
)
virtual

parse "task_operations" XML option (can be employed virtually by derived movers)

References protocols::rosetta_scripts::parse_task_operations().

bool protocols::simple_moves::AddConstraintsToCurrentConformationMover::residue_to_constrain ( Size const &  i) const
void protocols::simple_moves::AddConstraintsToCurrentConformationMover::task_factory ( TaskFactoryCOP  tf)

References runtime_assert.

bool& protocols::simple_moves::AddConstraintsToCurrentConformationMover::use_distance_cst ( )
inline

References use_distance_cst_.

bool const& protocols::simple_moves::AddConstraintsToCurrentConformationMover::use_distance_cst ( ) const
inline

References use_distance_cst_.

Member Data Documentation

bool protocols::simple_moves::AddConstraintsToCurrentConformationMover::bb_only_
private

Referenced by bb_only().

core::Real protocols::simple_moves::AddConstraintsToCurrentConformationMover::bound_width_
private

Referenced by bound_width().

bool protocols::simple_moves::AddConstraintsToCurrentConformationMover::CA_only_
private

Referenced by CA_only().

core::scoring::func::FuncOP protocols::simple_moves::AddConstraintsToCurrentConformationMover::cc_func_
private
core::Real protocols::simple_moves::AddConstraintsToCurrentConformationMover::coord_dev_
private

Referenced by coord_dev().

core::Real protocols::simple_moves::AddConstraintsToCurrentConformationMover::cst_weight_
private

Referenced by cst_weight().

bool protocols::simple_moves::AddConstraintsToCurrentConformationMover::has_task_factory_
private
bool protocols::simple_moves::AddConstraintsToCurrentConformationMover::inter_chain_
private

Referenced by inter_chain().

core::Real protocols::simple_moves::AddConstraintsToCurrentConformationMover::max_distance_
private

Referenced by max_distance().

core::Size protocols::simple_moves::AddConstraintsToCurrentConformationMover::min_seq_sep_
private

Referenced by min_seq_sep().

core::pack::task::PackerTaskOP protocols::simple_moves::AddConstraintsToCurrentConformationMover::task_
private
core::pack::task::TaskFactoryCOP protocols::simple_moves::AddConstraintsToCurrentConformationMover::task_factory_
private
bool protocols::simple_moves::AddConstraintsToCurrentConformationMover::use_distance_cst_
private

Referenced by use_distance_cst().


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