Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::task_operations::StoreCompoundTaskMover Class Reference

#include <StoreCompoundTaskMover.hh>

Inheritance diagram for protocols::task_operations::StoreCompoundTaskMover:
Inheritance graph

Public Types

typedef std::vector< std::pair< core::pack::task::PackerTaskOP, boolean_operations > > CompoundTask
typedef CompoundTask::iterator task_iterator
typedef CompoundTask::const_iterator const_task_iterator
typedef std::vector< std::pair< core::pack::task::TaskFactoryOP, boolean_operations > > CompoundFactory
typedef CompoundFactory::iterator factory_iterator
typedef CompoundFactory::const_iterator const_factory_iterator
- 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

Public Member Functions

 StoreCompoundTaskMover ()
 ~StoreCompoundTaskMover () override
void CompoundPackableTask (core::pose::Pose const &pose, core::Size &total_residue, core::pack::task::PackerTaskOP &task)
void CompoundDesignableTask (core::pose::Pose const &pose, core::Size &total_residue, core::pack::task::PackerTaskOP &task)
void apply (core::pose::Pose &pose) override
 Main Method. More...
protocols::moves::MoverOP clone () const override
 Return a clone of the Mover object. More...
protocols::moves::MoverOP fresh_instance () const override
 Generates a new Mover object freshly created with the default ctor. More...
void task_clear ()
task_iterator task_begin ()
const_task_iterator task_begin () const
task_iterator task_end ()
const_task_iterator task_end () const
void factory_clear ()
factory_iterator factory_begin ()
const_factory_iterator factory_begin () const
factory_iterator factory_end ()
const_factory_iterator factory_end () const
void task_name (std::string const &tn)
void mode (std::string const &md)
void true_behavior (std::string const &tb)
void false_behavior (std::string const &fb)
void invert (bool const inv)
void verbose (bool const verb)
void overwrite (bool const ow)
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &data_map) override
 Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
std::string get_name () const override
 Each derived class must specify its name. The class name. 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 void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...

Static Public Member Functions

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

Private Attributes

CompoundTask compound_task_
CompoundFactory compound_factory_
std::string task_name_
std::string mode_
std::string true_behavior_
std::string false_behavior_
bool invert_
bool verbose_
bool overwrite_

Additional Inherited Members

- 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

◆ CompoundFactory

◆ CompoundTask

◆ const_factory_iterator

◆ const_task_iterator

◆ factory_iterator

◆ task_iterator

Constructor & Destructor Documentation

◆ StoreCompoundTaskMover()

protocols::task_operations::StoreCompoundTaskMover::StoreCompoundTaskMover ( )

◆ ~StoreCompoundTaskMover()

protocols::task_operations::StoreCompoundTaskMover::~StoreCompoundTaskMover ( )

Member Function Documentation

◆ apply()

void protocols::task_operations::StoreCompoundTaskMover::apply ( core::pose::Pose )

◆ clone()

protocols::moves::MoverOP protocols::task_operations::StoreCompoundTaskMover::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.

◆ CompoundDesignableTask()

void protocols::task_operations::StoreCompoundTaskMover::CompoundDesignableTask ( core::pose::Pose const &  pose,
core::Size total_residue,
core::pack::task::PackerTaskOP task 

◆ CompoundPackableTask()

void protocols::task_operations::StoreCompoundTaskMover::CompoundPackableTask ( core::pose::Pose const &  pose,
core::Size total_residue,
core::pack::task::PackerTaskOP task 

◆ factory_begin() [1/2]

StoreCompoundTaskMover::factory_iterator protocols::task_operations::StoreCompoundTaskMover::factory_begin ( )

References compound_factory_.

◆ factory_begin() [2/2]

StoreCompoundTaskMover::const_factory_iterator protocols::task_operations::StoreCompoundTaskMover::factory_begin ( ) const

References compound_factory_.

◆ factory_clear()

void protocols::task_operations::StoreCompoundTaskMover::factory_clear ( )

References compound_factory_.

◆ factory_end() [1/2]

StoreCompoundTaskMover::factory_iterator protocols::task_operations::StoreCompoundTaskMover::factory_end ( )

References compound_factory_.

◆ factory_end() [2/2]

StoreCompoundTaskMover::const_factory_iterator protocols::task_operations::StoreCompoundTaskMover::factory_end ( ) const

References compound_factory_.

◆ false_behavior()

void protocols::task_operations::StoreCompoundTaskMover::false_behavior ( std::string const &  fb)

References false_behavior_.

◆ fresh_instance()

protocols::moves::MoverOP protocols::task_operations::StoreCompoundTaskMover::fresh_instance ( ) const

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.

◆ get_name()

std::string protocols::task_operations::StoreCompoundTaskMover::get_name ( ) const

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

Implements protocols::moves::Mover.

References mover_name().

◆ invert()

void protocols::task_operations::StoreCompoundTaskMover::invert ( bool const  inv)

References invert_.

◆ mode()

void protocols::task_operations::StoreCompoundTaskMover::mode ( std::string const &  md)

References mode_.

◆ mover_name()

std::string protocols::task_operations::StoreCompoundTaskMover::mover_name ( )

◆ overwrite()

void protocols::task_operations::StoreCompoundTaskMover::overwrite ( bool const  ow)

References overwrite_.

◆ parse_my_tag()

void protocols::task_operations::StoreCompoundTaskMover::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap data 

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 protocols::task_operations::AND, protocols::task_operations::ANDNOT, compound_factory_, false_behavior_, invert_, mode_, protocols::task_operations::NAND, protocols::task_operations::NOR, protocols::task_operations::NOT, protocols::task_operations::OR, protocols::task_operations::ORNOT, overwrite_, task_name_, protocols::task_operations::TR(), true_behavior_, verbose_, and protocols::task_operations::XOR.

◆ provide_xml_schema()

void protocols::task_operations::StoreCompoundTaskMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)

◆ task_begin() [1/2]

StoreCompoundTaskMover::task_iterator protocols::task_operations::StoreCompoundTaskMover::task_begin ( )

References compound_task_.

◆ task_begin() [2/2]

StoreCompoundTaskMover::const_task_iterator protocols::task_operations::StoreCompoundTaskMover::task_begin ( ) const

References compound_task_.

◆ task_clear()

void protocols::task_operations::StoreCompoundTaskMover::task_clear ( )

References compound_task_.

◆ task_end() [1/2]

StoreCompoundTaskMover::task_iterator protocols::task_operations::StoreCompoundTaskMover::task_end ( )

References compound_task_.

◆ task_end() [2/2]

StoreCompoundTaskMover::const_task_iterator protocols::task_operations::StoreCompoundTaskMover::task_end ( ) const

References compound_task_.

◆ task_name()

void protocols::task_operations::StoreCompoundTaskMover::task_name ( std::string const &  tn)

References task_name_.

◆ true_behavior()

void protocols::task_operations::StoreCompoundTaskMover::true_behavior ( std::string const &  tb)

References true_behavior_.

◆ verbose()

void protocols::task_operations::StoreCompoundTaskMover::verbose ( bool const  verb)

References verbose_.

Member Data Documentation

◆ compound_factory_

CompoundFactory protocols::task_operations::StoreCompoundTaskMover::compound_factory_

◆ compound_task_

CompoundTask protocols::task_operations::StoreCompoundTaskMover::compound_task_

◆ false_behavior_

std::string protocols::task_operations::StoreCompoundTaskMover::false_behavior_

◆ invert_

bool protocols::task_operations::StoreCompoundTaskMover::invert_

◆ mode_

std::string protocols::task_operations::StoreCompoundTaskMover::mode_

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

◆ overwrite_

bool protocols::task_operations::StoreCompoundTaskMover::overwrite_

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

◆ task_name_

std::string protocols::task_operations::StoreCompoundTaskMover::task_name_

◆ true_behavior_

std::string protocols::task_operations::StoreCompoundTaskMover::true_behavior_

◆ verbose_

bool protocols::task_operations::StoreCompoundTaskMover::verbose_

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