protocols::multistage_rosetta_scripts::MRSJob Class Reference

#include <MRSJob.hh>

Inheritance diagram for protocols::multistage_rosetta_scripts::MRSJob:

Public Member Functions
	MRSJob (core::Size max_num_results=1)
	~MRSJob () override
void	set_pose (core::pose::PoseOP pose)
core::pose::PoseCOP	pose () const
jd3::CompletedJobOutput	run () override
	This is the main function of the Job object. It will be invoked by the JobDistributor. The Job will return a JobResult at the conclusion of its execution, and the JobResult will be serialized and sent to the appropriate JobQueen for processing and output. The Job itself will be discarded. Large constant data that might be shared between multiple jobs can be held by the Job object (or by classes that the Job object holds) but that data should not be put into the JobResult – large data should not be repeatedly serialized and shipped between nodes. More...
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, std::map< std::string, utility::tag::TagCOP > const &mover_tags_by_name, std::map< std::string, utility::tag::TagCOP > const &filter_tags_by_name)
void	parse_my_tag (utility::tag::TagCOP tag, ParsedTagCacheOP cache)
core::Real	metric_for_evaluation (core::pose::PoseOP pose) const
	returns metric generated by the final filter of the protocol More...
void	set_max_num_results (core::Size setting)
	the final mover of the protocol is allowed to return additional output poses. This value places a cap on the number of poses that can be output by that mover More...
core::Size	max_num_results () const
std::list< mover_or_filter > &	protocols ()
	this getter is only really intended to be used for unit tests More...
void	set_cluster_metric_tag (utility::tag::TagCOP tag_for_cluster_metric)
Public Member Functions inherited from protocols::jd3::Job
	Job ()
	~Job () override

Protected Member Functions
cluster::ClusterMetricOP	get_cluster_metric (core::pose::Pose const &pose)

Private Member Functions
jd3::CompletedJobOutput	run_inner ()

Private Attributes
core::pose::PoseOP	pose_
std::list< mover_or_filter >	protocols_
core::Size	max_num_results_
bool	positive_scores_are_better_
utility::tag::TagCOP	tag_for_cluster_metric_
ParsedTagCacheOP	data_

Constructor & Destructor Documentation

MRSJob()

protocols::multistage_rosetta_scripts::MRSJob::MRSJob

(

core::Size

max_num_results = 1

)

~MRSJob()

protocols::multistage_rosetta_scripts::MRSJob::~MRSJob ( )

override

Member Function Documentation

get_cluster_metric()

cluster::ClusterMetricOP protocols::multistage_rosetta_scripts::MRSJob::get_cluster_metric ( core::pose::Pose const &  pose )

protected

References data_, pose(), and tag_for_cluster_metric_.

Referenced by run_inner().

max_num_results()

core::Size protocols::multistage_rosetta_scripts::MRSJob::max_num_results ( ) const

inline

References max_num_results_.

metric_for_evaluation()

core::Real protocols::multistage_rosetta_scripts::MRSJob::metric_for_evaluation

(

core::pose::PoseOP

pose

)

const

returns metric generated by the final filter of the protocol

References pose(), and protocols_.

parse_my_tag() [1/2]

void protocols::multistage_rosetta_scripts::MRSJob::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	map,
		std::map< std::string, utility::tag::TagCOP > const &	mover_tags_by_name,
		std::map< std::string, utility::tag::TagCOP > const &	filter_tags_by_name
	)

References protocols::filters::FilterFactory::newFilter(), positive_scores_are_better_, protocols_, and protocols::TR().

Referenced by parse_my_tag().

parse_my_tag() [2/2]

void protocols::multistage_rosetta_scripts::MRSJob::parse_my_tag ( utility::tag::TagCOP  tag, ParsedTagCacheOP  cache  )

inline

References data_, and parse_my_tag().

pose()

core::pose::PoseCOP protocols::multistage_rosetta_scripts::MRSJob::pose ( ) const

inline

References pose_.

Referenced by get_cluster_metric(), metric_for_evaluation(), and set_pose().

protocols()

std::list< mover_or_filter >& protocols::multistage_rosetta_scripts::MRSJob::protocols ( )

inline

this getter is only really intended to be used for unit tests

References protocols_.

run()

jd3::CompletedJobOutput protocols::multistage_rosetta_scripts::MRSJob::run ( )

overridevirtual

This is the main function of the Job object. It will be invoked by the JobDistributor. The Job will return a JobResult at the conclusion of its execution, and the JobResult will be serialized and sent to the appropriate JobQueen for processing and output. The Job itself will be discarded. Large constant data that might be shared between multiple jobs can be held by the Job object (or by classes that the Job object holds) but that data should not be put into the JobResult – large data should not be repeatedly serialized and shipped between nodes.

Implements protocols::jd3::Job.

References protocols::jd3::jd3_job_status_failed_do_not_retry, protocols::jd3::jd3_job_status_success, protocols::jd3::CompletedJobOutput::job_results, pose_, run_inner(), and protocols::jd3::CompletedJobOutput::status.

run_inner()

jd3::CompletedJobOutput protocols::multistage_rosetta_scripts::MRSJob::run_inner ( )

private

References protocols::moves::FAIL_DO_NOT_RETRY, protocols::multistage_rosetta_scripts::mover_or_filter::filter, get_cluster_metric(), protocols::multistage_rosetta_scripts::mover_or_filter::is_mover, protocols::jd3::jd3_job_status_failed_do_not_retry, protocols::jd3::jd3_job_status_success, protocols::jd3::CompletedJobOutput::job_results, max_num_results_, protocols::multistage_rosetta_scripts::mover_or_filter::mover, pose_, positive_scores_are_better_, protocols_, protocols::hybridization::score, protocols::jd3::CompletedJobOutput::status, and tag_for_cluster_metric_.

Referenced by run().

set_cluster_metric_tag()

void protocols::multistage_rosetta_scripts::MRSJob::set_cluster_metric_tag ( utility::tag::TagCOP  tag_for_cluster_metric )

inline

References tag_for_cluster_metric_.

set_max_num_results()

void protocols::multistage_rosetta_scripts::MRSJob::set_max_num_results ( core::Size  setting )

inline

the final mover of the protocol is allowed to return additional output poses. This value places a cap on the number of poses that can be output by that mover

References max_num_results_.

set_pose()

void protocols::multistage_rosetta_scripts::MRSJob::set_pose ( core::pose::PoseOP  pose )

inline

References pose(), and pose_.

Member Data Documentation

data_

ParsedTagCacheOP protocols::multistage_rosetta_scripts::MRSJob::data_

private

Referenced by get_cluster_metric(), and parse_my_tag().

max_num_results_

core::Size protocols::multistage_rosetta_scripts::MRSJob::max_num_results_

private

Referenced by max_num_results(), run_inner(), and set_max_num_results().

pose_

core::pose::PoseOP protocols::multistage_rosetta_scripts::MRSJob::pose_

private

Referenced by pose(), run(), run_inner(), and set_pose().

positive_scores_are_better_

bool protocols::multistage_rosetta_scripts::MRSJob::positive_scores_are_better_

private

Referenced by parse_my_tag(), and run_inner().

protocols_

std::list< mover_or_filter > protocols::multistage_rosetta_scripts::MRSJob::protocols_

private

Referenced by metric_for_evaluation(), parse_my_tag(), protocols(), and run_inner().

tag_for_cluster_metric_

utility::tag::TagCOP protocols::multistage_rosetta_scripts::MRSJob::tag_for_cluster_metric_

private

Referenced by get_cluster_metric(), run_inner(), and set_cluster_metric_tag().

---

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

• src/protocols/multistage_rosetta_scripts/MRSJob.hh
• src/protocols/multistage_rosetta_scripts/MRSJob.cc