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

#include <SetupNCSMover.hh>

Public Member Functions

 SetupNCSMover ()
 SetupNCSMover (std::string src, std::string tgt)
 SetupNCSMover (std::string src, utility::vector1< std::string > tgt)
 SetupNCSMover (utility::vector1< std::string > src, utility::vector1< std::string > tgt)
 ~SetupNCSMover ()
void add_group (std::string src, std::string tgt)
void add_groupE (std::string src, std::string tgt)
void add_groupD (std::string src, std::string tgt)
void set_defaults ()
moves::MoverOP clone () const
 Return a clone of the Mover object. More...
virtual void apply (core::pose::Pose &pose)
virtual void parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data, filters::Filters_map const &filters, moves::Movers_map const &movers, core::pose::Pose const &pose)
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
virtual std::string get_name () const
 Each derived class must specify its name. The class name. More...
void set_bb (bool bb_in)
bool bb ()
void set_chi (bool chi_in)
bool chi ()
void set_symmetric_sequence (bool symmetric_sequence_in)
bool symmetric_sequence ()
bool distance_pair ()
void set_limit (core::Real limit_in)
core::Real limit ()
void set_weight (core::Real wt_in)
core::Real weight ()
void set_sd (core::Real sd_in)
core::Real sd ()
- 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...
virtual MoverOP fresh_instance () const
 Generates a new Mover object freshly created with the default ctor. 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

utility::vector1< std::stringsrc_
utility::vector1< std::stringtgt_
utility::vector1< std::stringsrcE_
utility::vector1< std::stringtgtE_
utility::vector1< std::stringsrcD_
utility::vector1< std::stringtgtD_
bool bb_
bool chi_
bool symmetric_sequence_
bool distance_pair_
core::Real limit_
core::Real wt_
core::Real wtD_
core::Real sd_

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

Constructor & Destructor Documentation

protocols::simple_moves::symmetry::SetupNCSMover::SetupNCSMover ( )

References set_defaults().

Referenced by clone().

protocols::simple_moves::symmetry::SetupNCSMover::SetupNCSMover ( std::string  src,
std::string  tgt 

References add_group(), and set_defaults().

protocols::simple_moves::symmetry::SetupNCSMover::SetupNCSMover ( std::string  src,
utility::vector1< std::string tgt 

References add_group(), and set_defaults().

protocols::simple_moves::symmetry::SetupNCSMover::SetupNCSMover ( utility::vector1< std::string src,
utility::vector1< std::string tgt 
protocols::simple_moves::symmetry::SetupNCSMover::~SetupNCSMover ( )

Member Function Documentation

void protocols::simple_moves::symmetry::SetupNCSMover::add_group ( std::string  src,
std::string  tgt 
void protocols::simple_moves::symmetry::SetupNCSMover::add_groupD ( std::string  src,
std::string  tgt 

References srcD_, and tgtD_.

Referenced by parse_my_tag().

void protocols::simple_moves::symmetry::SetupNCSMover::add_groupE ( std::string  src,
std::string  tgt 

References srcE_, and tgtE_.

Referenced by parse_my_tag().

void protocols::simple_moves::symmetry::SetupNCSMover::apply ( core::pose::Pose pose)
bool protocols::simple_moves::symmetry::SetupNCSMover::bb ( )

References bb_.

bool protocols::simple_moves::symmetry::SetupNCSMover::chi ( )

References chi_.

moves::MoverOP protocols::simple_moves::symmetry::SetupNCSMover::clone ( ) const

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.

References SetupNCSMover().

bool protocols::simple_moves::symmetry::SetupNCSMover::distance_pair ( )

References distance_pair_.

std::string protocols::simple_moves::symmetry::SetupNCSMover::get_name ( ) const

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

Implements protocols::moves::Mover.

References protocols::simple_moves::symmetry::SetupNCSMoverCreator::mover_name().

core::Real protocols::simple_moves::symmetry::SetupNCSMover::limit ( )

References limit_.

void protocols::simple_moves::symmetry::SetupNCSMover::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap data,
filters::Filters_map const &  filters,
moves::Movers_map const &  movers,
core::pose::Pose const &  pose 

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 stop executions. This, however, calls attention to the lack of this method, which could be due to something as silly as a wrong parameters definition.

Reimplemented from protocols::moves::Mover.

References add_group(), add_groupD(), add_groupE(), bb_, chi_, distance_pair_, limit_, sd_, symmetric_sequence_, protocols::simple_moves::symmetry::TZ, and wt_.

core::Real protocols::simple_moves::symmetry::SetupNCSMover::sd ( )

References sd_.

void protocols::simple_moves::symmetry::SetupNCSMover::set_bb ( bool  bb_in)

References bb_.

void protocols::simple_moves::symmetry::SetupNCSMover::set_chi ( bool  chi_in)

References chi_.

void protocols::simple_moves::symmetry::SetupNCSMover::set_defaults ( )

References bb_, chi_, distance_pair_, limit_, sd_, symmetric_sequence_, and wt_.

Referenced by SetupNCSMover().

void protocols::simple_moves::symmetry::SetupNCSMover::set_limit ( core::Real  limit_in)

References limit_.

void protocols::simple_moves::symmetry::SetupNCSMover::set_sd ( core::Real  sd_in)

References sd_.

void protocols::simple_moves::symmetry::SetupNCSMover::set_symmetric_sequence ( bool  symmetric_sequence_in)

References symmetric_sequence_.

void protocols::simple_moves::symmetry::SetupNCSMover::set_weight ( core::Real  wt_in)

References wt_.

bool protocols::simple_moves::symmetry::SetupNCSMover::symmetric_sequence ( )

References symmetric_sequence_.

core::Real protocols::simple_moves::symmetry::SetupNCSMover::weight ( )

References wt_.

Member Data Documentation

bool protocols::simple_moves::symmetry::SetupNCSMover::bb_
bool protocols::simple_moves::symmetry::SetupNCSMover::chi_
bool protocols::simple_moves::symmetry::SetupNCSMover::distance_pair_
core::Real protocols::simple_moves::symmetry::SetupNCSMover::limit_
core::Real protocols::simple_moves::symmetry::SetupNCSMover::sd_
utility::vector1< std::string > protocols::simple_moves::symmetry::SetupNCSMover::src_

Referenced by add_group(), and apply().

utility::vector1< std::string > protocols::simple_moves::symmetry::SetupNCSMover::srcD_

Referenced by add_groupD(), and apply().

utility::vector1< std::string > protocols::simple_moves::symmetry::SetupNCSMover::srcE_

Referenced by add_groupE(), and apply().

bool protocols::simple_moves::symmetry::SetupNCSMover::symmetric_sequence_
utility::vector1< std::string > protocols::simple_moves::symmetry::SetupNCSMover::tgt_

Referenced by add_group(), and apply().

utility::vector1< std::string > protocols::simple_moves::symmetry::SetupNCSMover::tgtD_

Referenced by add_groupD(), and apply().

utility::vector1< std::string > protocols::simple_moves::symmetry::SetupNCSMover::tgtE_

Referenced by add_groupE(), and apply().

core::Real protocols::simple_moves::symmetry::SetupNCSMover::wt_
core::Real protocols::simple_moves::symmetry::SetupNCSMover::wtD_

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