A mover that reads the result of an externally-called packer, and applies it to a pose to generate a structure. More...

#include <ExternalPackerResultLoader.hh>

Inheritance diagram for protocols::quantum_annealing::ExternalPackerResultLoader:

Public Member Functions
	ExternalPackerResultLoader ()
	Constructors ///. More...

	ExternalPackerResultLoader (ExternalPackerResultLoader const &)=default
	Copy constructor (not needed unless you need deep copies) More...

	~ExternalPackerResultLoader () override
	Destructor (important for properly forward-declaring smart-pointer members) More...

void	apply (core::pose::Pose &pose) override
	Mover Methods ///. More...

void	show (std::ostream &output=std::cout) const override
	Show the contents of the Mover. More...

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
	Rosetta Scripts Support ///. More...

protocols::moves::MoverOP	fresh_instance () const override
	required in the context of the parser/scripting scheme More...

protocols::moves::MoverOP	clone () const override
	required in the context of the parser/scripting scheme More...

std::string	get_name () const override
	Each derived class must specify its name. The class name. More...

void	read_packer_problem_file (std::string const &filename)
	Reads a description of the packer problem from disk and caches it. More...

void	read_rotamer_selection_file (std::string const &filename)
	Reads a description of the packer solution from disk and caches it. More...

void	set_packer_problem_string (std::string const &file_contents)
	Set the packer problem file contents string. More...

void	set_rotamer_selection_string (std::string const &file_contents)
	Set the packer solution file contents string. 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 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 Strings &	info ()
	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
std::string	rotamer_selection_file_data_
	The contents of a data file (or stream) indicating a selection of 1 rotamer at each packable position. More...

std::string	packer_problem_file_data_
	The contents of a data file (or stream) describing the packer problem. More...

bool	problem_was_loaded_
	Has the problem been loaded from disk? More...

bool	solution_was_loaded_
	Has the solution been loaded from disk? More...

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

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

Detailed Description

A mover that reads the result of an externally-called packer, and applies it to a pose to generate a structure.

Constructor & Destructor Documentation

protocols::quantum_annealing::ExternalPackerResultLoader::ExternalPackerResultLoader ( )

Constructors ///.

Default constructor

protocols::quantum_annealing::ExternalPackerResultLoader::ExternalPackerResultLoader ( ExternalPackerResultLoader const & )

default

Copy constructor (not needed unless you need deep copies)

protocols::quantum_annealing::ExternalPackerResultLoader::~ExternalPackerResultLoader ( )

override

Destructor (important for properly forward-declaring smart-pointer members)

Member Function Documentation

void protocols::quantum_annealing::ExternalPackerResultLoader::apply ( core::pose::Pose & pose )

overridevirtual

Mover Methods ///.

Apply the mover

Implements protocols::moves::Mover.

References packer_problem_file_data_, problem_was_loaded_, rotamer_selection_file_data_, core::pack::interaction_graph::set_externally_generated_packer_solution(), and solution_was_loaded_.

protocols::moves::MoverOP protocols::quantum_annealing::ExternalPackerResultLoader::clone ( ) const

overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

protocols::moves::MoverOP protocols::quantum_annealing::ExternalPackerResultLoader::fresh_instance ( ) const

overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::moves::Mover.

std::string protocols::quantum_annealing::ExternalPackerResultLoader::get_name ( ) const

overridevirtual

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

Implements protocols::moves::Mover.

References mover_name().

std::string protocols::quantum_annealing::ExternalPackerResultLoader::mover_name ( )

static

Referenced by get_name(), protocols::quantum_annealing::ExternalPackerResultLoaderCreator::keyname(), and provide_xml_schema().

void protocols::quantum_annealing::ExternalPackerResultLoader::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	data
	)

overridevirtual

Rosetta Scripts Support ///.

parse XML tag (to use this Mover in Rosetta Scripts)

Warning! This mover reads from disk at parse time!

Reimplemented from protocols::moves::Mover.

References read_packer_problem_file(), read_rotamer_selection_file(), and protocols::TR().

void protocols::quantum_annealing::ExternalPackerResultLoader::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

References mover_name(), and protocols::moves::xsd_type_definition_w_attributes().

Referenced by protocols::quantum_annealing::ExternalPackerResultLoaderCreator::provide_xml_schema().

void protocols::quantum_annealing::ExternalPackerResultLoader::read_packer_problem_file ( std::string const & filename )

Reads a description of the packer problem from disk and caches it.

public methods ///

WARNING! READS FROM DISK!

Reads a description of the packer problem from disk and caches it.

WARNING! READS FROM DISK!

References set_packer_problem_string(), and protocols::TR().

Referenced by parse_my_tag().

void protocols::quantum_annealing::ExternalPackerResultLoader::read_rotamer_selection_file ( std::string const & filename )

Reads a description of the packer solution from disk and caches it.

WARNING! READS FROM DISK!

References set_rotamer_selection_string(), and protocols::TR().

Referenced by parse_my_tag().

void protocols::quantum_annealing::ExternalPackerResultLoader::set_packer_problem_string ( std::string const & file_contents )

Set the packer problem file contents string.

Does not read from disk. Called by read_packer_problem_file().

References packer_problem_file_data_, and problem_was_loaded_.

Referenced by read_packer_problem_file().

void protocols::quantum_annealing::ExternalPackerResultLoader::set_rotamer_selection_string ( std::string const & file_contents )

Set the packer solution file contents string.

Does not read from disk. Called by read_rotamer_selection_file().

References rotamer_selection_file_data_, and solution_was_loaded_.

Referenced by read_rotamer_selection_file().

void protocols::quantum_annealing::ExternalPackerResultLoader::show ( std::ostream & output = std::cout ) const

overridevirtual

Show the contents of the Mover.

Reimplemented from protocols::moves::Mover.

References protocols::moves::Mover::show().

Referenced by protocols::quantum_annealing::operator<<().

Member Data Documentation

std::string protocols::quantum_annealing::ExternalPackerResultLoader::packer_problem_file_data_

private

The contents of a data file (or stream) describing the packer problem.

Includes full information needed to rebuild the pose.

Referenced by apply(), and set_packer_problem_string().

bool protocols::quantum_annealing::ExternalPackerResultLoader::problem_was_loaded_

private

Has the problem been loaded from disk?

Referenced by apply(), and set_packer_problem_string().

std::string protocols::quantum_annealing::ExternalPackerResultLoader::rotamer_selection_file_data_

private

The contents of a data file (or stream) indicating a selection of 1 rotamer at each packable position.

Referenced by apply(), and set_rotamer_selection_string().

bool protocols::quantum_annealing::ExternalPackerResultLoader::solution_was_loaded_

private

Has the solution been loaded from disk?

Referenced by apply(), and set_rotamer_selection_string().

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

src/protocols/quantum_annealing/ExternalPackerResultLoader.hh
src/protocols/quantum_annealing/ExternalPackerResultLoader.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation