#include <XmlObjects.hh>

Inheritance diagram for protocols::rosetta_scripts::XmlObjects:

Public Member Functions
	XmlObjects ()

	~XmlObjects () override

	XmlObjects (XmlObjects const &src)

XmlObjects &	operator= (XmlObjects const &src)

void	init_from_maps (basic::datacache::DataMap &data)
	Initialization function from the DataMaps. More...

utility::vector1< std::string >	list_score_functions () const
	List all the ScoreFunctions contained by name. More...

utility::vector1< std::string >	list_residue_selectors () const
	List all the ResidueSelectors contained by name. More...

utility::vector1< std::string >	list_simple_metrics () const
	List all the SimpleMetrics contained by name. More...

utility::vector1< std::string >	list_filters () const
	List all the Filters contained by name. More...

utility::vector1< std::string >	list_movers () const
	List all the Movers contained by name. More...

utility::vector1< std::string >	list_task_operations () const
	List all the TaskOperations by name. More...

core::scoring::ScoreFunctionOP	get_score_function (std::string const &name) const
	Extract a ScoreFunction by name after using one of the create* methods. More...

core::select::residue_selector::ResidueSelectorOP	get_residue_selector (std::string const &name) const
	Extract a ResidueSelector by name after using one of the create* methods. More...

core::simple_metrics::SimpleMetricOP	get_simple_metric (std::string const &name) const
	Extract a SimpleMetric by name after using one of the create* methods. More...

protocols::filters::FilterOP	get_filter (std::string const &name) const
	Extract a Filter by name after using one of the create* methods. More...

protocols::moves::MoverOP	get_mover (std::string const &name) const
	Extract a Mover by name after using one of the create* methods. More...

core::pack::task::operation::TaskOperationOP	get_task_operation (std::string const &name) const
	Extract a TaskOperation by name after using one of the create* methods. More...

void	show (std::ostream &output=std::cout) const
	Generate string representation of XmlObjects for debugging purposes. More...

Static Public Member Functions
static XmlObjectsCOP	create_from_string (std::string const &xml_text)
	Parses an xml-formatted string and returns an XmlObjects. More...

static XmlObjectsCOP	create_from_string (std::string const &xml_text, core::pose::Pose &)
	Parses an xml-formatted string and returns an XmlObjects. More...

static XmlObjectsCOP	create_from_string (std::string const &xml_text, utility::options::OptionCollection const &options)
	Parses an xml-formatted string and returns an XmlObjects. More...

static XmlObjectsCOP	create_from_string (std::string const &xml_text, core::pose::Pose &, utility::options::OptionCollection const &options)
	Parses an xml-formatted string and returns an XmlObjects. More...

static XmlObjectsCOP	create_from_file (std::string const &filename)
	Parses an xml file and returns an XmlObjects. More...

static XmlObjectsCOP	create_from_file (std::string const &filename, core::pose::Pose &)
	Parses an xml file and returns an XmlObjects. More...

static XmlObjectsCOP	create_from_file (std::string const &filename, utility::options::OptionCollection const &options)
	Parses an xml file and returns an XmlObjects. More...

static XmlObjectsCOP	create_from_file (std::string const &filename, core::pose::Pose &, utility::options::OptionCollection const &options)
	Parses an xml file and returns an XmlObjects. More...

static core::scoring::ScoreFunctionOP	static_get_score_function (std::string const &xml_text)
	Constructs a single ScoreFunction from xml. More...

static core::scoring::ScoreFunctionOP	static_get_score_function (std::string const &xml_text, core::pose::Pose &)
	Constructs a single ScoreFunction from xml. More...

static core::scoring::ScoreFunctionOP	static_get_score_function (std::string const &xml_text, utility::options::OptionCollection const &options)
	Constructs a single ScoreFunction from xml. More...

static core::scoring::ScoreFunctionOP	static_get_score_function (std::string const &xml_text, core::pose::Pose &, utility::options::OptionCollection const &options)
	Constructs a single ScoreFunction from xml. More...

static core::select::residue_selector::ResidueSelectorOP	static_get_residue_selector (std::string const &xml_text)
	Constructs a single ResidueSelector from xml. More...

static core::select::residue_selector::ResidueSelectorOP	static_get_residue_selector (std::string const &xml_text, core::pose::Pose &)
	Constructs a single ResidueSelector from xml. More...

static core::select::residue_selector::ResidueSelectorOP	static_get_residue_selector (std::string const &xml_text, utility::options::OptionCollection const &options)
	Constructs a single ResidueSelector from xml. More...

static core::select::residue_selector::ResidueSelectorOP	static_get_residue_selector (std::string const &xml_text, core::pose::Pose &, utility::options::OptionCollection const &options)
	Constructs a single ResidueSelector from xml. More...

static core::simple_metrics::SimpleMetricOP	static_get_simple_metric (std::string const &xml_text)
	Constructs a single SimpleMetric from xml. More...

static core::simple_metrics::SimpleMetricOP	static_get_simple_metric (std::string const &xml_text, core::pose::Pose &)
	Constructs a single SimpleMetric from xml. More...

static core::simple_metrics::SimpleMetricOP	static_get_simple_metric (std::string const &xml_text, utility::options::OptionCollection const &options)
	Constructs a single SimpleMetric from xml. More...

static core::simple_metrics::SimpleMetricOP	static_get_simple_metric (std::string const &xml_text, core::pose::Pose &, utility::options::OptionCollection const &options)
	Constructs a single SimpleMetric from xml. More...

static protocols::filters::FilterOP	static_get_filter (std::string const &xml_text)
	Constructs a single Filter from xml. More...

static protocols::filters::FilterOP	static_get_filter (std::string const &xml_text, core::pose::Pose &)
	Constructs a single Filter from xml. More...

static protocols::filters::FilterOP	static_get_filter (std::string const &xml_text, utility::options::OptionCollection const &options)
	Constructs a single Filter from xml. More...

static protocols::filters::FilterOP	static_get_filter (std::string const &xml_text, core::pose::Pose &pose, utility::options::OptionCollection const &options)
	Constructs a single Filter from xml. More...

static protocols::moves::MoverOP	static_get_mover (std::string const &xml_text)
	Constructs a single Mover from xml. More...

static protocols::moves::MoverOP	static_get_mover (std::string const &xml_text, core::pose::Pose &)
	Constructs a single Mover from xml. More...

static protocols::moves::MoverOP	static_get_mover (std::string const &xml_text, utility::options::OptionCollection const &options)
	Constructs a single Mover from xml. More...

static protocols::moves::MoverOP	static_get_mover (std::string const &xml_text, core::pose::Pose &, utility::options::OptionCollection const &options)
	Constructs a single Mover from xml. More...

static core::pack::task::operation::TaskOperationOP	static_get_task_operation (std::string const &xml_text)
	Constructs a single TaskOperation from xml. More...

static core::pack::task::operation::TaskOperationOP	static_get_task_operation (std::string const &xml_text, core::pose::Pose &)
	Constructs a single TaskOperation from xml. More...

static core::pack::task::operation::TaskOperationOP	static_get_task_operation (std::string const &xml_text, utility::options::OptionCollection const &options)
	Constructs a single TaskOperation from xml. More...

static core::pack::task::operation::TaskOperationOP	static_get_task_operation (std::string const &xml_text, core::pose::Pose &, utility::options::OptionCollection const &options)
	Constructs a single TaskOperation from xml. More...

Static Private Member Functions
static std::string	get_or_set_tag_name (std::string &tag_string)
	Gets a tag's name field or sets it to XmlObject_name. More...

static void	prepare_xml_text (std::string &xml_text)
	Wraps an xml script with <ROSETTASCRIPTS> and adds a <PROTOCOLS> section if these don't exist already. More...

Private Attributes
std::map< std::string, core::scoring::ScoreFunctionCOP >	score_functions_

std::map< std::string, core::select::residue_selector::ResidueSelectorCOP >	residue_selectors_

std::map< std::string, core::simple_metrics::SimpleMetricCOP >	simple_metrics_

std::map< std::string, protocols::filters::FilterCOP >	filters_

std::map< std::string, protocols::moves::MoverCOP >	movers_

std::map< std::string, core::pack::task::operation::TaskOperationCOP >	task_operations_

Friends
std::ostream &	operator<< (std::ostream &output, XmlObjects const &object_to_output)
	Insertion operator (overloaded so that XmlObjects can be "printed" in PyRosetta). More...

Constructor & Destructor Documentation

◆ XmlObjects() [1/2]

protocols::rosetta_scripts::XmlObjects::XmlObjects ( )

default

◆ ~XmlObjects()

protocols::rosetta_scripts::XmlObjects::~XmlObjects ( )

overridedefault

◆ XmlObjects() [2/2]

protocols::rosetta_scripts::XmlObjects::XmlObjects ( XmlObjects const & src )

default

Member Function Documentation

◆ create_from_file() [1/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_file ( std::string const & filename )

static

Parses an xml file and returns an XmlObjects.

The ParsedProtocol (xml script mover) is available as "ParsedProtocol"

References protocols::abinitio::filename().

Referenced by protocols::ligand_evolution::EvolutionManager::init().

◆ create_from_file() [2/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_file	(	std::string const &	filename,
		core::pose::Pose &
	)

static

Parses an xml file and returns an XmlObjects.

The ParsedProtocol (xml script mover) is available as "ParsedProtocol" The pose parameter is ignored, and exists oly for backwards compatibility.

The ParsedProtocol (xml script mover) is available as "ParsedProtocol" The pose parameter is ignored, and exists only for backwards compatibility.

References protocols::abinitio::filename().

◆ create_from_file() [3/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_file	(	std::string const &	filename,
		core::pose::Pose &	,
		utility::options::OptionCollection const &	options
	)

static

Parses an xml file and returns an XmlObjects.

The ParsedProtocol (xml script mover) is available as "ParsedProtocol" The pose parameter is ignored, and exists oly for backwards compatibility.

The ParsedProtocol (xml script mover) is available as "ParsedProtocol" The pose parameter is ignored, and exists only for backwards compatibility.

References protocols::abinitio::filename().

◆ create_from_file() [4/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_file	(	std::string const &	filename,
		utility::options::OptionCollection const &	options
	)

static

Parses an xml file and returns an XmlObjects.

The ParsedProtocol (xml script mover) is available as "ParsedProtocol"

References protocols::abinitio::filename(), protocols::rosetta_scripts::RosettaScriptsParser::generate_mover(), and protocols::rosetta_scripts::TR().

◆ create_from_string() [1/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_string ( std::string const & xml_text )

static

Parses an xml-formatted string and returns an XmlObjects.

This function will wrap your script with <ROSETTASCRIPTS> if needed and will add a <PROTOCOLS> section if needed. The ParsedProtocol (xml script mover) is available as "ParsedProtocol".

◆ create_from_string() [2/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_string	(	std::string const &	xml_text,
		core::pose::Pose &
	)

static

Parses an xml-formatted string and returns an XmlObjects.

This function will wrap your script with <ROSETTASCRIPTS> if needed and will add a <PROTOCOLS> section if needed. The ParsedProtocol (xml script mover) is available as "ParsedProtocol". The pose parameter is ignored, and provided only for backwards compatibility.

This function will wrap your script with <ROSETTASCRIPTS> if needed and will add a <PROTOCOLS> section if needed. The ParsedProtocol (xml script mover) is available as "ParsedProtocol". The pose parameter is ignored, and exists only for backwards compatibility.

◆ create_from_string() [3/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_string	(	std::string const &	xml_text,
		core::pose::Pose &	,
		utility::options::OptionCollection const &	options
	)

static

Parses an xml-formatted string and returns an XmlObjects.

This function will wrap your script with <ROSETTASCRIPTS> if needed and will add a <PROTOCOLS> section if needed. The ParsedProtocol (xml script mover) is available as "ParsedProtocol". The pose parameter is ignored, and exists only for backwards compatibility.

◆ create_from_string() [4/4]

XmlObjectsCOP protocols::rosetta_scripts::XmlObjects::create_from_string	(	std::string const &	xml_text,
		utility::options::OptionCollection const &	options
	)

static

Parses an xml-formatted string and returns an XmlObjects.

This function will wrap your script with <ROSETTASCRIPTS> if needed and will add a <PROTOCOLS> section if needed. The ParsedProtocol (xml script mover) is available as "ParsedProtocol".

References protocols::rosetta_scripts::RosettaScriptsParser::generate_mover_xml_string(), and protocols::rosetta_scripts::TR().

◆ get_filter()

filters::FilterOP protocols::rosetta_scripts::XmlObjects::get_filter ( std::string const & name ) const

Extract a Filter by name after using one of the create* methods.

This returns a clone and cannot be used to modify the ParsedProtocol

◆ get_mover()

moves::MoverOP protocols::rosetta_scripts::XmlObjects::get_mover ( std::string const & name ) const

Extract a Mover by name after using one of the create* methods.

This returns a clone and cannot be used to modify the ParsedProtocol

◆ get_or_set_tag_name()

std::string protocols::rosetta_scripts::XmlObjects::get_or_set_tag_name ( std::string & tag_string )

staticprivate

Gets a tag's name field or sets it to XmlObject_name.

◆ get_residue_selector()

select::residue_selector::ResidueSelectorOP protocols::rosetta_scripts::XmlObjects::get_residue_selector ( std::string const & name ) const

Extract a ResidueSelector by name after using one of the create* methods.

This returns a clone and cannot be used to modify the ParsedProtocol

◆ get_score_function()

scoring::ScoreFunctionOP protocols::rosetta_scripts::XmlObjects::get_score_function ( std::string const & name ) const

Extract a ScoreFunction by name after using one of the create* methods.

This returns a clone and cannot be used to modify the ParsedProtocol

◆ get_simple_metric()

core::simple_metrics::SimpleMetricOP protocols::rosetta_scripts::XmlObjects::get_simple_metric ( std::string const & name ) const

Extract a SimpleMetric by name after using one of the create* methods.

This returns a clone and cannot be used to modify the ParsedProtocol

◆ get_task_operation()

pack::task::operation::TaskOperationOP protocols::rosetta_scripts::XmlObjects::get_task_operation ( std::string const & name ) const

Extract a TaskOperation by name after using one of the create* methods.

This returns a clone and cannot be used to modify the ParsedProtocol

◆ init_from_maps()

void protocols::rosetta_scripts::XmlObjects::init_from_maps ( basic::datacache::DataMap & data )

Initialization function from the DataMaps.

References core::scoring::pair.

◆ list_filters()

utility::vector1< std::string > protocols::rosetta_scripts::XmlObjects::list_filters ( ) const

List all the Filters contained by name.

References core::scoring::pair.

◆ list_movers()

utility::vector1< std::string > protocols::rosetta_scripts::XmlObjects::list_movers ( ) const

List all the Movers contained by name.

References core::scoring::pair.

◆ list_residue_selectors()

utility::vector1< std::string > protocols::rosetta_scripts::XmlObjects::list_residue_selectors ( ) const

List all the ResidueSelectors contained by name.

References core::scoring::pair.

◆ list_score_functions()

utility::vector1< std::string > protocols::rosetta_scripts::XmlObjects::list_score_functions ( ) const

List all the ScoreFunctions contained by name.

References core::scoring::pair.

◆ list_simple_metrics()

utility::vector1< std::string > protocols::rosetta_scripts::XmlObjects::list_simple_metrics ( ) const

List all the SimpleMetrics contained by name.

References core::scoring::pair.

◆ list_task_operations()

utility::vector1< std::string > protocols::rosetta_scripts::XmlObjects::list_task_operations ( ) const

List all the TaskOperations by name.

References core::scoring::pair.

◆ operator=()

XmlObjects & protocols::rosetta_scripts::XmlObjects::operator= ( XmlObjects const & src )

default

◆ prepare_xml_text()

void protocols::rosetta_scripts::XmlObjects::prepare_xml_text ( std::string & xml_text )

staticprivate

Wraps an xml script with <ROSETTASCRIPTS> and adds a <PROTOCOLS> section if these don't exist already.

Wraps an xml script with <ROSETTASCRIPTS> and adds a <PROTOCOLS> section if these don't exist already. This function will fail if someone has a mover named ROSETTASCRIPTS or PROTOCOLS or has those words in a comment. These string.find methods aren't the best solution here, but without regular expressions (to catch things like < ROSETTASCRIPTS >), correctly determing whether or not to intervene is complicated. -bcov.

◆ show()

void protocols::rosetta_scripts::XmlObjects::show ( std::ostream & output = std::cout ) const

Generate string representation of XmlObjects for debugging purposes.

References core::scoring::pair.

◆ static_get_filter() [1/4]

protocols::filters::FilterOP protocols::rosetta_scripts::XmlObjects::static_get_filter ( std::string const & xml_text )

static

Constructs a single Filter from xml.

Pass this function a single Filter tag and it will return to you that Filter. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

◆ static_get_filter() [2/4]

protocols::filters::FilterOP protocols::rosetta_scripts::XmlObjects::static_get_filter	(	std::string const &	xml_text,
		core::pose::Pose &
	)

static

Constructs a single Filter from xml.

Pass this function a single Filter tag and it will return to you that Filter. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_filter() [3/4]

protocols::filters::FilterOP protocols::rosetta_scripts::XmlObjects::static_get_filter	(	std::string const &	xml_text,
		core::pose::Pose &	pose,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single Filter from xml.

Pass this function a single Filter tag and it will return to you that Filter. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_filter() [4/4]

protocols::filters::FilterOP protocols::rosetta_scripts::XmlObjects::static_get_filter	(	std::string const &	xml_text_in,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single Filter from xml.

Pass this function a single Filter tag and it will return to you that Filter. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

References protocols::rosetta_scripts::TR().

◆ static_get_mover() [1/4]

protocols::moves::MoverOP protocols::rosetta_scripts::XmlObjects::static_get_mover ( std::string const & xml_text )

static

Constructs a single Mover from xml.

Pass this function a single Mover tag and it will return to you that Mover. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

◆ static_get_mover() [2/4]

protocols::moves::MoverOP protocols::rosetta_scripts::XmlObjects::static_get_mover	(	std::string const &	xml_text,
		core::pose::Pose &
	)

static

Constructs a single Mover from xml.

Pass this function a single Mover tag and it will return to you that Mover. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_mover() [3/4]

protocols::moves::MoverOP protocols::rosetta_scripts::XmlObjects::static_get_mover	(	std::string const &	xml_text,
		core::pose::Pose &	,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single Mover from xml.

Pass this function a single Mover tag and it will return to you that Mover. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_mover() [4/4]

protocols::moves::MoverOP protocols::rosetta_scripts::XmlObjects::static_get_mover	(	std::string const &	xml_text_in,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single Mover from xml.

Pass this function a single Mover tag and it will return to you that Mover. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

References protocols::rosetta_scripts::TR().

◆ static_get_residue_selector() [1/4]

core::select::residue_selector::ResidueSelectorOP protocols::rosetta_scripts::XmlObjects::static_get_residue_selector ( std::string const & xml_text )

static

Constructs a single ResidueSelector from xml.

Pass this function a single ResidueSelector tag and it will return to you that ResidueSelector. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

◆ static_get_residue_selector() [2/4]

core::select::residue_selector::ResidueSelectorOP protocols::rosetta_scripts::XmlObjects::static_get_residue_selector	(	std::string const &	xml_text,
		core::pose::Pose &
	)

static

Constructs a single ResidueSelector from xml.

Pass this function a single ResidueSelector tag and it will return to you that ResidueSelector. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_residue_selector() [3/4]

core::select::residue_selector::ResidueSelectorOP protocols::rosetta_scripts::XmlObjects::static_get_residue_selector	(	std::string const &	xml_text,
		core::pose::Pose &	,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single ResidueSelector from xml.

Pass this function a single ResidueSelector tag and it will return to you that ResidueSelector. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_residue_selector() [4/4]

core::select::residue_selector::ResidueSelectorOP protocols::rosetta_scripts::XmlObjects::static_get_residue_selector	(	std::string const &	xml_text_in,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single ResidueSelector from xml.

Pass this function a single ResidueSelector tag and it will return to you that ResidueSelector. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

References protocols::rosetta_scripts::TR().

◆ static_get_score_function() [1/4]

core::scoring::ScoreFunctionOP protocols::rosetta_scripts::XmlObjects::static_get_score_function ( std::string const & xml_text )

static

Constructs a single ScoreFunction from xml.

Pass this function a single <ScoreFunction > tag and it will return to you that ScoreFunction

◆ static_get_score_function() [2/4]

core::scoring::ScoreFunctionOP protocols::rosetta_scripts::XmlObjects::static_get_score_function	(	std::string const &	xml_text,
		core::pose::Pose &
	)

static

Constructs a single ScoreFunction from xml.

Pass this function a single <ScoreFunction > tag and it will return to you that ScoreFunction The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_score_function() [3/4]

core::scoring::ScoreFunctionOP protocols::rosetta_scripts::XmlObjects::static_get_score_function	(	std::string const &	xml_text,
		core::pose::Pose &	,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single ScoreFunction from xml.

Pass this function a single <ScoreFunction > tag and it will return to you that ScoreFunction The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_score_function() [4/4]

core::scoring::ScoreFunctionOP protocols::rosetta_scripts::XmlObjects::static_get_score_function	(	std::string const &	xml_text_in,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single ScoreFunction from xml.

Pass this function a single <ScoreFunction > tag and it will return to you that ScoreFunction

References protocols::rosetta_scripts::TR().

◆ static_get_simple_metric() [1/4]

core::simple_metrics::SimpleMetricOP protocols::rosetta_scripts::XmlObjects::static_get_simple_metric ( std::string const & xml_text )

static

Constructs a single SimpleMetric from xml.

Pass this function a single SimpleMetric tag and it will return to you that SimpleMetric. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

◆ static_get_simple_metric() [2/4]

core::simple_metrics::SimpleMetricOP protocols::rosetta_scripts::XmlObjects::static_get_simple_metric	(	std::string const &	xml_text,
		core::pose::Pose &
	)

static

Constructs a single SimpleMetric from xml.

Pass this function a single SimpleMetric tag and it will return to you that SimpleMetric. For C++ users, you may need The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_simple_metric() [3/4]

core::simple_metrics::SimpleMetricOP protocols::rosetta_scripts::XmlObjects::static_get_simple_metric	(	std::string const &	xml_text,
		core::pose::Pose &	,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single SimpleMetric from xml.

Pass this function a single SimpleMetric tag and it will return to you that SimpleMetric. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_simple_metric() [4/4]

core::simple_metrics::SimpleMetricOP protocols::rosetta_scripts::XmlObjects::static_get_simple_metric	(	std::string const &	xml_text,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single SimpleMetric from xml.

Pass this function a single SimpleMetric tag and it will return to you that SimpleMetric. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

References protocols::rosetta_scripts::TR().

◆ static_get_task_operation() [1/4]

core::pack::task::operation::TaskOperationOP protocols::rosetta_scripts::XmlObjects::static_get_task_operation ( std::string const & xml_text )

static

Constructs a single TaskOperation from xml.

Pass this function a single TaskOperation tag and it will return to you that TaskOperation. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

◆ static_get_task_operation() [2/4]

core::pack::task::operation::TaskOperationOP protocols::rosetta_scripts::XmlObjects::static_get_task_operation	(	std::string const &	xml_text,
		core::pose::Pose &
	)

static

Constructs a single TaskOperation from xml.

Pass this function a single TaskOperation tag and it will return to you that TaskOperation. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_task_operation() [3/4]

core::pack::task::operation::TaskOperationOP protocols::rosetta_scripts::XmlObjects::static_get_task_operation	(	std::string const &	xml_text,
		core::pose::Pose &	,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single TaskOperation from xml.

Pass this function a single TaskOperation tag and it will return to you that TaskOperation. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call. The pose parameter is ignored, and exists only for backwards compatibility.

◆ static_get_task_operation() [4/4]

core::pack::task::operation::TaskOperationOP protocols::rosetta_scripts::XmlObjects::static_get_task_operation	(	std::string const &	xml_text_in,
		utility::options::OptionCollection const &	options
	)

static

Constructs a single TaskOperation from xml.

Pass this function a single TaskOperation tag and it will return to you that TaskOperation. For C++ users, you may need to use std::dynamic_pointer_cast< > after this call.

References protocols::rosetta_scripts::TR().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	output,
		XmlObjects const &	object_to_output
	)

friend

Insertion operator (overloaded so that XmlObjects can be "printed" in PyRosetta).

Member Data Documentation

◆ filters_

std::map< std::string, protocols::filters::FilterCOP > protocols::rosetta_scripts::XmlObjects::filters_

private

◆ movers_

std::map< std::string, protocols::moves::MoverCOP > protocols::rosetta_scripts::XmlObjects::movers_

private

◆ residue_selectors_

std::map< std::string, core::select::residue_selector::ResidueSelectorCOP > protocols::rosetta_scripts::XmlObjects::residue_selectors_

private

◆ score_functions_

std::map< std::string, core::scoring::ScoreFunctionCOP > protocols::rosetta_scripts::XmlObjects::score_functions_

private

◆ simple_metrics_

std::map< std::string, core::simple_metrics::SimpleMetricCOP > protocols::rosetta_scripts::XmlObjects::simple_metrics_

private

◆ task_operations_

std::map< std::string, core::pack::task::operation::TaskOperationCOP > protocols::rosetta_scripts::XmlObjects::task_operations_

private

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

src/protocols/rosetta_scripts/XmlObjects.hh
src/protocols/rosetta_scripts/XmlObjects.cc

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ XmlObjects() [1/2]

◆ ~XmlObjects()

◆ XmlObjects() [2/2]

Member Function Documentation

◆ create_from_file() [1/4]

◆ create_from_file() [2/4]

◆ create_from_file() [3/4]

◆ create_from_file() [4/4]

◆ create_from_string() [1/4]

◆ create_from_string() [2/4]

◆ create_from_string() [3/4]

◆ create_from_string() [4/4]

◆ get_filter()

◆ get_mover()

◆ get_or_set_tag_name()

◆ get_residue_selector()

◆ get_score_function()

◆ get_simple_metric()

◆ get_task_operation()

◆ init_from_maps()

◆ list_filters()

◆ list_movers()

◆ list_residue_selectors()

◆ list_score_functions()

◆ list_simple_metrics()

◆ list_task_operations()

◆ operator=()

◆ prepare_xml_text()

◆ show()

◆ static_get_filter() [1/4]

◆ static_get_filter() [2/4]

◆ static_get_filter() [3/4]

◆ static_get_filter() [4/4]

◆ static_get_mover() [1/4]

◆ static_get_mover() [2/4]

◆ static_get_mover() [3/4]

◆ static_get_mover() [4/4]

◆ static_get_residue_selector() [1/4]

◆ static_get_residue_selector() [2/4]

◆ static_get_residue_selector() [3/4]

◆ static_get_residue_selector() [4/4]

◆ static_get_score_function() [1/4]

◆ static_get_score_function() [2/4]

◆ static_get_score_function() [3/4]

◆ static_get_score_function() [4/4]

◆ static_get_simple_metric() [1/4]

◆ static_get_simple_metric() [2/4]

◆ static_get_simple_metric() [3/4]

◆ static_get_simple_metric() [4/4]

◆ static_get_task_operation() [1/4]

◆ static_get_task_operation() [2/4]

◆ static_get_task_operation() [3/4]

◆ static_get_task_operation() [4/4]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ filters_

◆ movers_

◆ residue_selectors_

◆ score_functions_

◆ simple_metrics_

◆ task_operations_