#include <TaskOperations.hh>

Inheritance diagram for core::pack::task::operation::ReadResfile:

Public Types
typedef TaskOperation	parent

Public Types inherited from core::pack::task::operation::TaskOperation
typedef utility::tag::TagCOP	TagCOP

typedef basic::datacache::DataMap	DataMap

typedef pose::Pose	Pose

Public Member Functions
	ReadResfile ()
	BEGIN ReadResfile. More...

	ReadResfile (utility::options::OptionCollection const &options)

	ReadResfile (std::string const &filename)

	ReadResfile (ReadResfile const &src)
	Copy constructor. More...

	~ReadResfile () override

TaskOperationOP	clone () const override
	Create another task operation of the type matching the most-derived version of the class. More...

void	apply (pose::Pose const &, PackerTask &) const override
	Change a packer task in some way. The input pose is the one to which the input task will be later applied. More...

void	set_residue_selector (core::select::residue_selector::ResidueSelectorCOP selector_in)
	Set the residue selector. More...

core::select::residue_selector::ResidueSelectorCOP	residue_selector () const
	Get the residue selector, if one exists. (Const-access owning pointer). More...

void	filename (std::string const &filename)

void	default_filename ()
	queries options system for resfile name More...

std::string const &	filename () const

void	parse_tag (TagCOP, DataMap &) override
	Used to parse an xml-like tag to load parameters and properties. More...

void	cache_resfile ()
	Read in the resfile and store it, so that it doesn't have to be read over and over again at apply time. More...

void	set_cached_resfile (std::string const &file_contents)
	Allows code to provide resfile contents, so that this TaskOperation doesn't directly have to handle file i/o. Handly on large systems (e.g. Blue Gene), where one might only want the master process to read a file. More...

Public Member Functions inherited from core::pack::task::operation::TaskOperation
	~TaskOperation () override

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	keyname ()

static utility::tag::AttributeList	xml_schema_attributes ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

static void	list_options_read (utility::options::OptionKeyList &options)

Private Attributes
std::string	resfile_filename_
	The filename to read. More...

bool	file_was_read_
	Has the file been read in? More...

std::string	resfile_cache_
	The cache of the resfile. More...

core::select::residue_selector::ResidueSelectorCOP	residue_selector_
	An optional ResidueSelector that can serve to mask the residues to which this TaskOperation is applied. More...

Member Typedef Documentation

typedef TaskOperation core::pack::task::operation::ReadResfile::parent

Constructor & Destructor Documentation

core::pack::task::operation::ReadResfile::ReadResfile ( )

BEGIN ReadResfile.

References cache_resfile().

core::pack::task::operation::ReadResfile::ReadResfile ( utility::options::OptionCollection const & options )

References cache_resfile(), and filename().

core::pack::task::operation::ReadResfile::ReadResfile ( std::string const & filename )

References cache_resfile().

core::pack::task::operation::ReadResfile::ReadResfile ( ReadResfile const & src )

Copy constructor.

Needed if a ResidueSelector is used.

Author: Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu)

References residue_selector_.

core::pack::task::operation::ReadResfile::~ReadResfile ( )

overridedefault

Member Function Documentation

void core::pack::task::operation::ReadResfile::apply	(	pose::Pose const &	,
		PackerTask &
	)		const

overridevirtual

Change a packer task in some way. The input pose is the one to which the input task will be later applied.

Implements core::pack::task::operation::TaskOperation.

Reimplemented in core::pack::task::operation::ReadResfileAndObeyLengthEvents.

References file_was_read_, core::pack::task::parse_resfile(), core::pack::task::parse_resfile_string(), resfile_cache_, resfile_filename_, and residue_selector_.

Referenced by core::pack::task::operation::ReadResfileAndObeyLengthEvents::apply().

void core::pack::task::operation::ReadResfile::cache_resfile ( )

Read in the resfile and store it, so that it doesn't have to be read over and over again at apply time.

References file_was_read_, resfile_cache_, resfile_filename_, and core::pack::task::operation::TR().

Referenced by filename(), parse_tag(), and ReadResfile().

TaskOperationOP core::pack::task::operation::ReadResfile::clone ( ) const

overridevirtual

Create another task operation of the type matching the most-derived version of the class.

Implements core::pack::task::operation::TaskOperation.

Reimplemented in core::pack::task::operation::ReadResfileAndObeyLengthEvents.

void core::pack::task::operation::ReadResfile::default_filename ( )

queries options system for resfile name

Assign the filename from options system, if the command-line flag has been set, or to the empty string otherwise.

References resfile_filename_.

Referenced by parse_tag().

void core::pack::task::operation::ReadResfile::filename ( std::string const & filename )

References cache_resfile(), filename(), and resfile_filename_.

std::string const & core::pack::task::operation::ReadResfile::filename ( ) const

References resfile_filename_.

Referenced by core::pack::task::operation::ReadResfileAndObeyLengthEvents::apply(), filename(), and ReadResfile().

std::string core::pack::task::operation::ReadResfile::keyname ( )

static

Referenced by core::pack::task::operation::ReadResfileCreator::keyname(), and provide_xml_schema().

void core::pack::task::operation::ReadResfile::list_options_read ( utility::options::OptionKeyList & options )

static

void core::pack::task::operation::ReadResfile::parse_tag	(	TagCOP	tag,
		DataMap &
	)

overridevirtual

Used to parse an xml-like tag to load parameters and properties.

Reimplemented from core::pack::task::operation::TaskOperation.

Reimplemented in core::pack::task::operation::ReadResfileAndObeyLengthEvents.

References cache_resfile(), default_filename(), protocols::pack_daemon::error_message, core::select::residue_selector::get_residue_selector(), resfile_filename_, residue_selector_, and set_residue_selector().

Referenced by core::pack::task::operation::ReadResfileAndObeyLengthEvents::parse_tag().

void core::pack::task::operation::ReadResfile::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

References keyname(), core::pack::task::operation::task_op_schema_w_attributes(), and xml_schema_attributes().

Referenced by core::pack::task::operation::ReadResfileCreator::provide_xml_schema().

core::select::residue_selector::ResidueSelectorCOP core::pack::task::operation::ReadResfile::residue_selector ( ) const

Get the residue selector, if one exists. (Const-access owning pointer).

Returns NULL pointer if one does not.

Author: Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu).

References residue_selector_.

void core::pack::task::operation::ReadResfile::set_cached_resfile ( std::string const & file_contents )

Allows code to provide resfile contents, so that this TaskOperation doesn't directly have to handle file i/o. Handly on large systems (e.g. Blue Gene), where one might only want the master process to read a file.

References file_was_read_, and resfile_cache_.

void core::pack::task::operation::ReadResfile::set_residue_selector ( core::select::residue_selector::ResidueSelectorCOP selector_in )

Set the residue selector.

The input selector is cloned and the clone is stored.